From 368a5f56039fdecf5637bd5f90752fae21c27aaa Mon Sep 17 00:00:00 2001 From: Simon Schulte Date: Thu, 16 Jan 2025 10:10:51 +0100 Subject: [PATCH] update 7.0.0 --- README.md | 1065 +++++++++-------- docs/Account.md | 1 - docs/AccountAdditionalCost.md | 1 - docs/Achievement.md | 5 +- docs/AchievementProgress.md | 1 + docs/AdditionalCampaignProperties.md | 2 +- docs/AnalyticsProduct.md | 13 + docs/AnalyticsProductSKU.md | 12 + docs/Application.md | 2 +- docs/ApplicationAPIKey.md | 1 - docs/ApplicationCIF.md | 18 + docs/ApplicationCIFExpression.md | 15 + docs/ApplicationCampaignStats.md | 1 + docs/ApplicationCustomer.md | 9 +- docs/ApplicationEvent.md | 1 - docs/ApplicationReferee.md | 1 - docs/ApplicationSession.md | 3 +- docs/AsyncCouponDeletionJobResponse.md | 1 - docs/Attribute.md | 1 - docs/Audience.md | 1 - docs/AudienceCustomer.md | 3 +- docs/BaseLoyaltyProgram.md | 1 + docs/BaseNotification.md | 1 - docs/BaseNotificationWebhook.md | 1 - docs/BulkOperationOnCampaigns.md | 1 + docs/Campaign.md | 10 +- docs/CampaignAnalytics.md | 1 - docs/CampaignCollection.md | 1 - docs/CampaignCollectionWithoutPayload.md | 1 - docs/CampaignEvaluationGroup.md | 1 - docs/CampaignGroup.md | 1 - docs/CampaignSet.md | 1 - docs/CampaignStoreBudget.md | 14 + docs/CampaignTemplate.md | 2 +- ...mpaignTemplateCouponReservationSettings.md | 11 + docs/CampaignVersions.md | 16 + docs/Catalog.md | 1 - docs/CatalogItem.md | 1 - docs/Change.md | 1 - docs/Collection.md | 1 - docs/CollectionItem.md | 1 - docs/CollectionWithoutPayload.md | 1 - docs/Coupon.md | 1 - docs/CouponCreationJob.md | 1 - docs/CouponDeletionFilters.md | 2 +- docs/CouponDeletionJob.md | 1 - docs/CreateAchievement.md | 4 + docs/CustomEffect.md | 1 - docs/CustomerProfile.md | 3 +- docs/CustomerProfileAudienceRequestItem.md | 2 +- docs/CustomerProfileIntegrationRequestV2.md | 2 +- docs/CustomerSession.md | 1 - docs/CustomerSessionV2.md | 13 +- docs/DeactivateUserRequest.md | 1 - docs/Effect.md | 4 +- docs/EffectEntity.md | 2 + docs/Environment.md | 2 +- docs/Event.md | 1 - docs/EventType.md | 1 - docs/EventV2.md | 1 - docs/Export.md | 1 - docs/FeaturesFeed.md | 1 - docs/GenerateCampaignDescription.md | 2 +- docs/GenerateCampaignTags.md | 2 +- docs/GenerateLoyaltyCard.md | 1 + docs/Giveaway.md | 1 - docs/InlineResponse20020.md | 2 +- docs/InlineResponse20021.md | 5 +- docs/InlineResponse20022.md | 2 +- docs/InlineResponse20023.md | 2 +- docs/InlineResponse20024.md | 3 +- docs/InlineResponse20025.md | 2 +- docs/InlineResponse20026.md | 4 +- docs/InlineResponse20027.md | 4 +- docs/InlineResponse20028.md | 4 +- docs/InlineResponse20029.md | 5 +- docs/InlineResponse20030.md | 3 +- docs/InlineResponse20031.md | 2 +- docs/InlineResponse20032.md | 3 +- docs/InlineResponse20033.md | 5 +- docs/InlineResponse20034.md | 5 +- docs/InlineResponse20035.md | 5 +- docs/InlineResponse20036.md | 2 +- docs/InlineResponse20037.md | 2 +- docs/InlineResponse20038.md | 2 +- docs/InlineResponse20039.md | 2 +- docs/InlineResponse20040.md | 2 +- docs/InlineResponse20041.md | 5 +- docs/InlineResponse20042.md | 5 +- docs/InlineResponse20043.md | 2 +- docs/InlineResponse20044.md | 5 +- docs/InlineResponse20045.md | 3 +- docs/InlineResponse20046.md | 4 +- docs/IntegrationApi.md | 20 +- docs/IntegrationCoupon.md | 1 - docs/IntegrationCustomerSessionResponse.md | 2 +- docs/IntegrationEvent.md | 1 - docs/IntegrationEventV2Request.md | 1 - docs/InventoryCoupon.md | 1 - docs/InventoryReferral.md | 1 - docs/ItemAttribute.md | 1 - docs/LedgerEntry.md | 2 +- docs/LedgerInfo.md | 6 +- docs/LibraryAttribute.md | 1 - docs/LimitCounter.md | 1 - docs/ListCampaignStoreBudgets.md | 13 + docs/ListCampaignStoreBudgetsStore.md | 12 + docs/LoginParams.md | 1 - docs/LoyaltyBalanceWithTier.md | 2 +- docs/LoyaltyCard.md | 4 +- docs/LoyaltyCardBalances.md | 2 +- docs/LoyaltyCardBatch.md | 13 + docs/LoyaltyCardBatchResponse.md | 11 + docs/LoyaltyProgram.md | 6 +- docs/LoyaltyProgramBalance.md | 4 +- docs/LoyaltyProgramEntity.md | 2 + docs/LoyaltyTier.md | 8 +- docs/ManagementApi.md | 823 +++++++------ docs/ManagementKey.md | 1 - docs/MessageLogEntry.md | 6 +- docs/ModelImport.md | 1 - docs/ModelReturn.md | 1 - docs/MultipleAudiencesItem.md | 1 - ...leCustomerProfileIntegrationRequestItem.md | 2 +- docs/NewAccountSignUp.md | 1 - docs/NewAdditionalCost.md | 1 - docs/NewApplicationAPIKey.md | 1 - docs/NewApplicationCIF.md | 15 + docs/NewApplicationCIFExpression.md | 12 + docs/NewAttribute.md | 1 - docs/NewAudience.md | 1 - docs/NewBaseNotification.md | 1 - docs/NewCampaign.md | 1 - docs/NewCampaignCollection.md | 1 - docs/NewCampaignSet.md | 1 - docs/NewCampaignStoreBudget.md | 12 + docs/NewCampaignStoreBudgetStoreLimit.md | 11 + docs/NewCampaignTemplate.md | 1 + docs/NewCatalog.md | 1 - docs/NewCollection.md | 1 - docs/NewCouponCreationJob.md | 1 - docs/NewCoupons.md | 1 - docs/NewCouponsForMultipleRecipients.md | 1 - docs/NewCustomEffect.md | 1 - docs/NewCustomerSession.md | 1 - docs/NewCustomerSessionV2.md | 6 +- docs/NewEvent.md | 1 - docs/NewEventType.md | 1 - docs/NewLoyaltyProgram.md | 3 +- docs/NewLoyaltyTier.md | 4 +- docs/NewManagementKey.md | 1 - docs/NewMultipleAudiencesItem.md | 1 - docs/NewReferral.md | 1 - docs/NewReferralsForMultipleAdvocates.md | 1 - docs/NewRevisionVersion.md | 20 + docs/NewRole.md | 1 - docs/NewRoleV2.md | 1 - docs/NewSamlConnection.md | 2 +- docs/NewStore.md | 1 - docs/NewUser.md | 1 - docs/NewWebhook.md | 3 +- ...grationTemplateWithConfigurationDetails.md | 1 - docs/Picklist.md | 1 - docs/Product.md | 2 +- docs/ProductSearchMatch.md | 12 + docs/ProductSkuUnitAnalytics.md | 13 + docs/ProductUnitAnalytics.md | 14 + docs/Referral.md | 1 - docs/Revision.md | 19 + docs/RevisionActivation.md | 10 + docs/RevisionVersion.md | 28 + docs/Role.md | 1 - docs/RoleAssign.md | 1 - docs/RoleV2.md | 1 - docs/Ruleset.md | 1 - docs/SamlConnection.md | 2 +- docs/ScimBaseUser.md | 14 + docs/ScimBaseUserName.md | 11 + docs/ScimNewUser.md | 1 + docs/ScimPatchOperation.md | 13 + docs/ScimPatchRequest.md | 12 + docs/ScimResource.md | 3 +- docs/ScimSchemaResource.md | 14 + docs/ScimSchemasListResponse.md | 13 + docs/ScimServiceProviderConfigResponse.md | 17 + docs/ScimServiceProviderConfigResponseBulk.md | 13 + ...iceProviderConfigResponseChangePassword.md | 11 + ...ScimServiceProviderConfigResponseFilter.md | 12 + .../ScimServiceProviderConfigResponsePatch.md | 11 + docs/ScimServiceProviderConfigResponseSort.md | 11 + docs/ScimUser.md | 1 + docs/ScimUsersListResponse.md | 2 +- docs/Store.md | 3 +- docs/StrikethroughDebugResponse.md | 11 + docs/SummaryCampaignStoreBudget.md | 12 + docs/TalangAttribute.md | 1 - docs/TemplateArgDef.md | 2 +- docs/TemplateDef.md | 1 - docs/TemplateLimitConfig.md | 1 - docs/UpdateAchievement.md | 4 + docs/UpdateApplication.md | 1 + docs/UpdateApplicationCIF.md | 13 + docs/UpdateCampaign.md | 2 +- docs/UpdateCampaignEvaluationGroup.md | 1 - docs/UpdateCampaignGroup.md | 1 - docs/UpdateCampaignTemplate.md | 1 + docs/UpdateCoupon.md | 1 - docs/UpdateCouponBatch.md | 1 - docs/UpdateLoyaltyProgram.md | 3 +- docs/UpdateLoyaltyProgramTier.md | 13 + docs/UpdatePicklist.md | 1 - docs/User.md | 1 - docs/ValueMap.md | 13 + docs/Webhook.md | 3 +- docs/WebhookLogEntry.md | 2 +- docs/WebhookWithOutgoingIntegrationDetails.md | 3 +- setup.py | 2 +- talon_one/__init__.py | 46 +- talon_one/api/integration_api.py | 30 +- talon_one/api/management_api.py | 816 +++++++------ talon_one/api_client.py | 2 +- talon_one/configuration.py | 2 +- talon_one/models/__init__.py | 44 +- talon_one/models/achievement.py | 126 +- talon_one/models/achievement_progress.py | 31 +- .../models/add_loyalty_points_effect_props.py | 3 + .../models/additional_campaign_properties.py | 6 +- talon_one/models/analytics_product.py | 209 ++++ talon_one/models/analytics_product_sku.py | 181 +++ talon_one/models/application.py | 30 +- .../models/application_campaign_analytics.py | 2 +- .../models/application_campaign_stats.py | 31 +- talon_one/models/application_cif.py | 350 ++++++ .../models/application_cif_expression.py | 265 ++++ talon_one/models/application_customer.py | 16 +- talon_one/models/application_session.py | 4 +- talon_one/models/audience_customer.py | 4 +- talon_one/models/base_loyalty_program.py | 40 +- .../models/bulk_operation_on_campaigns.py | 36 +- talon_one/models/campaign.py | 214 +++- talon_one/models/campaign_store_budget.py | 239 ++++ talon_one/models/campaign_template.py | 28 +- ...gn_template_coupon_reservation_settings.py | 156 +++ talon_one/models/campaign_versions.py | 296 +++++ .../card_ledger_transaction_log_entry.py | 3 + ...r_transaction_log_entry_integration_api.py | 3 + talon_one/models/code_generator_settings.py | 3 + talon_one/models/coupon_deletion_filters.py | 2 +- talon_one/models/create_achievement.py | 130 +- talon_one/models/customer_profile.py | 4 +- .../customer_profile_audience_request_item.py | 4 +- talon_one/models/customer_session_v2.py | 54 +- .../deduct_loyalty_points_effect_props.py | 3 + talon_one/models/effect.py | 58 +- talon_one/models/effect_entity.py | 62 +- talon_one/models/environment.py | 34 +- .../models/generate_campaign_description.py | 36 +- talon_one/models/generate_campaign_tags.py | 36 +- talon_one/models/generate_loyalty_card.py | 40 +- talon_one/models/inline_response20020.py | 6 +- talon_one/models/inline_response20021.py | 39 +- talon_one/models/inline_response20022.py | 54 +- talon_one/models/inline_response20023.py | 6 +- talon_one/models/inline_response20024.py | 33 +- talon_one/models/inline_response20025.py | 6 +- talon_one/models/inline_response20026.py | 11 +- talon_one/models/inline_response20027.py | 11 +- talon_one/models/inline_response20028.py | 42 +- talon_one/models/inline_response20029.py | 39 +- talon_one/models/inline_response20030.py | 34 +- talon_one/models/inline_response20031.py | 6 +- talon_one/models/inline_response20032.py | 34 +- talon_one/models/inline_response20033.py | 39 +- talon_one/models/inline_response20034.py | 39 +- talon_one/models/inline_response20035.py | 39 +- talon_one/models/inline_response20036.py | 6 +- talon_one/models/inline_response20037.py | 6 +- talon_one/models/inline_response20038.py | 6 +- talon_one/models/inline_response20039.py | 6 +- talon_one/models/inline_response20040.py | 6 +- talon_one/models/inline_response20041.py | 39 +- talon_one/models/inline_response20042.py | 39 +- talon_one/models/inline_response20043.py | 6 +- talon_one/models/inline_response20044.py | 39 +- talon_one/models/inline_response20045.py | 34 +- talon_one/models/inline_response20046.py | 11 +- .../integration_customer_session_response.py | 2 + talon_one/models/ledger_info.py | 8 +- talon_one/models/limit_config.py | 2 +- .../models/list_campaign_store_budgets.py | 201 ++++ .../list_campaign_store_budgets_store.py | 175 +++ talon_one/models/loyalty_card.py | 99 +- talon_one/models/loyalty_card_batch.py | 220 ++++ .../models/loyalty_card_batch_response.py | 152 +++ talon_one/models/loyalty_program.py | 72 +- talon_one/models/loyalty_program_balance.py | 8 +- talon_one/models/loyalty_program_entity.py | 62 +- .../models/loyalty_program_transaction.py | 3 + talon_one/models/loyalty_tier.py | 66 +- talon_one/models/message_log_entry.py | 132 +- talon_one/models/new_application_cif.py | 263 ++++ .../models/new_application_cif_expression.py | 178 +++ talon_one/models/new_campaign_store_budget.py | 188 +++ .../new_campaign_store_budget_store_limit.py | 152 +++ talon_one/models/new_campaign_template.py | 28 +- talon_one/models/new_customer_session_v2.py | 12 +- talon_one/models/new_loyalty_program.py | 36 +- talon_one/models/new_loyalty_tier.py | 8 +- talon_one/models/new_revision_version.py | 405 +++++++ talon_one/models/new_webhook.py | 4 +- talon_one/models/product.py | 4 +- talon_one/models/product_search_match.py | 180 +++ .../models/product_sku_unit_analytics.py | 208 ++++ talon_one/models/product_unit_analytics.py | 237 ++++ talon_one/models/revision.py | 362 ++++++ talon_one/models/revision_activation.py | 120 ++ talon_one/models/revision_version.py | 623 ++++++++++ ...lback_added_loyalty_points_effect_props.py | 3 + ...ck_deducted_loyalty_points_effect_props.py | 3 + talon_one/models/scim_base_user.py | 204 ++++ talon_one/models/scim_base_user_name.py | 122 ++ talon_one/models/scim_new_user.py | 32 +- talon_one/models/scim_patch_operation.py | 185 +++ talon_one/models/scim_patch_request.py | 149 +++ talon_one/models/scim_resource.py | 34 +- talon_one/models/scim_schema_resource.py | 204 ++++ .../models/scim_schemas_list_response.py | 177 +++ .../scim_service_provider_config_response.py | 280 +++++ ...m_service_provider_config_response_bulk.py | 178 +++ ...rovider_config_response_change_password.py | 122 ++ ...service_provider_config_response_filter.py | 150 +++ ..._service_provider_config_response_patch.py | 122 ++ ...m_service_provider_config_response_sort.py | 122 ++ talon_one/models/scim_user.py | 28 +- talon_one/models/scim_users_list_response.py | 2 + talon_one/models/store.py | 4 +- .../models/strikethrough_debug_response.py | 150 +++ .../models/summary_campaign_store_budget.py | 186 +++ talon_one/models/template_arg_def.py | 30 +- talon_one/models/template_limit_config.py | 2 +- talon_one/models/transfer_loyalty_card.py | 3 + talon_one/models/update_achievement.py | 130 +- talon_one/models/update_application.py | 30 +- talon_one/models/update_application_cif.py | 206 ++++ talon_one/models/update_campaign.py | 4 +- talon_one/models/update_campaign_template.py | 28 +- talon_one/models/update_loyalty_program.py | 36 +- .../models/update_loyalty_program_tier.py | 185 +++ talon_one/models/value_map.py | 204 ++++ talon_one/models/webhook.py | 4 +- talon_one/models/webhook_log_entry.py | 4 +- ...bhook_with_outgoing_integration_details.py | 4 +- test/test_account_analytics.py | 4 +- test/test_achievement.py | 4 + test/test_achievement_progress.py | 2 + test/test_analytics_product.py | 58 + test/test_analytics_product_sku.py | 57 + test/test_application.py | 17 +- test/test_application_campaign_stats.py | 2 + test/test_application_cif.py | 64 + test/test_application_cif_expression.py | 60 + test/test_application_customer.py | 18 +- test/test_application_event.py | 4 + test/test_application_session.py | 4 +- test/test_audience_customer.py | 6 +- test/test_base_loyalty_program.py | 3 +- test/test_bulk_operation_on_campaigns.py | 3 +- test/test_campaign.py | 9 +- ...campaign_collection_edited_notification.py | 18 +- test/test_campaign_created_notification.py | 18 +- test/test_campaign_deleted_notification.py | 18 +- test/test_campaign_edited_notification.py | 36 +- ...t_campaign_ruleset_changed_notification.py | 18 +- ...est_campaign_state_changed_notification.py | 18 +- test/test_campaign_store_budget.py | 73 ++ test/test_campaign_template.py | 11 +- ...gn_template_coupon_reservation_settings.py | 53 + test/test_campaign_versions.py | 58 + test/test_change.py | 2 +- test/test_coupon_deletion_filters.py | 2 +- test/test_coupon_deletion_job.py | 4 +- test/test_create_achievement.py | 6 +- .../test_create_template_campaign_response.py | 18 +- test/test_custom_effect.py | 1 + test/test_customer_inventory.py | 10 +- test/test_customer_profile.py | 6 +- ...ustomer_profile_integration_response_v2.py | 22 +- ...est_customer_profile_update_v2_response.py | 8 +- test/test_customer_session.py | 4 +- test/test_customer_session_v2.py | 9 +- test/test_effect.py | 2 + test/test_effect_entity.py | 4 +- test/test_environment.py | 26 +- test/test_feature_flag.py | 2 +- test/test_generate_campaign_description.py | 4 +- test/test_generate_campaign_tags.py | 4 +- test/test_generate_loyalty_card.py | 3 +- test/test_inline_response200.py | 8 +- test/test_inline_response20012.py | 14 +- test/test_inline_response20013.py | 16 +- test/test_inline_response20015.py | 10 +- test/test_inline_response20020.py | 78 +- test/test_inline_response20021.py | 96 +- test/test_inline_response20022.py | 22 +- test/test_inline_response20023.py | 30 +- test/test_inline_response20024.py | 10 +- test/test_inline_response20025.py | 64 +- test/test_inline_response20026.py | 99 +- test/test_inline_response20027.py | 145 ++- test/test_inline_response20028.py | 88 +- test/test_inline_response20029.py | 26 +- test/test_inline_response20030.py | 29 +- test/test_inline_response20031.py | 46 +- test/test_inline_response20032.py | 55 +- test/test_inline_response20033.py | 56 +- test/test_inline_response20034.py | 60 +- test/test_inline_response20035.py | 42 +- test/test_inline_response20036.py | 50 +- test/test_inline_response20037.py | 52 +- test/test_inline_response20038.py | 40 +- test/test_inline_response20039.py | 40 +- test/test_inline_response20040.py | 40 +- test/test_inline_response20041.py | 48 +- test/test_inline_response20042.py | 22 +- test/test_inline_response20043.py | 30 +- test/test_inline_response20044.py | 46 +- test/test_inline_response20045.py | 51 +- test/test_inline_response20046.py | 43 +- test/test_inline_response2005.py | 18 +- test/test_inline_response2006.py | 18 +- test/test_integration_api.py | 2 +- ...t_integration_customer_session_response.py | 9 +- test/test_integration_request.py | 4 +- test/test_integration_state.py | 17 +- test/test_integration_state_v2.py | 29 +- test/test_list_campaign_store_budgets.py | 64 + .../test_list_campaign_store_budgets_store.py | 57 + test/test_loyalty.py | 5 +- test/test_loyalty_card.py | 5 +- test/test_loyalty_card_batch.py | 58 + test/test_loyalty_card_batch_response.py | 55 + test/test_loyalty_ledger.py | 2 +- test/test_loyalty_membership.py | 2 +- test/test_loyalty_program.py | 10 +- test/test_loyalty_program_entity.py | 4 +- test/test_loyalty_tier.py | 2 + test/test_management_api.py | 23 +- test/test_message_log_entries.py | 12 +- test/test_message_log_entry.py | 7 +- ...ustomer_profile_integration_response_v2.py | 4 +- test/test_new_app_wide_coupon_deletion_job.py | 4 +- test/test_new_application_cif.py | 58 + test/test_new_application_cif_expression.py | 54 + test/test_new_campaign_store_budget.py | 64 + ...t_new_campaign_store_budget_store_limit.py | 55 + test/test_new_campaign_template.py | 3 + test/test_new_coupon_deletion_job.py | 4 +- test/test_new_custom_effect.py | 1 + test/test_new_customer_session_v2.py | 2 +- test/test_new_invitation.py | 2 +- test/test_new_loyalty_program.py | 1 + test/test_new_picklist.py | 4 +- test/test_new_revision_version.py | 76 ++ test/test_new_template_def.py | 2 + test/test_picklist.py | 4 +- test/test_product_search_match.py | 56 + test/test_product_sku_unit_analytics.py | 63 + test/test_product_unit_analytics.py | 65 + test/test_reopen_session_response.py | 4 + test/test_revision.py | 100 ++ test/test_revision_activation.py | 52 + test/test_revision_version.py | 92 ++ test/test_scim_base_user.py | 56 + test/test_scim_base_user_name.py | 52 + test/test_scim_new_user.py | 4 +- test/test_scim_patch_operation.py | 55 + test/test_scim_patch_request.py | 60 + test/test_scim_resource.py | 3 +- .../test_scim_resource_types_list_response.py | 4 +- test/test_scim_schema_resource.py | 57 + test/test_scim_schemas_list_response.py | 61 + ...t_scim_service_provider_config_response.py | 68 ++ ...m_service_provider_config_response_bulk.py | 54 + ...rovider_config_response_change_password.py | 52 + ...service_provider_config_response_filter.py | 53 + ..._service_provider_config_response_patch.py | 52 + ...m_service_provider_config_response_sort.py | 52 + test/test_scim_user.py | 2 + test/test_scim_users_list_response.py | 4 + test/test_store.py | 4 +- test/test_strikethrough_debug_response.py | 63 + test/test_summary_campaign_store_budget.py | 56 + test/test_template_arg_def.py | 1 + test/test_template_def.py | 2 + test/test_track_event_v2_response.py | 22 +- test/test_update_achievement.py | 6 +- test/test_update_application.py | 1 + test/test_update_application_cif.py | 55 + test/test_update_campaign_template.py | 3 + test/test_update_loyalty_program.py | 1 + test/test_update_loyalty_program_tier.py | 55 + test/test_update_picklist.py | 4 +- test/test_user.py | 4 +- test/test_value_map.py | 57 + 504 files changed, 16256 insertions(+), 2817 deletions(-) create mode 100644 docs/AnalyticsProduct.md create mode 100644 docs/AnalyticsProductSKU.md create mode 100644 docs/ApplicationCIF.md create mode 100644 docs/ApplicationCIFExpression.md create mode 100644 docs/CampaignStoreBudget.md create mode 100644 docs/CampaignTemplateCouponReservationSettings.md create mode 100644 docs/CampaignVersions.md create mode 100644 docs/ListCampaignStoreBudgets.md create mode 100644 docs/ListCampaignStoreBudgetsStore.md create mode 100644 docs/LoyaltyCardBatch.md create mode 100644 docs/LoyaltyCardBatchResponse.md create mode 100644 docs/NewApplicationCIF.md create mode 100644 docs/NewApplicationCIFExpression.md create mode 100644 docs/NewCampaignStoreBudget.md create mode 100644 docs/NewCampaignStoreBudgetStoreLimit.md create mode 100644 docs/NewRevisionVersion.md create mode 100644 docs/ProductSearchMatch.md create mode 100644 docs/ProductSkuUnitAnalytics.md create mode 100644 docs/ProductUnitAnalytics.md create mode 100644 docs/Revision.md create mode 100644 docs/RevisionActivation.md create mode 100644 docs/RevisionVersion.md create mode 100644 docs/ScimBaseUser.md create mode 100644 docs/ScimBaseUserName.md create mode 100644 docs/ScimPatchOperation.md create mode 100644 docs/ScimPatchRequest.md create mode 100644 docs/ScimSchemaResource.md create mode 100644 docs/ScimSchemasListResponse.md create mode 100644 docs/ScimServiceProviderConfigResponse.md create mode 100644 docs/ScimServiceProviderConfigResponseBulk.md create mode 100644 docs/ScimServiceProviderConfigResponseChangePassword.md create mode 100644 docs/ScimServiceProviderConfigResponseFilter.md create mode 100644 docs/ScimServiceProviderConfigResponsePatch.md create mode 100644 docs/ScimServiceProviderConfigResponseSort.md create mode 100644 docs/StrikethroughDebugResponse.md create mode 100644 docs/SummaryCampaignStoreBudget.md create mode 100644 docs/UpdateApplicationCIF.md create mode 100644 docs/UpdateLoyaltyProgramTier.md create mode 100644 docs/ValueMap.md create mode 100644 talon_one/models/analytics_product.py create mode 100644 talon_one/models/analytics_product_sku.py create mode 100644 talon_one/models/application_cif.py create mode 100644 talon_one/models/application_cif_expression.py create mode 100644 talon_one/models/campaign_store_budget.py create mode 100644 talon_one/models/campaign_template_coupon_reservation_settings.py create mode 100644 talon_one/models/campaign_versions.py create mode 100644 talon_one/models/list_campaign_store_budgets.py create mode 100644 talon_one/models/list_campaign_store_budgets_store.py create mode 100644 talon_one/models/loyalty_card_batch.py create mode 100644 talon_one/models/loyalty_card_batch_response.py create mode 100644 talon_one/models/new_application_cif.py create mode 100644 talon_one/models/new_application_cif_expression.py create mode 100644 talon_one/models/new_campaign_store_budget.py create mode 100644 talon_one/models/new_campaign_store_budget_store_limit.py create mode 100644 talon_one/models/new_revision_version.py create mode 100644 talon_one/models/product_search_match.py create mode 100644 talon_one/models/product_sku_unit_analytics.py create mode 100644 talon_one/models/product_unit_analytics.py create mode 100644 talon_one/models/revision.py create mode 100644 talon_one/models/revision_activation.py create mode 100644 talon_one/models/revision_version.py create mode 100644 talon_one/models/scim_base_user.py create mode 100644 talon_one/models/scim_base_user_name.py create mode 100644 talon_one/models/scim_patch_operation.py create mode 100644 talon_one/models/scim_patch_request.py create mode 100644 talon_one/models/scim_schema_resource.py create mode 100644 talon_one/models/scim_schemas_list_response.py create mode 100644 talon_one/models/scim_service_provider_config_response.py create mode 100644 talon_one/models/scim_service_provider_config_response_bulk.py create mode 100644 talon_one/models/scim_service_provider_config_response_change_password.py create mode 100644 talon_one/models/scim_service_provider_config_response_filter.py create mode 100644 talon_one/models/scim_service_provider_config_response_patch.py create mode 100644 talon_one/models/scim_service_provider_config_response_sort.py create mode 100644 talon_one/models/strikethrough_debug_response.py create mode 100644 talon_one/models/summary_campaign_store_budget.py create mode 100644 talon_one/models/update_application_cif.py create mode 100644 talon_one/models/update_loyalty_program_tier.py create mode 100644 talon_one/models/value_map.py create mode 100644 test/test_analytics_product.py create mode 100644 test/test_analytics_product_sku.py create mode 100644 test/test_application_cif.py create mode 100644 test/test_application_cif_expression.py create mode 100644 test/test_campaign_store_budget.py create mode 100644 test/test_campaign_template_coupon_reservation_settings.py create mode 100644 test/test_campaign_versions.py create mode 100644 test/test_list_campaign_store_budgets.py create mode 100644 test/test_list_campaign_store_budgets_store.py create mode 100644 test/test_loyalty_card_batch.py create mode 100644 test/test_loyalty_card_batch_response.py create mode 100644 test/test_new_application_cif.py create mode 100644 test/test_new_application_cif_expression.py create mode 100644 test/test_new_campaign_store_budget.py create mode 100644 test/test_new_campaign_store_budget_store_limit.py create mode 100644 test/test_new_revision_version.py create mode 100644 test/test_product_search_match.py create mode 100644 test/test_product_sku_unit_analytics.py create mode 100644 test/test_product_unit_analytics.py create mode 100644 test/test_revision.py create mode 100644 test/test_revision_activation.py create mode 100644 test/test_revision_version.py create mode 100644 test/test_scim_base_user.py create mode 100644 test/test_scim_base_user_name.py create mode 100644 test/test_scim_patch_operation.py create mode 100644 test/test_scim_patch_request.py create mode 100644 test/test_scim_schema_resource.py create mode 100644 test/test_scim_schemas_list_response.py create mode 100644 test/test_scim_service_provider_config_response.py create mode 100644 test/test_scim_service_provider_config_response_bulk.py create mode 100644 test/test_scim_service_provider_config_response_change_password.py create mode 100644 test/test_scim_service_provider_config_response_filter.py create mode 100644 test/test_scim_service_provider_config_response_patch.py create mode 100644 test/test_scim_service_provider_config_response_sort.py create mode 100644 test/test_strikethrough_debug_response.py create mode 100644 test/test_summary_campaign_store_budget.py create mode 100644 test/test_update_application_cif.py create mode 100644 test/test_update_loyalty_program_tier.py create mode 100644 test/test_value_map.py diff --git a/README.md b/README.md index 591628e..a3fe5e8 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,41 @@ # Talon.One Python SDK -This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: +This SDK supports all of the operations of Talon.One's Integration API and Management API. -- Package version: 6.1.1 -- Generator version: 4.3.1 -- Build package: org.openapitools.codegen.languages.PythonClientCodegen - -## Installation & Usage +## Installation and usage ### pip install -If the python package is hosted on a repository, you can install directly using: +The SDK is available on [PyPi](https://pypi.org/project/talon-one-python-sdk/): ```sh pip install talon-one-python-sdk ``` -(you may need to run `pip` with root permission: `sudo pip install talon-one-python-sdk`) - -Then import the package: -```python -import talon_one -``` +**Note**: You may need to run `pip` with root permissions: `sudo pip install talon-one-python-sdk`. ### Setuptools -Install via [Setuptools](http://pypi.python.org/pypi/setuptools). +You can also install the SDK via [Setuptools](http://pypi.python.org/pypi/setuptools): ```sh python setup.py install --user ``` -(or `sudo python setup.py install` to install the package for all users) -Then import the package: -```python -import talon_one -``` +**Note**: To install the package for all users, run `sudo python setup.py install`. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one`, -the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint +the URL for the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`. -## Integration API +## Getting started + +### Integration API -Please follow the [installation procedure](#installation--usage) and then run the following: +The following code shows an example of using the Integration API: ```python import talon_one @@ -56,7 +45,7 @@ import json # Create configuration with your host destination and authorization using api_key_v1 configuration = talon_one.Configuration( - host = "https://yourbaseurl.talon.one", + host = "https://yourbaseurl.talon.one", # No trailing slash! api_key_prefix = { "Authorization": "ApiKey-v1" }, @@ -122,9 +111,9 @@ except ApiException as e: print("Exception when calling IntegrationApi->update_customer_session_v2: %s\n" % e) ``` -## Management API +### Management API -Please follow the [installation procedure](#installation--usage) and then run the following: +The following code shows an example of using the Management API: ```python import talon_one @@ -133,7 +122,7 @@ import json # Create configuration with your host destination and authorization using management_key configuration = talon_one.Configuration( - host = "https://yourbaseurl.talon.one", + host = "https://yourbaseurl.talon.one", # No trailing slash! api_key_prefix = { "Authorization": "ManagementKey-v1" }, @@ -154,9 +143,9 @@ except ApiException as e: print("Exception when calling ManagementApi: %s\n" % e) ``` -## Documentation for API Endpoints +## Documentation for API endpoints -All URLs are relative to *https://yourbaseurl.talon.one*. +All URLs are relative to `https://yourbaseurl.talon.one`. Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- @@ -171,7 +160,7 @@ Class | Method | HTTP request | Description *IntegrationApi* | [**generate_loyalty_card**](docs/IntegrationApi.md#generate_loyalty_card) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card *IntegrationApi* | [**get_customer_inventory**](docs/IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | List customer data *IntegrationApi* | [**get_customer_session**](docs/IntegrationApi.md#get_customer_session) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session -*IntegrationApi* | [**get_loyalty_balances**](docs/IntegrationApi.md#get_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty points +*IntegrationApi* | [**get_loyalty_balances**](docs/IntegrationApi.md#get_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty balances *IntegrationApi* | [**get_loyalty_card_balances**](docs/IntegrationApi.md#get_loyalty_card_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances | Get card's point balances *IntegrationApi* | [**get_loyalty_card_points**](docs/IntegrationApi.md#get_loyalty_card_points) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points | List card's unused loyalty points *IntegrationApi* | [**get_loyalty_card_transactions**](docs/IntegrationApi.md#get_loyalty_card_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions | List card's transactions @@ -197,6 +186,7 @@ Class | Method | HTTP request | Description *ManagementApi* | [**create_achievement**](docs/ManagementApi.md#create_achievement) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | Create achievement *ManagementApi* | [**create_additional_cost**](docs/ManagementApi.md#create_additional_cost) | **POST** /v1/additional_costs | Create additional cost *ManagementApi* | [**create_attribute**](docs/ManagementApi.md#create_attribute) | **POST** /v1/attributes | Create custom attribute +*ManagementApi* | [**create_batch_loyalty_cards**](docs/ManagementApi.md#create_batch_loyalty_cards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards *ManagementApi* | [**create_campaign_from_template**](docs/ManagementApi.md#create_campaign_from_template) | **POST** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template *ManagementApi* | [**create_collection**](docs/ManagementApi.md#create_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection *ManagementApi* | [**create_coupons**](docs/ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons @@ -236,6 +226,7 @@ Class | Method | HTTP request | Description *ManagementApi* | [**export_loyalty_balances**](docs/ManagementApi.md#export_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances *ManagementApi* | [**export_loyalty_card_balances**](docs/ManagementApi.md#export_loyalty_card_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export all card transaction logs *ManagementApi* | [**export_loyalty_card_ledger**](docs/ManagementApi.md#export_loyalty_card_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log | Export card's ledger log +*ManagementApi* | [**export_loyalty_cards**](docs/ManagementApi.md#export_loyalty_cards) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/export | Export loyalty cards *ManagementApi* | [**export_loyalty_ledger**](docs/ManagementApi.md#export_loyalty_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs *ManagementApi* | [**export_pool_giveaways**](docs/ManagementApi.md#export_pool_giveaways) | **GET** /v1/giveaways/pools/{poolId}/export | Export giveaway codes of a giveaway pool *ManagementApi* | [**export_referrals**](docs/ManagementApi.md#export_referrals) | **GET** /v1/applications/{applicationId}/export_referrals | Export referrals @@ -246,7 +237,6 @@ Class | Method | HTTP request | Description *ManagementApi* | [**get_achievement**](docs/ManagementApi.md#get_achievement) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Get achievement *ManagementApi* | [**get_additional_cost**](docs/ManagementApi.md#get_additional_cost) | **GET** /v1/additional_costs/{additionalCostId} | Get additional cost *ManagementApi* | [**get_additional_costs**](docs/ManagementApi.md#get_additional_costs) | **GET** /v1/additional_costs | List additional costs -*ManagementApi* | [**get_all_access_logs**](docs/ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | List access logs *ManagementApi* | [**get_application**](docs/ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application *ManagementApi* | [**get_application_api_health**](docs/ManagementApi.md#get_application_api_health) | **GET** /v1/applications/{applicationId}/health_report | Get Application health *ManagementApi* | [**get_application_customer**](docs/ManagementApi.md#get_application_customer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get application's customer @@ -332,7 +322,7 @@ Class | Method | HTTP request | Description *ManagementApi* | [**scim_delete_user**](docs/ManagementApi.md#scim_delete_user) | **DELETE** /v1/provisioning/scim/Users/{userId} | Delete SCIM user *ManagementApi* | [**scim_get_resource_types**](docs/ManagementApi.md#scim_get_resource_types) | **GET** /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types *ManagementApi* | [**scim_get_schemas**](docs/ManagementApi.md#scim_get_schemas) | **GET** /v1/provisioning/scim/Schemas | List supported SCIM schemas -*ManagementApi* | [**scim_get_service_provider_config**](docs/ManagementApi.md#scim_get_service_provider_config) | **GET** /v1/provisioning/scim/ServiceProviderConfig | Service config endpoint for SCIM provisioning protocol +*ManagementApi* | [**scim_get_service_provider_config**](docs/ManagementApi.md#scim_get_service_provider_config) | **GET** /v1/provisioning/scim/ServiceProviderConfig | Get SCIM service provider configuration *ManagementApi* | [**scim_get_user**](docs/ManagementApi.md#scim_get_user) | **GET** /v1/provisioning/scim/Users/{userId} | Get SCIM user *ManagementApi* | [**scim_get_users**](docs/ManagementApi.md#scim_get_users) | **GET** /v1/provisioning/scim/Users | List SCIM users *ManagementApi* | [**scim_patch_user**](docs/ManagementApi.md#scim_patch_user) | **PATCH** /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes @@ -354,512 +344,541 @@ Class | Method | HTTP request | Description *ManagementApi* | [**update_store**](docs/ManagementApi.md#update_store) | **PUT** /v1/applications/{applicationId}/stores/{storeId} | Update store *ManagementApi* | [**update_user**](docs/ManagementApi.md#update_user) | **PUT** /v1/users/{userId} | Update user - -## Documentation For Models - - - [APIError](docs/APIError.md) - - [AcceptCouponEffectProps](docs/AcceptCouponEffectProps.md) - - [AcceptReferralEffectProps](docs/AcceptReferralEffectProps.md) - - [AccessLogEntry](docs/AccessLogEntry.md) - - [Account](docs/Account.md) - - [AccountAdditionalCost](docs/AccountAdditionalCost.md) - - [AccountAnalytics](docs/AccountAnalytics.md) - - [AccountDashboardStatistic](docs/AccountDashboardStatistic.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) - - [Achievement](docs/Achievement.md) - - [AchievementAdditionalProperties](docs/AchievementAdditionalProperties.md) - - [AchievementProgress](docs/AchievementProgress.md) - - [ActivateUserRequest](docs/ActivateUserRequest.md) - - [AddFreeItemEffectProps](docs/AddFreeItemEffectProps.md) - - [AddItemCatalogAction](docs/AddItemCatalogAction.md) - - [AddLoyaltyPoints](docs/AddLoyaltyPoints.md) - - [AddLoyaltyPointsEffectProps](docs/AddLoyaltyPointsEffectProps.md) - - [AddToAudienceEffectProps](docs/AddToAudienceEffectProps.md) - - [AddedDeductedPointsNotificationPolicy](docs/AddedDeductedPointsNotificationPolicy.md) - - [AdditionalCampaignProperties](docs/AdditionalCampaignProperties.md) - - [AdditionalCost](docs/AdditionalCost.md) - - [AnalyticsDataPoint](docs/AnalyticsDataPoint.md) - - [AnalyticsDataPointWithTrend](docs/AnalyticsDataPointWithTrend.md) - - [AnalyticsDataPointWithTrendAndInfluencedRate](docs/AnalyticsDataPointWithTrendAndInfluencedRate.md) - - [AnalyticsDataPointWithTrendAndUplift](docs/AnalyticsDataPointWithTrendAndUplift.md) - - [Application](docs/Application.md) - - [ApplicationAPIKey](docs/ApplicationAPIKey.md) - - [ApplicationAnalyticsDataPoint](docs/ApplicationAnalyticsDataPoint.md) - - [ApplicationApiHealth](docs/ApplicationApiHealth.md) - - [ApplicationCampaignAnalytics](docs/ApplicationCampaignAnalytics.md) - - [ApplicationCampaignStats](docs/ApplicationCampaignStats.md) - - [ApplicationCustomer](docs/ApplicationCustomer.md) - - [ApplicationCustomerEntity](docs/ApplicationCustomerEntity.md) - - [ApplicationEntity](docs/ApplicationEntity.md) - - [ApplicationEvent](docs/ApplicationEvent.md) - - [ApplicationNotification](docs/ApplicationNotification.md) - - [ApplicationReferee](docs/ApplicationReferee.md) - - [ApplicationSession](docs/ApplicationSession.md) - - [ApplicationSessionEntity](docs/ApplicationSessionEntity.md) - - [ApplicationStoreEntity](docs/ApplicationStoreEntity.md) - - [AsyncCouponCreationResponse](docs/AsyncCouponCreationResponse.md) - - [AsyncCouponDeletionJobResponse](docs/AsyncCouponDeletionJobResponse.md) - - [Attribute](docs/Attribute.md) - - [AttributesMandatory](docs/AttributesMandatory.md) - - [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) - - [BaseCampaign](docs/BaseCampaign.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) - - [BulkCampaignNotification](docs/BulkCampaignNotification.md) - - [BulkOperationOnCampaigns](docs/BulkOperationOnCampaigns.md) - - [Campaign](docs/Campaign.md) - - [CampaignActivationRequest](docs/CampaignActivationRequest.md) - - [CampaignAnalytics](docs/CampaignAnalytics.md) - - [CampaignBudget](docs/CampaignBudget.md) - - [CampaignCollection](docs/CampaignCollection.md) - - [CampaignCollectionEditedNotification](docs/CampaignCollectionEditedNotification.md) - - [CampaignCollectionWithoutPayload](docs/CampaignCollectionWithoutPayload.md) - - [CampaignCopy](docs/CampaignCopy.md) - - [CampaignCreatedNotification](docs/CampaignCreatedNotification.md) - - [CampaignDeletedNotification](docs/CampaignDeletedNotification.md) - - [CampaignEditedNotification](docs/CampaignEditedNotification.md) - - [CampaignEntity](docs/CampaignEntity.md) - - [CampaignEvaluationGroup](docs/CampaignEvaluationGroup.md) - - [CampaignEvaluationPosition](docs/CampaignEvaluationPosition.md) - - [CampaignEvaluationTreeChangedNotification](docs/CampaignEvaluationTreeChangedNotification.md) - - [CampaignGroup](docs/CampaignGroup.md) - - [CampaignGroupEntity](docs/CampaignGroupEntity.md) - - [CampaignNotification](docs/CampaignNotification.md) - - [CampaignNotificationPolicy](docs/CampaignNotificationPolicy.md) - - [CampaignRulesetChangedNotification](docs/CampaignRulesetChangedNotification.md) - - [CampaignSearch](docs/CampaignSearch.md) - - [CampaignSet](docs/CampaignSet.md) - - [CampaignSetBranchNode](docs/CampaignSetBranchNode.md) - - [CampaignSetLeafNode](docs/CampaignSetLeafNode.md) - - [CampaignSetNode](docs/CampaignSetNode.md) - - [CampaignStateChangedNotification](docs/CampaignStateChangedNotification.md) - - [CampaignTemplate](docs/CampaignTemplate.md) - - [CampaignTemplateCollection](docs/CampaignTemplateCollection.md) - - [CampaignTemplateParams](docs/CampaignTemplateParams.md) - - [CardAddedDeductedPointsNotificationPolicy](docs/CardAddedDeductedPointsNotificationPolicy.md) - - [CardExpiringPointsNotificationPolicy](docs/CardExpiringPointsNotificationPolicy.md) - - [CardExpiringPointsNotificationTrigger](docs/CardExpiringPointsNotificationTrigger.md) - - [CardLedgerPointsEntryIntegrationAPI](docs/CardLedgerPointsEntryIntegrationAPI.md) - - [CardLedgerTransactionLogEntry](docs/CardLedgerTransactionLogEntry.md) - - [CardLedgerTransactionLogEntryIntegrationAPI](docs/CardLedgerTransactionLogEntryIntegrationAPI.md) - - [CartItem](docs/CartItem.md) - - [Catalog](docs/Catalog.md) - - [CatalogAction](docs/CatalogAction.md) - - [CatalogActionFilter](docs/CatalogActionFilter.md) - - [CatalogItem](docs/CatalogItem.md) - - [CatalogSyncRequest](docs/CatalogSyncRequest.md) - - [CatalogsStrikethroughNotificationPolicy](docs/CatalogsStrikethroughNotificationPolicy.md) - - [Change](docs/Change.md) - - [ChangeLoyaltyTierLevelEffectProps](docs/ChangeLoyaltyTierLevelEffectProps.md) - - [ChangeProfilePassword](docs/ChangeProfilePassword.md) - - [CodeGeneratorSettings](docs/CodeGeneratorSettings.md) - - [Collection](docs/Collection.md) - - [CollectionItem](docs/CollectionItem.md) - - [CollectionWithoutPayload](docs/CollectionWithoutPayload.md) - - [Coupon](docs/Coupon.md) - - [CouponConstraints](docs/CouponConstraints.md) - - [CouponCreatedEffectProps](docs/CouponCreatedEffectProps.md) - - [CouponCreationJob](docs/CouponCreationJob.md) - - [CouponDeletionFilters](docs/CouponDeletionFilters.md) - - [CouponDeletionJob](docs/CouponDeletionJob.md) - - [CouponLimitConfigs](docs/CouponLimitConfigs.md) - - [CouponRejectionReason](docs/CouponRejectionReason.md) - - [CouponReservations](docs/CouponReservations.md) - - [CouponSearch](docs/CouponSearch.md) - - [CouponValue](docs/CouponValue.md) - - [CouponsNotificationPolicy](docs/CouponsNotificationPolicy.md) - - [CreateAchievement](docs/CreateAchievement.md) - - [CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md) - - [CreateManagementKey](docs/CreateManagementKey.md) - - [CreateTemplateCampaign](docs/CreateTemplateCampaign.md) - - [CreateTemplateCampaignResponse](docs/CreateTemplateCampaignResponse.md) - - [CustomEffect](docs/CustomEffect.md) - - [CustomEffectProps](docs/CustomEffectProps.md) - - [CustomerActivityReport](docs/CustomerActivityReport.md) - - [CustomerAnalytics](docs/CustomerAnalytics.md) - - [CustomerInventory](docs/CustomerInventory.md) - - [CustomerProfile](docs/CustomerProfile.md) - - [CustomerProfileAudienceRequest](docs/CustomerProfileAudienceRequest.md) - - [CustomerProfileAudienceRequestItem](docs/CustomerProfileAudienceRequestItem.md) - - [CustomerProfileIntegrationRequestV2](docs/CustomerProfileIntegrationRequestV2.md) - - [CustomerProfileIntegrationResponseV2](docs/CustomerProfileIntegrationResponseV2.md) - - [CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md) - - [CustomerProfileUpdateV2Response](docs/CustomerProfileUpdateV2Response.md) - - [CustomerSession](docs/CustomerSession.md) - - [CustomerSessionV2](docs/CustomerSessionV2.md) - - [DeactivateUserRequest](docs/DeactivateUserRequest.md) - - [DeductLoyaltyPoints](docs/DeductLoyaltyPoints.md) - - [DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md) - - [DeleteUserRequest](docs/DeleteUserRequest.md) - - [Effect](docs/Effect.md) - - [EffectEntity](docs/EffectEntity.md) - - [EmailEntity](docs/EmailEntity.md) - - [Endpoint](docs/Endpoint.md) - - [Entity](docs/Entity.md) - - [EntityWithTalangVisibleID](docs/EntityWithTalangVisibleID.md) - - [Environment](docs/Environment.md) - - [ErrorEffectProps](docs/ErrorEffectProps.md) - - [ErrorResponse](docs/ErrorResponse.md) - - [ErrorResponseWithStatus](docs/ErrorResponseWithStatus.md) - - [ErrorSource](docs/ErrorSource.md) - - [EvaluableCampaignIds](docs/EvaluableCampaignIds.md) - - [Event](docs/Event.md) - - [EventType](docs/EventType.md) - - [EventV2](docs/EventV2.md) - - [ExpiringCouponsNotificationPolicy](docs/ExpiringCouponsNotificationPolicy.md) - - [ExpiringCouponsNotificationTrigger](docs/ExpiringCouponsNotificationTrigger.md) - - [ExpiringPointsNotificationPolicy](docs/ExpiringPointsNotificationPolicy.md) - - [ExpiringPointsNotificationTrigger](docs/ExpiringPointsNotificationTrigger.md) - - [Export](docs/Export.md) - - [FeatureFlag](docs/FeatureFlag.md) - - [FeaturesFeed](docs/FeaturesFeed.md) - - [FuncArgDef](docs/FuncArgDef.md) - - [FunctionDef](docs/FunctionDef.md) - - [GenerateCampaignDescription](docs/GenerateCampaignDescription.md) - - [GenerateCampaignTags](docs/GenerateCampaignTags.md) - - [GenerateItemFilterDescription](docs/GenerateItemFilterDescription.md) - - [GenerateLoyaltyCard](docs/GenerateLoyaltyCard.md) - - [GenerateRuleTitle](docs/GenerateRuleTitle.md) - - [GenerateRuleTitleRule](docs/GenerateRuleTitleRule.md) - - [GetIntegrationCouponRequest](docs/GetIntegrationCouponRequest.md) - - [Giveaway](docs/Giveaway.md) - - [GiveawaysPool](docs/GiveawaysPool.md) - - [IdentifiableEntity](docs/IdentifiableEntity.md) - - [ImportEntity](docs/ImportEntity.md) - - [IncreaseAchievementProgressEffectProps](docs/IncreaseAchievementProgressEffectProps.md) - - [InlineResponse200](docs/InlineResponse200.md) - - [InlineResponse2001](docs/InlineResponse2001.md) - - [InlineResponse20010](docs/InlineResponse20010.md) - - [InlineResponse20011](docs/InlineResponse20011.md) - - [InlineResponse20012](docs/InlineResponse20012.md) - - [InlineResponse20013](docs/InlineResponse20013.md) - - [InlineResponse20014](docs/InlineResponse20014.md) - - [InlineResponse20015](docs/InlineResponse20015.md) - - [InlineResponse20016](docs/InlineResponse20016.md) - - [InlineResponse20017](docs/InlineResponse20017.md) - - [InlineResponse20018](docs/InlineResponse20018.md) - - [InlineResponse20019](docs/InlineResponse20019.md) - - [InlineResponse2002](docs/InlineResponse2002.md) - - [InlineResponse20020](docs/InlineResponse20020.md) - - [InlineResponse20021](docs/InlineResponse20021.md) - - [InlineResponse20022](docs/InlineResponse20022.md) - - [InlineResponse20023](docs/InlineResponse20023.md) - - [InlineResponse20024](docs/InlineResponse20024.md) - - [InlineResponse20025](docs/InlineResponse20025.md) - - [InlineResponse20026](docs/InlineResponse20026.md) - - [InlineResponse20027](docs/InlineResponse20027.md) - - [InlineResponse20028](docs/InlineResponse20028.md) - - [InlineResponse20029](docs/InlineResponse20029.md) - - [InlineResponse2003](docs/InlineResponse2003.md) - - [InlineResponse20030](docs/InlineResponse20030.md) - - [InlineResponse20031](docs/InlineResponse20031.md) - - [InlineResponse20032](docs/InlineResponse20032.md) - - [InlineResponse20033](docs/InlineResponse20033.md) - - [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) - - [InlineResponse20041](docs/InlineResponse20041.md) - - [InlineResponse20042](docs/InlineResponse20042.md) - - [InlineResponse20043](docs/InlineResponse20043.md) - - [InlineResponse20044](docs/InlineResponse20044.md) - - [InlineResponse20045](docs/InlineResponse20045.md) - - [InlineResponse20046](docs/InlineResponse20046.md) - - [InlineResponse20047](docs/InlineResponse20047.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) - - [IntegrationEventV2Request](docs/IntegrationEventV2Request.md) - - [IntegrationProfileEntity](docs/IntegrationProfileEntity.md) - - [IntegrationRequest](docs/IntegrationRequest.md) - - [IntegrationState](docs/IntegrationState.md) - - [IntegrationStateV2](docs/IntegrationStateV2.md) - - [IntegrationStoreEntity](docs/IntegrationStoreEntity.md) - - [InventoryCoupon](docs/InventoryCoupon.md) - - [InventoryReferral](docs/InventoryReferral.md) - - [ItemAttribute](docs/ItemAttribute.md) - - [LedgerEntry](docs/LedgerEntry.md) - - [LedgerInfo](docs/LedgerInfo.md) - - [LedgerPointsEntryIntegrationAPI](docs/LedgerPointsEntryIntegrationAPI.md) - - [LedgerTransactionLogEntryIntegrationAPI](docs/LedgerTransactionLogEntryIntegrationAPI.md) - - [LibraryAttribute](docs/LibraryAttribute.md) - - [LimitConfig](docs/LimitConfig.md) - - [LimitCounter](docs/LimitCounter.md) - - [LoginParams](docs/LoginParams.md) - - [Loyalty](docs/Loyalty.md) - - [LoyaltyBalance](docs/LoyaltyBalance.md) - - [LoyaltyBalanceWithTier](docs/LoyaltyBalanceWithTier.md) - - [LoyaltyBalances](docs/LoyaltyBalances.md) - - [LoyaltyBalancesWithTiers](docs/LoyaltyBalancesWithTiers.md) - - [LoyaltyCard](docs/LoyaltyCard.md) - - [LoyaltyCardBalances](docs/LoyaltyCardBalances.md) - - [LoyaltyCardProfileRegistration](docs/LoyaltyCardProfileRegistration.md) - - [LoyaltyCardRegistration](docs/LoyaltyCardRegistration.md) - - [LoyaltyDashboardData](docs/LoyaltyDashboardData.md) - - [LoyaltyDashboardPointsBreakdown](docs/LoyaltyDashboardPointsBreakdown.md) - - [LoyaltyLedger](docs/LoyaltyLedger.md) - - [LoyaltyLedgerEntry](docs/LoyaltyLedgerEntry.md) - - [LoyaltyLedgerTransactions](docs/LoyaltyLedgerTransactions.md) - - [LoyaltyMembership](docs/LoyaltyMembership.md) - - [LoyaltyProgram](docs/LoyaltyProgram.md) - - [LoyaltyProgramBalance](docs/LoyaltyProgramBalance.md) - - [LoyaltyProgramEntity](docs/LoyaltyProgramEntity.md) - - [LoyaltyProgramLedgers](docs/LoyaltyProgramLedgers.md) - - [LoyaltyProgramSubledgers](docs/LoyaltyProgramSubledgers.md) - - [LoyaltyProgramTransaction](docs/LoyaltyProgramTransaction.md) - - [LoyaltySubLedger](docs/LoyaltySubLedger.md) - - [LoyaltyTier](docs/LoyaltyTier.md) - - [ManagementKey](docs/ManagementKey.md) - - [ManagerConfig](docs/ManagerConfig.md) - - [MessageLogEntries](docs/MessageLogEntries.md) - - [MessageLogEntry](docs/MessageLogEntry.md) - - [MessageLogRequest](docs/MessageLogRequest.md) - - [MessageLogResponse](docs/MessageLogResponse.md) - - [Meta](docs/Meta.md) - - [ModelImport](docs/ModelImport.md) - - [ModelReturn](docs/ModelReturn.md) - - [MultiApplicationEntity](docs/MultiApplicationEntity.md) - - [MultipleAttribute](docs/MultipleAttribute.md) - - [MultipleAudiences](docs/MultipleAudiences.md) - - [MultipleAudiencesItem](docs/MultipleAudiencesItem.md) - - [MultipleCustomerProfileIntegrationRequest](docs/MultipleCustomerProfileIntegrationRequest.md) - - [MultipleCustomerProfileIntegrationRequestItem](docs/MultipleCustomerProfileIntegrationRequestItem.md) - - [MultipleCustomerProfileIntegrationResponseV2](docs/MultipleCustomerProfileIntegrationResponseV2.md) - - [MultipleNewAttribute](docs/MultipleNewAttribute.md) - - [MultipleNewAudiences](docs/MultipleNewAudiences.md) - - [MutableEntity](docs/MutableEntity.md) - - [NewAccount](docs/NewAccount.md) - - [NewAccountSignUp](docs/NewAccountSignUp.md) - - [NewAdditionalCost](docs/NewAdditionalCost.md) - - [NewAppWideCouponDeletionJob](docs/NewAppWideCouponDeletionJob.md) - - [NewApplication](docs/NewApplication.md) - - [NewApplicationAPIKey](docs/NewApplicationAPIKey.md) - - [NewAttribute](docs/NewAttribute.md) - - [NewAudience](docs/NewAudience.md) - - [NewBaseNotification](docs/NewBaseNotification.md) - - [NewCampaign](docs/NewCampaign.md) - - [NewCampaignCollection](docs/NewCampaignCollection.md) - - [NewCampaignEvaluationGroup](docs/NewCampaignEvaluationGroup.md) - - [NewCampaignGroup](docs/NewCampaignGroup.md) - - [NewCampaignSet](docs/NewCampaignSet.md) - - [NewCampaignTemplate](docs/NewCampaignTemplate.md) - - [NewCatalog](docs/NewCatalog.md) - - [NewCollection](docs/NewCollection.md) - - [NewCouponCreationJob](docs/NewCouponCreationJob.md) - - [NewCouponDeletionJob](docs/NewCouponDeletionJob.md) - - [NewCoupons](docs/NewCoupons.md) - - [NewCouponsForMultipleRecipients](docs/NewCouponsForMultipleRecipients.md) - - [NewCustomEffect](docs/NewCustomEffect.md) - - [NewCustomerProfile](docs/NewCustomerProfile.md) - - [NewCustomerSession](docs/NewCustomerSession.md) - - [NewCustomerSessionV2](docs/NewCustomerSessionV2.md) - - [NewEvent](docs/NewEvent.md) - - [NewEventType](docs/NewEventType.md) - - [NewExternalInvitation](docs/NewExternalInvitation.md) - - [NewGiveawaysPool](docs/NewGiveawaysPool.md) - - [NewInternalAudience](docs/NewInternalAudience.md) - - [NewInvitation](docs/NewInvitation.md) - - [NewInviteEmail](docs/NewInviteEmail.md) - - [NewLoyaltyProgram](docs/NewLoyaltyProgram.md) - - [NewLoyaltyTier](docs/NewLoyaltyTier.md) - - [NewManagementKey](docs/NewManagementKey.md) - - [NewMultipleAudiencesItem](docs/NewMultipleAudiencesItem.md) - - [NewNotificationTest](docs/NewNotificationTest.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) - - [NewRole](docs/NewRole.md) - - [NewRoleV2](docs/NewRoleV2.md) - - [NewRuleset](docs/NewRuleset.md) - - [NewSamlConnection](docs/NewSamlConnection.md) - - [NewStore](docs/NewStore.md) - - [NewTemplateDef](docs/NewTemplateDef.md) - - [NewUser](docs/NewUser.md) - - [NewWebhook](docs/NewWebhook.md) - - [Notification](docs/Notification.md) - - [NotificationActivation](docs/NotificationActivation.md) - - [NotificationListItem](docs/NotificationListItem.md) - - [NotificationTest](docs/NotificationTest.md) - - [OktaEvent](docs/OktaEvent.md) - - [OktaEventPayload](docs/OktaEventPayload.md) - - [OktaEventPayloadData](docs/OktaEventPayloadData.md) - - [OktaEventTarget](docs/OktaEventTarget.md) - - [OneTimeCode](docs/OneTimeCode.md) - - [OutgoingIntegrationBrazePolicy](docs/OutgoingIntegrationBrazePolicy.md) - - [OutgoingIntegrationCleverTapPolicy](docs/OutgoingIntegrationCleverTapPolicy.md) - - [OutgoingIntegrationConfiguration](docs/OutgoingIntegrationConfiguration.md) - - [OutgoingIntegrationIterablePolicy](docs/OutgoingIntegrationIterablePolicy.md) - - [OutgoingIntegrationMoEngagePolicy](docs/OutgoingIntegrationMoEngagePolicy.md) - - [OutgoingIntegrationTemplate](docs/OutgoingIntegrationTemplate.md) - - [OutgoingIntegrationTemplateWithConfigurationDetails](docs/OutgoingIntegrationTemplateWithConfigurationDetails.md) - - [OutgoingIntegrationTemplates](docs/OutgoingIntegrationTemplates.md) - - [OutgoingIntegrationType](docs/OutgoingIntegrationType.md) - - [OutgoingIntegrationTypes](docs/OutgoingIntegrationTypes.md) - - [PatchItemCatalogAction](docs/PatchItemCatalogAction.md) - - [PatchManyItemsCatalogAction](docs/PatchManyItemsCatalogAction.md) - - [PendingPointsNotificationPolicy](docs/PendingPointsNotificationPolicy.md) - - [Picklist](docs/Picklist.md) - - [Product](docs/Product.md) - - [ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md) - - [ProjectedTier](docs/ProjectedTier.md) - - [RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md) - - [Referral](docs/Referral.md) - - [ReferralConstraints](docs/ReferralConstraints.md) - - [ReferralCreatedEffectProps](docs/ReferralCreatedEffectProps.md) - - [ReferralRejectionReason](docs/ReferralRejectionReason.md) - - [RejectCouponEffectProps](docs/RejectCouponEffectProps.md) - - [RejectReferralEffectProps](docs/RejectReferralEffectProps.md) - - [RemoveFromAudienceEffectProps](docs/RemoveFromAudienceEffectProps.md) - - [RemoveItemCatalogAction](docs/RemoveItemCatalogAction.md) - - [RemoveManyItemsCatalogAction](docs/RemoveManyItemsCatalogAction.md) - - [ReopenSessionResponse](docs/ReopenSessionResponse.md) - - [ReserveCouponEffectProps](docs/ReserveCouponEffectProps.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) - - [RoleV2Base](docs/RoleV2Base.md) - - [RoleV2PermissionSet](docs/RoleV2PermissionSet.md) - - [RoleV2Permissions](docs/RoleV2Permissions.md) - - [RoleV2RolesGroup](docs/RoleV2RolesGroup.md) - - [RollbackAddedLoyaltyPointsEffectProps](docs/RollbackAddedLoyaltyPointsEffectProps.md) - - [RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md) - - [RollbackDeductedLoyaltyPointsEffectProps](docs/RollbackDeductedLoyaltyPointsEffectProps.md) - - [RollbackDiscountEffectProps](docs/RollbackDiscountEffectProps.md) - - [RollbackIncreasedAchievementProgressEffectProps](docs/RollbackIncreasedAchievementProgressEffectProps.md) - - [RollbackReferralEffectProps](docs/RollbackReferralEffectProps.md) - - [Rule](docs/Rule.md) - - [RuleFailureReason](docs/RuleFailureReason.md) - - [Ruleset](docs/Ruleset.md) - - [SSOConfig](docs/SSOConfig.md) - - [SamlConnection](docs/SamlConnection.md) - - [SamlConnectionInternal](docs/SamlConnectionInternal.md) - - [SamlConnectionMetadata](docs/SamlConnectionMetadata.md) - - [SamlLoginEndpoint](docs/SamlLoginEndpoint.md) - - [ScimNewUser](docs/ScimNewUser.md) - - [ScimResource](docs/ScimResource.md) - - [ScimResourceTypesListResponse](docs/ScimResourceTypesListResponse.md) - - [ScimUser](docs/ScimUser.md) - - [ScimUsersListResponse](docs/ScimUsersListResponse.md) - - [Session](docs/Session.md) - - [SetDiscountEffectProps](docs/SetDiscountEffectProps.md) - - [SetDiscountPerAdditionalCostEffectProps](docs/SetDiscountPerAdditionalCostEffectProps.md) - - [SetDiscountPerAdditionalCostPerItemEffectProps](docs/SetDiscountPerAdditionalCostPerItemEffectProps.md) - - [SetDiscountPerItemEffectProps](docs/SetDiscountPerItemEffectProps.md) - - [ShowBundleMetadataEffectProps](docs/ShowBundleMetadataEffectProps.md) - - [ShowNotificationEffectProps](docs/ShowNotificationEffectProps.md) - - [SlotDef](docs/SlotDef.md) - - [Store](docs/Store.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) - - [TierDowngradeNotificationPolicy](docs/TierDowngradeNotificationPolicy.md) - - [TierUpgradeNotificationPolicy](docs/TierUpgradeNotificationPolicy.md) - - [TierWillDowngradeNotificationPolicy](docs/TierWillDowngradeNotificationPolicy.md) - - [TierWillDowngradeNotificationTrigger](docs/TierWillDowngradeNotificationTrigger.md) - - [TimePoint](docs/TimePoint.md) - - [TrackEventV2Response](docs/TrackEventV2Response.md) - - [TransferLoyaltyCard](docs/TransferLoyaltyCard.md) - - [TriggerWebhookEffectProps](docs/TriggerWebhookEffectProps.md) - - [TwoFAConfig](docs/TwoFAConfig.md) - - [UpdateAccount](docs/UpdateAccount.md) - - [UpdateAchievement](docs/UpdateAchievement.md) - - [UpdateApplication](docs/UpdateApplication.md) - - [UpdateApplicationAPIKey](docs/UpdateApplicationAPIKey.md) - - [UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md) - - [UpdateAudience](docs/UpdateAudience.md) - - [UpdateCampaign](docs/UpdateCampaign.md) - - [UpdateCampaignCollection](docs/UpdateCampaignCollection.md) - - [UpdateCampaignEvaluationGroup](docs/UpdateCampaignEvaluationGroup.md) - - [UpdateCampaignGroup](docs/UpdateCampaignGroup.md) - - [UpdateCampaignTemplate](docs/UpdateCampaignTemplate.md) - - [UpdateCatalog](docs/UpdateCatalog.md) - - [UpdateCollection](docs/UpdateCollection.md) - - [UpdateCoupon](docs/UpdateCoupon.md) - - [UpdateCouponBatch](docs/UpdateCouponBatch.md) - - [UpdateCustomEffect](docs/UpdateCustomEffect.md) - - [UpdateLoyaltyCard](docs/UpdateLoyaltyCard.md) - - [UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md) - - [UpdatePicklist](docs/UpdatePicklist.md) - - [UpdateReferral](docs/UpdateReferral.md) - - [UpdateReferralBatch](docs/UpdateReferralBatch.md) - - [UpdateRole](docs/UpdateRole.md) - - [UpdateStore](docs/UpdateStore.md) - - [UpdateUser](docs/UpdateUser.md) - - [User](docs/User.md) - - [UserEntity](docs/UserEntity.md) - - [Webhook](docs/Webhook.md) - - [WebhookActivationLogEntry](docs/WebhookActivationLogEntry.md) - - [WebhookLogEntry](docs/WebhookLogEntry.md) - - [WebhookWithOutgoingIntegrationDetails](docs/WebhookWithOutgoingIntegrationDetails.md) - - [WillAwardGiveawayEffectProps](docs/WillAwardGiveawayEffectProps.md) - - -## Documentation For Authorization - +## Documentation for models + +- [APIError](docs/APIError.md) +- [AcceptCouponEffectProps](docs/AcceptCouponEffectProps.md) +- [AcceptReferralEffectProps](docs/AcceptReferralEffectProps.md) +- [AccessLogEntry](docs/AccessLogEntry.md) +- [Account](docs/Account.md) +- [AccountAdditionalCost](docs/AccountAdditionalCost.md) +- [AccountAnalytics](docs/AccountAnalytics.md) +- [AccountDashboardStatistic](docs/AccountDashboardStatistic.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) +- [Achievement](docs/Achievement.md) +- [AchievementAdditionalProperties](docs/AchievementAdditionalProperties.md) +- [AchievementProgress](docs/AchievementProgress.md) +- [AddFreeItemEffectProps](docs/AddFreeItemEffectProps.md) +- [AddItemCatalogAction](docs/AddItemCatalogAction.md) +- [AddLoyaltyPoints](docs/AddLoyaltyPoints.md) +- [AddLoyaltyPointsEffectProps](docs/AddLoyaltyPointsEffectProps.md) +- [AddToAudienceEffectProps](docs/AddToAudienceEffectProps.md) +- [AddedDeductedPointsNotificationPolicy](docs/AddedDeductedPointsNotificationPolicy.md) +- [AdditionalCampaignProperties](docs/AdditionalCampaignProperties.md) +- [AdditionalCost](docs/AdditionalCost.md) +- [AnalyticsDataPoint](docs/AnalyticsDataPoint.md) +- [AnalyticsDataPointWithTrend](docs/AnalyticsDataPointWithTrend.md) +- [AnalyticsDataPointWithTrendAndInfluencedRate](docs/AnalyticsDataPointWithTrendAndInfluencedRate.md) +- [AnalyticsDataPointWithTrendAndUplift](docs/AnalyticsDataPointWithTrendAndUplift.md) +- [AnalyticsProduct](docs/AnalyticsProduct.md) +- [AnalyticsProductSKU](docs/AnalyticsProductSKU.md) +- [Application](docs/Application.md) +- [ApplicationAPIKey](docs/ApplicationAPIKey.md) +- [ApplicationAnalyticsDataPoint](docs/ApplicationAnalyticsDataPoint.md) +- [ApplicationApiHealth](docs/ApplicationApiHealth.md) +- [ApplicationCIF](docs/ApplicationCIF.md) +- [ApplicationCIFExpression](docs/ApplicationCIFExpression.md) +- [ApplicationCampaignAnalytics](docs/ApplicationCampaignAnalytics.md) +- [ApplicationCampaignStats](docs/ApplicationCampaignStats.md) +- [ApplicationCustomer](docs/ApplicationCustomer.md) +- [ApplicationCustomerEntity](docs/ApplicationCustomerEntity.md) +- [ApplicationEntity](docs/ApplicationEntity.md) +- [ApplicationEvent](docs/ApplicationEvent.md) +- [ApplicationNotification](docs/ApplicationNotification.md) +- [ApplicationReferee](docs/ApplicationReferee.md) +- [ApplicationSession](docs/ApplicationSession.md) +- [ApplicationSessionEntity](docs/ApplicationSessionEntity.md) +- [ApplicationStoreEntity](docs/ApplicationStoreEntity.md) +- [AsyncCouponCreationResponse](docs/AsyncCouponCreationResponse.md) +- [AsyncCouponDeletionJobResponse](docs/AsyncCouponDeletionJobResponse.md) +- [Attribute](docs/Attribute.md) +- [AttributesMandatory](docs/AttributesMandatory.md) +- [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) +- [BaseCampaign](docs/BaseCampaign.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) +- [BulkCampaignNotification](docs/BulkCampaignNotification.md) +- [BulkOperationOnCampaigns](docs/BulkOperationOnCampaigns.md) +- [Campaign](docs/Campaign.md) +- [CampaignActivationRequest](docs/CampaignActivationRequest.md) +- [CampaignAnalytics](docs/CampaignAnalytics.md) +- [CampaignBudget](docs/CampaignBudget.md) +- [CampaignCollection](docs/CampaignCollection.md) +- [CampaignCollectionEditedNotification](docs/CampaignCollectionEditedNotification.md) +- [CampaignCollectionWithoutPayload](docs/CampaignCollectionWithoutPayload.md) +- [CampaignCopy](docs/CampaignCopy.md) +- [CampaignCreatedNotification](docs/CampaignCreatedNotification.md) +- [CampaignDeletedNotification](docs/CampaignDeletedNotification.md) +- [CampaignEditedNotification](docs/CampaignEditedNotification.md) +- [CampaignEntity](docs/CampaignEntity.md) +- [CampaignEvaluationGroup](docs/CampaignEvaluationGroup.md) +- [CampaignEvaluationPosition](docs/CampaignEvaluationPosition.md) +- [CampaignEvaluationTreeChangedNotification](docs/CampaignEvaluationTreeChangedNotification.md) +- [CampaignGroup](docs/CampaignGroup.md) +- [CampaignGroupEntity](docs/CampaignGroupEntity.md) +- [CampaignNotification](docs/CampaignNotification.md) +- [CampaignNotificationPolicy](docs/CampaignNotificationPolicy.md) +- [CampaignRulesetChangedNotification](docs/CampaignRulesetChangedNotification.md) +- [CampaignSearch](docs/CampaignSearch.md) +- [CampaignSet](docs/CampaignSet.md) +- [CampaignSetBranchNode](docs/CampaignSetBranchNode.md) +- [CampaignSetLeafNode](docs/CampaignSetLeafNode.md) +- [CampaignSetNode](docs/CampaignSetNode.md) +- [CampaignStateChangedNotification](docs/CampaignStateChangedNotification.md) +- [CampaignStoreBudget](docs/CampaignStoreBudget.md) +- [CampaignTemplate](docs/CampaignTemplate.md) +- [CampaignTemplateCollection](docs/CampaignTemplateCollection.md) +- [CampaignTemplateCouponReservationSettings](docs/CampaignTemplateCouponReservationSettings.md) +- [CampaignTemplateParams](docs/CampaignTemplateParams.md) +- [CampaignVersions](docs/CampaignVersions.md) +- [CardAddedDeductedPointsNotificationPolicy](docs/CardAddedDeductedPointsNotificationPolicy.md) +- [CardExpiringPointsNotificationPolicy](docs/CardExpiringPointsNotificationPolicy.md) +- [CardExpiringPointsNotificationTrigger](docs/CardExpiringPointsNotificationTrigger.md) +- [CardLedgerPointsEntryIntegrationAPI](docs/CardLedgerPointsEntryIntegrationAPI.md) +- [CardLedgerTransactionLogEntry](docs/CardLedgerTransactionLogEntry.md) +- [CardLedgerTransactionLogEntryIntegrationAPI](docs/CardLedgerTransactionLogEntryIntegrationAPI.md) +- [CartItem](docs/CartItem.md) +- [Catalog](docs/Catalog.md) +- [CatalogAction](docs/CatalogAction.md) +- [CatalogActionFilter](docs/CatalogActionFilter.md) +- [CatalogItem](docs/CatalogItem.md) +- [CatalogSyncRequest](docs/CatalogSyncRequest.md) +- [CatalogsStrikethroughNotificationPolicy](docs/CatalogsStrikethroughNotificationPolicy.md) +- [Change](docs/Change.md) +- [ChangeLoyaltyTierLevelEffectProps](docs/ChangeLoyaltyTierLevelEffectProps.md) +- [ChangeProfilePassword](docs/ChangeProfilePassword.md) +- [CodeGeneratorSettings](docs/CodeGeneratorSettings.md) +- [Collection](docs/Collection.md) +- [CollectionItem](docs/CollectionItem.md) +- [CollectionWithoutPayload](docs/CollectionWithoutPayload.md) +- [Coupon](docs/Coupon.md) +- [CouponConstraints](docs/CouponConstraints.md) +- [CouponCreatedEffectProps](docs/CouponCreatedEffectProps.md) +- [CouponCreationJob](docs/CouponCreationJob.md) +- [CouponDeletionFilters](docs/CouponDeletionFilters.md) +- [CouponDeletionJob](docs/CouponDeletionJob.md) +- [CouponLimitConfigs](docs/CouponLimitConfigs.md) +- [CouponRejectionReason](docs/CouponRejectionReason.md) +- [CouponReservations](docs/CouponReservations.md) +- [CouponSearch](docs/CouponSearch.md) +- [CouponValue](docs/CouponValue.md) +- [CouponsNotificationPolicy](docs/CouponsNotificationPolicy.md) +- [CreateAchievement](docs/CreateAchievement.md) +- [CreateApplicationAPIKey](docs/CreateApplicationAPIKey.md) +- [CreateManagementKey](docs/CreateManagementKey.md) +- [CreateTemplateCampaign](docs/CreateTemplateCampaign.md) +- [CreateTemplateCampaignResponse](docs/CreateTemplateCampaignResponse.md) +- [CustomEffect](docs/CustomEffect.md) +- [CustomEffectProps](docs/CustomEffectProps.md) +- [CustomerActivityReport](docs/CustomerActivityReport.md) +- [CustomerAnalytics](docs/CustomerAnalytics.md) +- [CustomerInventory](docs/CustomerInventory.md) +- [CustomerProfile](docs/CustomerProfile.md) +- [CustomerProfileAudienceRequest](docs/CustomerProfileAudienceRequest.md) +- [CustomerProfileAudienceRequestItem](docs/CustomerProfileAudienceRequestItem.md) +- [CustomerProfileIntegrationRequestV2](docs/CustomerProfileIntegrationRequestV2.md) +- [CustomerProfileIntegrationResponseV2](docs/CustomerProfileIntegrationResponseV2.md) +- [CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md) +- [CustomerProfileUpdateV2Response](docs/CustomerProfileUpdateV2Response.md) +- [CustomerSession](docs/CustomerSession.md) +- [CustomerSessionV2](docs/CustomerSessionV2.md) +- [DeactivateUserRequest](docs/DeactivateUserRequest.md) +- [DeductLoyaltyPoints](docs/DeductLoyaltyPoints.md) +- [DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md) +- [Effect](docs/Effect.md) +- [EffectEntity](docs/EffectEntity.md) +- [EmailEntity](docs/EmailEntity.md) +- [Endpoint](docs/Endpoint.md) +- [Entity](docs/Entity.md) +- [EntityWithTalangVisibleID](docs/EntityWithTalangVisibleID.md) +- [Environment](docs/Environment.md) +- [ErrorEffectProps](docs/ErrorEffectProps.md) +- [ErrorResponse](docs/ErrorResponse.md) +- [ErrorResponseWithStatus](docs/ErrorResponseWithStatus.md) +- [ErrorSource](docs/ErrorSource.md) +- [EvaluableCampaignIds](docs/EvaluableCampaignIds.md) +- [Event](docs/Event.md) +- [EventType](docs/EventType.md) +- [EventV2](docs/EventV2.md) +- [ExpiringCouponsNotificationPolicy](docs/ExpiringCouponsNotificationPolicy.md) +- [ExpiringCouponsNotificationTrigger](docs/ExpiringCouponsNotificationTrigger.md) +- [ExpiringPointsNotificationPolicy](docs/ExpiringPointsNotificationPolicy.md) +- [ExpiringPointsNotificationTrigger](docs/ExpiringPointsNotificationTrigger.md) +- [Export](docs/Export.md) +- [FeatureFlag](docs/FeatureFlag.md) +- [FeaturesFeed](docs/FeaturesFeed.md) +- [FuncArgDef](docs/FuncArgDef.md) +- [FunctionDef](docs/FunctionDef.md) +- [GenerateCampaignDescription](docs/GenerateCampaignDescription.md) +- [GenerateCampaignTags](docs/GenerateCampaignTags.md) +- [GenerateItemFilterDescription](docs/GenerateItemFilterDescription.md) +- [GenerateLoyaltyCard](docs/GenerateLoyaltyCard.md) +- [GenerateRuleTitle](docs/GenerateRuleTitle.md) +- [GenerateRuleTitleRule](docs/GenerateRuleTitleRule.md) +- [GetIntegrationCouponRequest](docs/GetIntegrationCouponRequest.md) +- [Giveaway](docs/Giveaway.md) +- [GiveawaysPool](docs/GiveawaysPool.md) +- [IdentifiableEntity](docs/IdentifiableEntity.md) +- [ImportEntity](docs/ImportEntity.md) +- [IncreaseAchievementProgressEffectProps](docs/IncreaseAchievementProgressEffectProps.md) +- [InlineResponse200](docs/InlineResponse200.md) +- [InlineResponse2001](docs/InlineResponse2001.md) +- [InlineResponse20010](docs/InlineResponse20010.md) +- [InlineResponse20011](docs/InlineResponse20011.md) +- [InlineResponse20012](docs/InlineResponse20012.md) +- [InlineResponse20013](docs/InlineResponse20013.md) +- [InlineResponse20014](docs/InlineResponse20014.md) +- [InlineResponse20015](docs/InlineResponse20015.md) +- [InlineResponse20016](docs/InlineResponse20016.md) +- [InlineResponse20017](docs/InlineResponse20017.md) +- [InlineResponse20018](docs/InlineResponse20018.md) +- [InlineResponse20019](docs/InlineResponse20019.md) +- [InlineResponse2002](docs/InlineResponse2002.md) +- [InlineResponse20020](docs/InlineResponse20020.md) +- [InlineResponse20021](docs/InlineResponse20021.md) +- [InlineResponse20022](docs/InlineResponse20022.md) +- [InlineResponse20023](docs/InlineResponse20023.md) +- [InlineResponse20024](docs/InlineResponse20024.md) +- [InlineResponse20025](docs/InlineResponse20025.md) +- [InlineResponse20026](docs/InlineResponse20026.md) +- [InlineResponse20027](docs/InlineResponse20027.md) +- [InlineResponse20028](docs/InlineResponse20028.md) +- [InlineResponse20029](docs/InlineResponse20029.md) +- [InlineResponse2003](docs/InlineResponse2003.md) +- [InlineResponse20030](docs/InlineResponse20030.md) +- [InlineResponse20031](docs/InlineResponse20031.md) +- [InlineResponse20032](docs/InlineResponse20032.md) +- [InlineResponse20033](docs/InlineResponse20033.md) +- [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) +- [InlineResponse20041](docs/InlineResponse20041.md) +- [InlineResponse20042](docs/InlineResponse20042.md) +- [InlineResponse20043](docs/InlineResponse20043.md) +- [InlineResponse20044](docs/InlineResponse20044.md) +- [InlineResponse20045](docs/InlineResponse20045.md) +- [InlineResponse20046](docs/InlineResponse20046.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) +- [IntegrationEventV2Request](docs/IntegrationEventV2Request.md) +- [IntegrationProfileEntity](docs/IntegrationProfileEntity.md) +- [IntegrationRequest](docs/IntegrationRequest.md) +- [IntegrationState](docs/IntegrationState.md) +- [IntegrationStateV2](docs/IntegrationStateV2.md) +- [IntegrationStoreEntity](docs/IntegrationStoreEntity.md) +- [InventoryCoupon](docs/InventoryCoupon.md) +- [InventoryReferral](docs/InventoryReferral.md) +- [ItemAttribute](docs/ItemAttribute.md) +- [LedgerEntry](docs/LedgerEntry.md) +- [LedgerInfo](docs/LedgerInfo.md) +- [LedgerPointsEntryIntegrationAPI](docs/LedgerPointsEntryIntegrationAPI.md) +- [LedgerTransactionLogEntryIntegrationAPI](docs/LedgerTransactionLogEntryIntegrationAPI.md) +- [LibraryAttribute](docs/LibraryAttribute.md) +- [LimitConfig](docs/LimitConfig.md) +- [LimitCounter](docs/LimitCounter.md) +- [ListCampaignStoreBudgets](docs/ListCampaignStoreBudgets.md) +- [ListCampaignStoreBudgetsStore](docs/ListCampaignStoreBudgetsStore.md) +- [LoginParams](docs/LoginParams.md) +- [Loyalty](docs/Loyalty.md) +- [LoyaltyBalance](docs/LoyaltyBalance.md) +- [LoyaltyBalanceWithTier](docs/LoyaltyBalanceWithTier.md) +- [LoyaltyBalances](docs/LoyaltyBalances.md) +- [LoyaltyBalancesWithTiers](docs/LoyaltyBalancesWithTiers.md) +- [LoyaltyCard](docs/LoyaltyCard.md) +- [LoyaltyCardBalances](docs/LoyaltyCardBalances.md) +- [LoyaltyCardBatch](docs/LoyaltyCardBatch.md) +- [LoyaltyCardBatchResponse](docs/LoyaltyCardBatchResponse.md) +- [LoyaltyCardProfileRegistration](docs/LoyaltyCardProfileRegistration.md) +- [LoyaltyCardRegistration](docs/LoyaltyCardRegistration.md) +- [LoyaltyDashboardData](docs/LoyaltyDashboardData.md) +- [LoyaltyDashboardPointsBreakdown](docs/LoyaltyDashboardPointsBreakdown.md) +- [LoyaltyLedger](docs/LoyaltyLedger.md) +- [LoyaltyLedgerEntry](docs/LoyaltyLedgerEntry.md) +- [LoyaltyLedgerTransactions](docs/LoyaltyLedgerTransactions.md) +- [LoyaltyMembership](docs/LoyaltyMembership.md) +- [LoyaltyProgram](docs/LoyaltyProgram.md) +- [LoyaltyProgramBalance](docs/LoyaltyProgramBalance.md) +- [LoyaltyProgramEntity](docs/LoyaltyProgramEntity.md) +- [LoyaltyProgramLedgers](docs/LoyaltyProgramLedgers.md) +- [LoyaltyProgramTransaction](docs/LoyaltyProgramTransaction.md) +- [LoyaltySubLedger](docs/LoyaltySubLedger.md) +- [LoyaltyTier](docs/LoyaltyTier.md) +- [ManagementKey](docs/ManagementKey.md) +- [ManagerConfig](docs/ManagerConfig.md) +- [MessageLogEntries](docs/MessageLogEntries.md) +- [MessageLogEntry](docs/MessageLogEntry.md) +- [MessageLogRequest](docs/MessageLogRequest.md) +- [MessageLogResponse](docs/MessageLogResponse.md) +- [Meta](docs/Meta.md) +- [ModelImport](docs/ModelImport.md) +- [ModelReturn](docs/ModelReturn.md) +- [MultiApplicationEntity](docs/MultiApplicationEntity.md) +- [MultipleAttribute](docs/MultipleAttribute.md) +- [MultipleAudiences](docs/MultipleAudiences.md) +- [MultipleAudiencesItem](docs/MultipleAudiencesItem.md) +- [MultipleCustomerProfileIntegrationRequest](docs/MultipleCustomerProfileIntegrationRequest.md) +- [MultipleCustomerProfileIntegrationRequestItem](docs/MultipleCustomerProfileIntegrationRequestItem.md) +- [MultipleCustomerProfileIntegrationResponseV2](docs/MultipleCustomerProfileIntegrationResponseV2.md) +- [MultipleNewAttribute](docs/MultipleNewAttribute.md) +- [MultipleNewAudiences](docs/MultipleNewAudiences.md) +- [MutableEntity](docs/MutableEntity.md) +- [NewAccount](docs/NewAccount.md) +- [NewAccountSignUp](docs/NewAccountSignUp.md) +- [NewAdditionalCost](docs/NewAdditionalCost.md) +- [NewAppWideCouponDeletionJob](docs/NewAppWideCouponDeletionJob.md) +- [NewApplication](docs/NewApplication.md) +- [NewApplicationAPIKey](docs/NewApplicationAPIKey.md) +- [NewApplicationCIF](docs/NewApplicationCIF.md) +- [NewApplicationCIFExpression](docs/NewApplicationCIFExpression.md) +- [NewAttribute](docs/NewAttribute.md) +- [NewAudience](docs/NewAudience.md) +- [NewBaseNotification](docs/NewBaseNotification.md) +- [NewCampaign](docs/NewCampaign.md) +- [NewCampaignCollection](docs/NewCampaignCollection.md) +- [NewCampaignEvaluationGroup](docs/NewCampaignEvaluationGroup.md) +- [NewCampaignGroup](docs/NewCampaignGroup.md) +- [NewCampaignSet](docs/NewCampaignSet.md) +- [NewCampaignStoreBudget](docs/NewCampaignStoreBudget.md) +- [NewCampaignStoreBudgetStoreLimit](docs/NewCampaignStoreBudgetStoreLimit.md) +- [NewCampaignTemplate](docs/NewCampaignTemplate.md) +- [NewCatalog](docs/NewCatalog.md) +- [NewCollection](docs/NewCollection.md) +- [NewCouponCreationJob](docs/NewCouponCreationJob.md) +- [NewCouponDeletionJob](docs/NewCouponDeletionJob.md) +- [NewCoupons](docs/NewCoupons.md) +- [NewCouponsForMultipleRecipients](docs/NewCouponsForMultipleRecipients.md) +- [NewCustomEffect](docs/NewCustomEffect.md) +- [NewCustomerProfile](docs/NewCustomerProfile.md) +- [NewCustomerSession](docs/NewCustomerSession.md) +- [NewCustomerSessionV2](docs/NewCustomerSessionV2.md) +- [NewEvent](docs/NewEvent.md) +- [NewEventType](docs/NewEventType.md) +- [NewExternalInvitation](docs/NewExternalInvitation.md) +- [NewGiveawaysPool](docs/NewGiveawaysPool.md) +- [NewInternalAudience](docs/NewInternalAudience.md) +- [NewInvitation](docs/NewInvitation.md) +- [NewInviteEmail](docs/NewInviteEmail.md) +- [NewLoyaltyProgram](docs/NewLoyaltyProgram.md) +- [NewLoyaltyTier](docs/NewLoyaltyTier.md) +- [NewManagementKey](docs/NewManagementKey.md) +- [NewMultipleAudiencesItem](docs/NewMultipleAudiencesItem.md) +- [NewNotificationTest](docs/NewNotificationTest.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) +- [NewRevisionVersion](docs/NewRevisionVersion.md) +- [NewRole](docs/NewRole.md) +- [NewRoleV2](docs/NewRoleV2.md) +- [NewRuleset](docs/NewRuleset.md) +- [NewSamlConnection](docs/NewSamlConnection.md) +- [NewStore](docs/NewStore.md) +- [NewTemplateDef](docs/NewTemplateDef.md) +- [NewUser](docs/NewUser.md) +- [NewWebhook](docs/NewWebhook.md) +- [Notification](docs/Notification.md) +- [NotificationActivation](docs/NotificationActivation.md) +- [NotificationListItem](docs/NotificationListItem.md) +- [NotificationTest](docs/NotificationTest.md) +- [OktaEvent](docs/OktaEvent.md) +- [OktaEventPayload](docs/OktaEventPayload.md) +- [OktaEventPayloadData](docs/OktaEventPayloadData.md) +- [OktaEventTarget](docs/OktaEventTarget.md) +- [OneTimeCode](docs/OneTimeCode.md) +- [OutgoingIntegrationBrazePolicy](docs/OutgoingIntegrationBrazePolicy.md) +- [OutgoingIntegrationCleverTapPolicy](docs/OutgoingIntegrationCleverTapPolicy.md) +- [OutgoingIntegrationConfiguration](docs/OutgoingIntegrationConfiguration.md) +- [OutgoingIntegrationIterablePolicy](docs/OutgoingIntegrationIterablePolicy.md) +- [OutgoingIntegrationMoEngagePolicy](docs/OutgoingIntegrationMoEngagePolicy.md) +- [OutgoingIntegrationTemplate](docs/OutgoingIntegrationTemplate.md) +- [OutgoingIntegrationTemplateWithConfigurationDetails](docs/OutgoingIntegrationTemplateWithConfigurationDetails.md) +- [OutgoingIntegrationTemplates](docs/OutgoingIntegrationTemplates.md) +- [OutgoingIntegrationType](docs/OutgoingIntegrationType.md) +- [OutgoingIntegrationTypes](docs/OutgoingIntegrationTypes.md) +- [PatchItemCatalogAction](docs/PatchItemCatalogAction.md) +- [PatchManyItemsCatalogAction](docs/PatchManyItemsCatalogAction.md) +- [PendingPointsNotificationPolicy](docs/PendingPointsNotificationPolicy.md) +- [Picklist](docs/Picklist.md) +- [Product](docs/Product.md) +- [ProductSearchMatch](docs/ProductSearchMatch.md) +- [ProductSkuUnitAnalytics](docs/ProductSkuUnitAnalytics.md) +- [ProductUnitAnalytics](docs/ProductUnitAnalytics.md) +- [ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md) +- [ProjectedTier](docs/ProjectedTier.md) +- [RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md) +- [Referral](docs/Referral.md) +- [ReferralConstraints](docs/ReferralConstraints.md) +- [ReferralCreatedEffectProps](docs/ReferralCreatedEffectProps.md) +- [ReferralRejectionReason](docs/ReferralRejectionReason.md) +- [RejectCouponEffectProps](docs/RejectCouponEffectProps.md) +- [RejectReferralEffectProps](docs/RejectReferralEffectProps.md) +- [RemoveFromAudienceEffectProps](docs/RemoveFromAudienceEffectProps.md) +- [RemoveItemCatalogAction](docs/RemoveItemCatalogAction.md) +- [RemoveManyItemsCatalogAction](docs/RemoveManyItemsCatalogAction.md) +- [ReopenSessionResponse](docs/ReopenSessionResponse.md) +- [ReserveCouponEffectProps](docs/ReserveCouponEffectProps.md) +- [ReturnIntegrationRequest](docs/ReturnIntegrationRequest.md) +- [ReturnedCartItem](docs/ReturnedCartItem.md) +- [Revision](docs/Revision.md) +- [RevisionActivation](docs/RevisionActivation.md) +- [RevisionVersion](docs/RevisionVersion.md) +- [Role](docs/Role.md) +- [RoleAssign](docs/RoleAssign.md) +- [RoleMembership](docs/RoleMembership.md) +- [RoleV2](docs/RoleV2.md) +- [RoleV2ApplicationDetails](docs/RoleV2ApplicationDetails.md) +- [RoleV2Base](docs/RoleV2Base.md) +- [RoleV2PermissionSet](docs/RoleV2PermissionSet.md) +- [RoleV2Permissions](docs/RoleV2Permissions.md) +- [RoleV2RolesGroup](docs/RoleV2RolesGroup.md) +- [RollbackAddedLoyaltyPointsEffectProps](docs/RollbackAddedLoyaltyPointsEffectProps.md) +- [RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md) +- [RollbackDeductedLoyaltyPointsEffectProps](docs/RollbackDeductedLoyaltyPointsEffectProps.md) +- [RollbackDiscountEffectProps](docs/RollbackDiscountEffectProps.md) +- [RollbackIncreasedAchievementProgressEffectProps](docs/RollbackIncreasedAchievementProgressEffectProps.md) +- [RollbackReferralEffectProps](docs/RollbackReferralEffectProps.md) +- [Rule](docs/Rule.md) +- [RuleFailureReason](docs/RuleFailureReason.md) +- [Ruleset](docs/Ruleset.md) +- [SSOConfig](docs/SSOConfig.md) +- [SamlConnection](docs/SamlConnection.md) +- [SamlConnectionInternal](docs/SamlConnectionInternal.md) +- [SamlConnectionMetadata](docs/SamlConnectionMetadata.md) +- [SamlLoginEndpoint](docs/SamlLoginEndpoint.md) +- [ScimBaseUser](docs/ScimBaseUser.md) +- [ScimBaseUserName](docs/ScimBaseUserName.md) +- [ScimNewUser](docs/ScimNewUser.md) +- [ScimPatchOperation](docs/ScimPatchOperation.md) +- [ScimPatchRequest](docs/ScimPatchRequest.md) +- [ScimResource](docs/ScimResource.md) +- [ScimResourceTypesListResponse](docs/ScimResourceTypesListResponse.md) +- [ScimSchemaResource](docs/ScimSchemaResource.md) +- [ScimSchemasListResponse](docs/ScimSchemasListResponse.md) +- [ScimServiceProviderConfigResponse](docs/ScimServiceProviderConfigResponse.md) +- [ScimServiceProviderConfigResponseBulk](docs/ScimServiceProviderConfigResponseBulk.md) +- [ScimServiceProviderConfigResponseChangePassword](docs/ScimServiceProviderConfigResponseChangePassword.md) +- [ScimServiceProviderConfigResponseFilter](docs/ScimServiceProviderConfigResponseFilter.md) +- [ScimServiceProviderConfigResponsePatch](docs/ScimServiceProviderConfigResponsePatch.md) +- [ScimServiceProviderConfigResponseSort](docs/ScimServiceProviderConfigResponseSort.md) +- [ScimUser](docs/ScimUser.md) +- [ScimUsersListResponse](docs/ScimUsersListResponse.md) +- [Session](docs/Session.md) +- [SetDiscountEffectProps](docs/SetDiscountEffectProps.md) +- [SetDiscountPerAdditionalCostEffectProps](docs/SetDiscountPerAdditionalCostEffectProps.md) +- [SetDiscountPerAdditionalCostPerItemEffectProps](docs/SetDiscountPerAdditionalCostPerItemEffectProps.md) +- [SetDiscountPerItemEffectProps](docs/SetDiscountPerItemEffectProps.md) +- [ShowBundleMetadataEffectProps](docs/ShowBundleMetadataEffectProps.md) +- [ShowNotificationEffectProps](docs/ShowNotificationEffectProps.md) +- [SlotDef](docs/SlotDef.md) +- [Store](docs/Store.md) +- [StrikethroughChangedItem](docs/StrikethroughChangedItem.md) +- [StrikethroughCustomEffectPerItemProps](docs/StrikethroughCustomEffectPerItemProps.md) +- [StrikethroughDebugResponse](docs/StrikethroughDebugResponse.md) +- [StrikethroughEffect](docs/StrikethroughEffect.md) +- [StrikethroughLabelingNotification](docs/StrikethroughLabelingNotification.md) +- [StrikethroughSetDiscountPerItemEffectProps](docs/StrikethroughSetDiscountPerItemEffectProps.md) +- [StrikethroughTrigger](docs/StrikethroughTrigger.md) +- [SummaryCampaignStoreBudget](docs/SummaryCampaignStoreBudget.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) +- [TierDowngradeNotificationPolicy](docs/TierDowngradeNotificationPolicy.md) +- [TierUpgradeNotificationPolicy](docs/TierUpgradeNotificationPolicy.md) +- [TierWillDowngradeNotificationPolicy](docs/TierWillDowngradeNotificationPolicy.md) +- [TierWillDowngradeNotificationTrigger](docs/TierWillDowngradeNotificationTrigger.md) +- [TimePoint](docs/TimePoint.md) +- [TrackEventV2Response](docs/TrackEventV2Response.md) +- [TransferLoyaltyCard](docs/TransferLoyaltyCard.md) +- [TriggerWebhookEffectProps](docs/TriggerWebhookEffectProps.md) +- [TwoFAConfig](docs/TwoFAConfig.md) +- [UpdateAccount](docs/UpdateAccount.md) +- [UpdateAchievement](docs/UpdateAchievement.md) +- [UpdateApplication](docs/UpdateApplication.md) +- [UpdateApplicationAPIKey](docs/UpdateApplicationAPIKey.md) +- [UpdateApplicationCIF](docs/UpdateApplicationCIF.md) +- [UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md) +- [UpdateAudience](docs/UpdateAudience.md) +- [UpdateCampaign](docs/UpdateCampaign.md) +- [UpdateCampaignCollection](docs/UpdateCampaignCollection.md) +- [UpdateCampaignEvaluationGroup](docs/UpdateCampaignEvaluationGroup.md) +- [UpdateCampaignGroup](docs/UpdateCampaignGroup.md) +- [UpdateCampaignTemplate](docs/UpdateCampaignTemplate.md) +- [UpdateCatalog](docs/UpdateCatalog.md) +- [UpdateCollection](docs/UpdateCollection.md) +- [UpdateCoupon](docs/UpdateCoupon.md) +- [UpdateCouponBatch](docs/UpdateCouponBatch.md) +- [UpdateLoyaltyCard](docs/UpdateLoyaltyCard.md) +- [UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md) +- [UpdateLoyaltyProgramTier](docs/UpdateLoyaltyProgramTier.md) +- [UpdatePicklist](docs/UpdatePicklist.md) +- [UpdateReferral](docs/UpdateReferral.md) +- [UpdateReferralBatch](docs/UpdateReferralBatch.md) +- [UpdateRole](docs/UpdateRole.md) +- [UpdateStore](docs/UpdateStore.md) +- [UpdateUser](docs/UpdateUser.md) +- [User](docs/User.md) +- [UserEntity](docs/UserEntity.md) +- [ValueMap](docs/ValueMap.md) +- [Webhook](docs/Webhook.md) +- [WebhookActivationLogEntry](docs/WebhookActivationLogEntry.md) +- [WebhookLogEntry](docs/WebhookLogEntry.md) +- [WebhookWithOutgoingIntegrationDetails](docs/WebhookWithOutgoingIntegrationDetails.md) +- [WillAwardGiveawayEffectProps](docs/WillAwardGiveawayEffectProps.md) + +## Authorization Authentication schemes defined for the API: - + ### api_key_v1 - **Type**: API key - **API key parameter name**: Authorization - **Location**: HTTP header - ### management_key - **Type**: API key - **API key parameter name**: Authorization - **Location**: HTTP header - ### manager_auth - **Type**: API key diff --git a/docs/Account.md b/docs/Account.md index 89a6f76..8d7ae83 100644 --- a/docs/Account.md +++ b/docs/Account.md @@ -1,6 +1,5 @@ # Account - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/AccountAdditionalCost.md b/docs/AccountAdditionalCost.md index 3250146..65bfe46 100644 --- a/docs/AccountAdditionalCost.md +++ b/docs/AccountAdditionalCost.md @@ -1,6 +1,5 @@ # AccountAdditionalCost - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Achievement.md b/docs/Achievement.md index fe8e4ab..c5de411 100644 --- a/docs/Achievement.md +++ b/docs/Achievement.md @@ -1,6 +1,5 @@ # Achievement - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -12,6 +11,10 @@ Name | Type | Description | Notes **target** | **float** | The required number of actions or the transactional milestone to complete the achievement. | **period** | **str** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | **period_end_override** | [**TimePoint**](TimePoint.md) | | [optional] +**recurrence_policy** | **str** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional] +**activation_policy** | **str** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional] +**fixed_start_date** | **datetime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional] +**end_date** | **datetime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional] **campaign_id** | **int** | ID of the campaign, to which the achievement belongs to | **user_id** | **int** | ID of the user that created this achievement. | **created_by** | **str** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. | diff --git a/docs/AchievementProgress.md b/docs/AchievementProgress.md index 987d64a..1a3e27b 100644 --- a/docs/AchievementProgress.md +++ b/docs/AchievementProgress.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes **achievement_id** | **int** | The internal ID of the achievement. | **name** | **str** | The internal name of the achievement used in API requests. | **title** | **str** | The display name of the achievement in the Campaign Manager. | +**description** | **str** | The description of the achievement in the Campaign Manager. | **campaign_id** | **int** | The ID of the campaign the achievement belongs to. | **status** | **str** | The status of the achievement. | **target** | **float** | The required number of actions or the transactional milestone to complete the achievement. | [optional] diff --git a/docs/AdditionalCampaignProperties.md b/docs/AdditionalCampaignProperties.md index 0916a83..85fd17e 100644 --- a/docs/AdditionalCampaignProperties.md +++ b/docs/AdditionalCampaignProperties.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes **created_by** | **str** | Name of the user who created this campaign if available. | [optional] **updated_by** | **str** | Name of the user who last updated this campaign if available. | [optional] **template_id** | **int** | The ID of the Campaign Template this Campaign was created from. | [optional] -**frontend_state** | **str** | A campaign state described exactly as in the Campaign Manager. | +**frontend_state** | **str** | The campaign state displayed in the Campaign Manager. | **stores_imported** | **bool** | Indicates whether the linked stores were imported via a CSV file. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AnalyticsProduct.md b/docs/AnalyticsProduct.md new file mode 100644 index 0000000..7be4a6b --- /dev/null +++ b/docs/AnalyticsProduct.md @@ -0,0 +1,13 @@ +# AnalyticsProduct + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | The ID of the analytics-level product. | +**is_preliminary** | **bool** | Indicates whether the analytics-level product is connected to a catalog and also has a product name. | +**name** | **str** | The name of the analytics-level product. | +**catalog_id** | **int** | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AnalyticsProductSKU.md b/docs/AnalyticsProductSKU.md new file mode 100644 index 0000000..2aa8fd5 --- /dev/null +++ b/docs/AnalyticsProductSKU.md @@ -0,0 +1,12 @@ +# AnalyticsProductSKU + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | The ID of the SKU linked to the analytics-level product. | +**sku** | **str** | The SKU linked to the analytics-level product. | +**last_updated** | **datetime** | Values in UTC for the date the SKU linked to the analytics-level product was last updated. | + +[[Back to Model list]](../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 60f07ab..2002066 100644 --- a/docs/Application.md +++ b/docs/Application.md @@ -1,6 +1,5 @@ # Application - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -23,6 +22,7 @@ Name | Type | Description | Notes **enable_partial_discounts** | **bool** | Indicates if this Application supports partial discounts. | [optional] **default_discount_additional_cost_per_item_scope** | **str** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional] **default_evaluation_group_id** | **int** | The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign. | [optional] +**default_cart_item_filter_id** | **int** | The ID of the default Cart-Item-Filter for this application. | [optional] **enable_campaign_state_management** | **bool** | Indicates whether the campaign staging and revisions feature is enabled for the Application. **Important:** After this feature is enabled, it cannot be disabled. | [optional] **loyalty_programs** | [**list[LoyaltyProgram]**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. | diff --git a/docs/ApplicationAPIKey.md b/docs/ApplicationAPIKey.md index 3da464a..bd5f08b 100644 --- a/docs/ApplicationAPIKey.md +++ b/docs/ApplicationAPIKey.md @@ -1,6 +1,5 @@ # ApplicationAPIKey - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ApplicationCIF.md b/docs/ApplicationCIF.md new file mode 100644 index 0000000..fb0db6d --- /dev/null +++ b/docs/ApplicationCIF.md @@ -0,0 +1,18 @@ +# ApplicationCIF + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | Internal ID of this entity. | +**created** | **datetime** | The time this entity was created. | +**name** | **str** | The name of the Application cart item filter used in API requests. | +**description** | **str** | A short description of the Application cart item filter. | [optional] +**active_expression_id** | **int** | The ID of the expression that the Application cart item filter uses. | [optional] +**modified_by** | **int** | The ID of the user who last updated the Application cart item filter. | [optional] +**created_by** | **int** | The ID of the user who created the Application cart item filter. | [optional] +**modified** | **datetime** | Timestamp of the most recent update to the Application cart item filter. | [optional] +**application_id** | **int** | The ID of the application that owns this entity. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApplicationCIFExpression.md b/docs/ApplicationCIFExpression.md new file mode 100644 index 0000000..6cd3f46 --- /dev/null +++ b/docs/ApplicationCIFExpression.md @@ -0,0 +1,15 @@ +# ApplicationCIFExpression + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | Internal ID of this entity. | +**created** | **datetime** | The time this entity was created. | +**cart_item_filter_id** | **int** | The ID of the Application cart item filter. | [optional] +**created_by** | **int** | The ID of the user who created the Application cart item filter. | [optional] +**expression** | **list[object]** | Arbitrary additional JSON data associated with the Application cart item filter. | [optional] +**application_id** | **int** | The ID of the application that owns this entity. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApplicationCampaignStats.md b/docs/ApplicationCampaignStats.md index fa55c40..76fc1be 100644 --- a/docs/ApplicationCampaignStats.md +++ b/docs/ApplicationCampaignStats.md @@ -5,6 +5,7 @@ Provides statistics regarding an application's campaigns. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **disabled** | **int** | Number of disabled campaigns. | +**staged** | **int** | Number of staged campaigns. | **scheduled** | **int** | Number of scheduled campaigns. | **running** | **int** | Number of running campaigns. | **expired** | **int** | Number of expired campaigns. | diff --git a/docs/ApplicationCustomer.md b/docs/ApplicationCustomer.md index 4540573..755ca4c 100644 --- a/docs/ApplicationCustomer.md +++ b/docs/ApplicationCustomer.md @@ -1,14 +1,13 @@ # ApplicationCustomer - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | Internal ID of this entity. Internal ID of this entity. | -**created** | **datetime** | The time this entity was created. The time this entity was created. The time this entity was created. The time this entity was created. | -**integration_id** | **str** | The integration ID set by your integration layer. The integration ID set by your integration layer. | +**id** | **int** | Internal ID of this entity. | +**created** | **datetime** | The time this entity was created. | +**integration_id** | **str** | The integration ID set by your integration layer. | **attributes** | [**object**](.md) | Arbitrary properties associated with this item. | -**account_id** | **int** | The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. | +**account_id** | **int** | The ID of the Talon.One account that owns this profile. | **closed_sessions** | **int** | The total amount of closed sessions by a customer. A closed session is a successful purchase. | **total_sales** | **float** | 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. | **loyalty_memberships** | [**list[LoyaltyMembership]**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional] diff --git a/docs/ApplicationEvent.md b/docs/ApplicationEvent.md index 5fa3de7..353c7d2 100644 --- a/docs/ApplicationEvent.md +++ b/docs/ApplicationEvent.md @@ -1,6 +1,5 @@ # ApplicationEvent - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ApplicationReferee.md b/docs/ApplicationReferee.md index ca30e5b..a9440f9 100644 --- a/docs/ApplicationReferee.md +++ b/docs/ApplicationReferee.md @@ -1,6 +1,5 @@ # ApplicationReferee - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ApplicationSession.md b/docs/ApplicationSession.md index 19a50d7..b2852ba 100644 --- a/docs/ApplicationSession.md +++ b/docs/ApplicationSession.md @@ -1,11 +1,10 @@ # ApplicationSession - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Internal ID of this entity. | -**created** | **datetime** | The time this entity was created. The time this entity was created. | +**created** | **datetime** | The time this entity was created. | **integration_id** | **str** | The integration ID set by your integration layer. | **store_integration_id** | **str** | The integration ID of the store. You choose this ID when you create a store. | [optional] **application_id** | **int** | The ID of the application that owns this entity. | diff --git a/docs/AsyncCouponDeletionJobResponse.md b/docs/AsyncCouponDeletionJobResponse.md index 50a23e2..d532390 100644 --- a/docs/AsyncCouponDeletionJobResponse.md +++ b/docs/AsyncCouponDeletionJobResponse.md @@ -1,6 +1,5 @@ # AsyncCouponDeletionJobResponse - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Attribute.md b/docs/Attribute.md index ca86c99..be2767d 100644 --- a/docs/Attribute.md +++ b/docs/Attribute.md @@ -1,6 +1,5 @@ # Attribute - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Audience.md b/docs/Audience.md index 00a9a26..a236aa0 100644 --- a/docs/Audience.md +++ b/docs/Audience.md @@ -1,6 +1,5 @@ # Audience - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/AudienceCustomer.md b/docs/AudienceCustomer.md index b17c4f9..86f8374 100644 --- a/docs/AudienceCustomer.md +++ b/docs/AudienceCustomer.md @@ -1,11 +1,10 @@ # AudienceCustomer - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Internal ID of this entity. | -**created** | **datetime** | The time this entity was created. The time this entity was created. | +**created** | **datetime** | The time this entity was created. | **integration_id** | **str** | The integration ID set by your integration layer. | **attributes** | [**object**](.md) | Arbitrary properties associated with this item. | **account_id** | **int** | The ID of the Talon.One account that owns this profile. | diff --git a/docs/BaseLoyaltyProgram.md b/docs/BaseLoyaltyProgram.md index 48c7b3c..a030169 100644 --- a/docs/BaseLoyaltyProgram.md +++ b/docs/BaseLoyaltyProgram.md @@ -17,6 +17,7 @@ Name | Type | Description | Notes **tiers_expire_in** | **str** | The amount of time after which the tier expires and is reevaluated. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years 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, months and years. Signifies the end of the day, week, month or year. | [optional] **tiers_downgrade_policy** | **str** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional] **card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**return_policy** | **str** | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. | [optional] [[Back to Model list]](../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 index e5af917..061b8e7 100644 --- a/docs/BaseNotification.md +++ b/docs/BaseNotification.md @@ -1,6 +1,5 @@ # BaseNotification - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/BaseNotificationWebhook.md b/docs/BaseNotificationWebhook.md index 7295479..6204739 100644 --- a/docs/BaseNotificationWebhook.md +++ b/docs/BaseNotificationWebhook.md @@ -1,6 +1,5 @@ # BaseNotificationWebhook - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/BulkOperationOnCampaigns.md b/docs/BulkOperationOnCampaigns.md index db0abd4..4079cda 100644 --- a/docs/BulkOperationOnCampaigns.md +++ b/docs/BulkOperationOnCampaigns.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | **str** | The operation to perform on the specified campaign IDs. | **campaign_ids** | **list[int]** | The list of campaign IDs on which the operation will be performed. | +**activate_at** | **datetime** | Timestamp when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank. **Note:** It must be an RFC3339 timestamp string. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Campaign.md b/docs/Campaign.md index 4cabb94..19b500d 100644 --- a/docs/Campaign.md +++ b/docs/Campaign.md @@ -1,6 +1,5 @@ # Campaign - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -44,8 +43,15 @@ Name | Type | Description | Notes **created_by** | **str** | Name of the user who created this campaign if available. | [optional] **updated_by** | **str** | Name of the user who last updated this campaign if available. | [optional] **template_id** | **int** | The ID of the Campaign Template this Campaign was created from. | [optional] -**frontend_state** | **str** | A campaign state described exactly as in the Campaign Manager. | +**frontend_state** | **str** | The campaign state displayed in the Campaign Manager. | **stores_imported** | **bool** | Indicates whether the linked stores were imported via a CSV file. | +**revision_frontend_state** | **str** | The campaign revision state displayed in the Campaign Manager. | [optional] +**active_revision_id** | **int** | ID of the revision that was last activated on this campaign. | [optional] +**active_revision_version_id** | **int** | ID of the revision version that is active on the campaign. | [optional] +**version** | **int** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. | [optional] +**current_revision_id** | **int** | ID of the revision currently being modified for the campaign. | [optional] +**current_revision_version_id** | **int** | ID of the latest version applied on the current revision. | [optional] +**stage_revision** | **bool** | Flag for determining whether we use current revision when sending requests with staging API key. | [optional] [default to False] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CampaignAnalytics.md b/docs/CampaignAnalytics.md index bcd8a05..9db5b2f 100644 --- a/docs/CampaignAnalytics.md +++ b/docs/CampaignAnalytics.md @@ -1,6 +1,5 @@ # CampaignAnalytics - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CampaignCollection.md b/docs/CampaignCollection.md index 6fa328d..69a14fc 100644 --- a/docs/CampaignCollection.md +++ b/docs/CampaignCollection.md @@ -1,6 +1,5 @@ # CampaignCollection - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CampaignCollectionWithoutPayload.md b/docs/CampaignCollectionWithoutPayload.md index 91aaac5..500da86 100644 --- a/docs/CampaignCollectionWithoutPayload.md +++ b/docs/CampaignCollectionWithoutPayload.md @@ -1,6 +1,5 @@ # CampaignCollectionWithoutPayload - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CampaignEvaluationGroup.md b/docs/CampaignEvaluationGroup.md index 2b45331..13e347c 100644 --- a/docs/CampaignEvaluationGroup.md +++ b/docs/CampaignEvaluationGroup.md @@ -1,6 +1,5 @@ # CampaignEvaluationGroup - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CampaignGroup.md b/docs/CampaignGroup.md index 4c6d1b0..a6ec1d4 100644 --- a/docs/CampaignGroup.md +++ b/docs/CampaignGroup.md @@ -1,6 +1,5 @@ # CampaignGroup - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CampaignSet.md b/docs/CampaignSet.md index c6536ad..499a75f 100644 --- a/docs/CampaignSet.md +++ b/docs/CampaignSet.md @@ -1,6 +1,5 @@ # CampaignSet - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CampaignStoreBudget.md b/docs/CampaignStoreBudget.md new file mode 100644 index 0000000..3f74d08 --- /dev/null +++ b/docs/CampaignStoreBudget.md @@ -0,0 +1,14 @@ +# CampaignStoreBudget + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | Internal ID of this entity. | +**created** | **datetime** | The time this entity was created. | +**campaign_id** | **int** | The ID of the campaign that owns this entity. | +**store_id** | **int** | The ID of the store. | +**limits** | [**list[LimitConfig]**](LimitConfig.md) | The set of budget limits for stores linked to the campaign. | + +[[Back to Model list]](../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 1dd971e..d59151e 100644 --- a/docs/CampaignTemplate.md +++ b/docs/CampaignTemplate.md @@ -1,6 +1,5 @@ # CampaignTemplate - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -18,6 +17,7 @@ Name | Type | Description | Notes **tags** | **list[str]** | A list of tags for the campaign template. | [optional] **features** | **list[str]** | A list of features for the campaign template. | [optional] **coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**coupon_reservation_settings** | [**CampaignTemplateCouponReservationSettings**](CampaignTemplateCouponReservationSettings.md) | | [optional] **referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **limits** | [**list[TemplateLimitConfig]**](TemplateLimitConfig.md) | The set of limits that operate for this campaign template. | [optional] **template_params** | [**list[CampaignTemplateParams]**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional] diff --git a/docs/CampaignTemplateCouponReservationSettings.md b/docs/CampaignTemplateCouponReservationSettings.md new file mode 100644 index 0000000..edc5ba2 --- /dev/null +++ b/docs/CampaignTemplateCouponReservationSettings.md @@ -0,0 +1,11 @@ +# CampaignTemplateCouponReservationSettings + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reservation_limit** | **int** | The number of reservations that can be made with this coupon code. | [optional] +**is_reservation_mandatory** | **bool** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] [default to False] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignVersions.md b/docs/CampaignVersions.md new file mode 100644 index 0000000..465fc86 --- /dev/null +++ b/docs/CampaignVersions.md @@ -0,0 +1,16 @@ +# CampaignVersions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**revision_frontend_state** | **str** | The campaign revision state displayed in the Campaign Manager. | [optional] +**active_revision_id** | **int** | ID of the revision that was last activated on this campaign. | [optional] +**active_revision_version_id** | **int** | ID of the revision version that is active on the campaign. | [optional] +**version** | **int** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. | [optional] +**current_revision_id** | **int** | ID of the revision currently being modified for the campaign. | [optional] +**current_revision_version_id** | **int** | ID of the latest version applied on the current revision. | [optional] +**stage_revision** | **bool** | Flag for determining whether we use current revision when sending requests with staging API key. | [optional] [default to False] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Catalog.md b/docs/Catalog.md index b37e82e..6c11b01 100644 --- a/docs/Catalog.md +++ b/docs/Catalog.md @@ -1,6 +1,5 @@ # Catalog - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogItem.md b/docs/CatalogItem.md index d9c219f..f572bbb 100644 --- a/docs/CatalogItem.md +++ b/docs/CatalogItem.md @@ -1,6 +1,5 @@ # CatalogItem - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Change.md b/docs/Change.md index 6ea4a37..d1fa9f1 100644 --- a/docs/Change.md +++ b/docs/Change.md @@ -1,6 +1,5 @@ # Change - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Collection.md b/docs/Collection.md index 9a80686..f163f4b 100644 --- a/docs/Collection.md +++ b/docs/Collection.md @@ -1,6 +1,5 @@ # Collection - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CollectionItem.md b/docs/CollectionItem.md index feebe04..b9826ae 100644 --- a/docs/CollectionItem.md +++ b/docs/CollectionItem.md @@ -1,6 +1,5 @@ # CollectionItem - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CollectionWithoutPayload.md b/docs/CollectionWithoutPayload.md index def0cf5..a00e0b1 100644 --- a/docs/CollectionWithoutPayload.md +++ b/docs/CollectionWithoutPayload.md @@ -1,6 +1,5 @@ # CollectionWithoutPayload - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Coupon.md b/docs/Coupon.md index 93e6606..9622b46 100644 --- a/docs/Coupon.md +++ b/docs/Coupon.md @@ -1,6 +1,5 @@ # Coupon - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CouponCreationJob.md b/docs/CouponCreationJob.md index 3a92f50..236274e 100644 --- a/docs/CouponCreationJob.md +++ b/docs/CouponCreationJob.md @@ -1,6 +1,5 @@ # CouponCreationJob - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CouponDeletionFilters.md b/docs/CouponDeletionFilters.md index f561217..e34eeb6 100644 --- a/docs/CouponDeletionFilters.md +++ b/docs/CouponDeletionFilters.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **redeemed** | **bool** | - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. **Note:** This field cannot be used in conjunction with the `usable` query parameter. | [optional] **recipient_integration_id** | **str** | Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. | [optional] **exact_match** | **bool** | Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to False] -**value** | **str** | Filter results by the coupon code | [optional] [default to 'false'] +**value** | **str** | Filter results by the coupon code | [optional] **batch_id** | **str** | Filter results by batches of coupons | [optional] **referral_id** | **int** | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional] **expires_after** | **datetime** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] diff --git a/docs/CouponDeletionJob.md b/docs/CouponDeletionJob.md index 733578a..c7ae6d2 100644 --- a/docs/CouponDeletionJob.md +++ b/docs/CouponDeletionJob.md @@ -1,6 +1,5 @@ # CouponDeletionJob - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateAchievement.md b/docs/CreateAchievement.md index 7af5908..f8c50cc 100644 --- a/docs/CreateAchievement.md +++ b/docs/CreateAchievement.md @@ -9,6 +9,10 @@ Name | Type | Description | Notes **target** | **float** | The required number of actions or the transactional milestone to complete the achievement. | **period** | **str** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | **period_end_override** | [**TimePoint**](TimePoint.md) | | [optional] +**recurrence_policy** | **str** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional] +**activation_policy** | **str** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional] +**fixed_start_date** | **datetime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional] +**end_date** | **datetime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CustomEffect.md b/docs/CustomEffect.md index 30326ff..2154e44 100644 --- a/docs/CustomEffect.md +++ b/docs/CustomEffect.md @@ -1,6 +1,5 @@ # CustomEffect - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CustomerProfile.md b/docs/CustomerProfile.md index ccaa080..7a61e61 100644 --- a/docs/CustomerProfile.md +++ b/docs/CustomerProfile.md @@ -1,11 +1,10 @@ # CustomerProfile - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Internal ID of this entity. | -**created** | **datetime** | The time this entity was created. The time this entity was created. | +**created** | **datetime** | The time this entity was created. | **integration_id** | **str** | The integration ID set by your integration layer. | **attributes** | [**object**](.md) | Arbitrary properties associated with this item. | **account_id** | **int** | The ID of the Talon.One account that owns this profile. | diff --git a/docs/CustomerProfileAudienceRequestItem.md b/docs/CustomerProfileAudienceRequestItem.md index 20ae917..7a4a9cb 100644 --- a/docs/CustomerProfileAudienceRequestItem.md +++ b/docs/CustomerProfileAudienceRequestItem.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**action** | **str** | Defines the action to perform: - `add`: Adds the customer profile to the audience. If the customer profile does not exist, it will be created. - `delete`: Removes the customer profile from the audience. | +**action** | **str** | Defines the action to perform: - `add`: Adds the customer profile to the audience. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `delete`: Removes the customer profile from the audience. | **profile_integration_id** | **str** | The ID of this customer profile in the third-party integration. | **audience_id** | **int** | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). | diff --git a/docs/CustomerProfileIntegrationRequestV2.md b/docs/CustomerProfileIntegrationRequestV2.md index ef82eb2..8b94230 100644 --- a/docs/CustomerProfileIntegrationRequestV2.md +++ b/docs/CustomerProfileIntegrationRequestV2.md @@ -1,6 +1,6 @@ # CustomerProfileIntegrationRequestV2 - +The body of a V2 integration API request (customer profile update). Next to the customer profile details, this contains an optional listing of extra properties that should be returned in the response. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CustomerSession.md b/docs/CustomerSession.md index affe3ee..3ae36de 100644 --- a/docs/CustomerSession.md +++ b/docs/CustomerSession.md @@ -1,6 +1,5 @@ # CustomerSession - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CustomerSessionV2.md b/docs/CustomerSessionV2.md index 43e266e..7f8bb28 100644 --- a/docs/CustomerSessionV2.md +++ b/docs/CustomerSessionV2.md @@ -1,29 +1,30 @@ # CustomerSessionV2 - +The representation of the customer session. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Internal ID of this entity. | -**created** | **datetime** | The time this entity was created. The time this entity was created. | +**created** | **datetime** | The time this entity was created. | **integration_id** | **str** | The integration ID set by your integration layer. | **application_id** | **int** | The ID of the application that owns this entity. | **profile_id** | **str** | 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`. | **store_integration_id** | **str** | The integration ID of the store. You choose this ID when you create a store. | [optional] **evaluable_campaign_ids** | **list[int]** | 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] -**coupon_codes** | **list[str]** | 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] -**referral_code** | **str** | 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] +**coupon_codes** | **list[str]** | Any coupon codes entered. **Important - for requests only**: - 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. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, omit the parameter entirely. | [optional] +**referral_code** | **str** | Any referral code entered. **Important - for requests only**: - 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. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, omit the parameter entirely. | [optional] **loyalty_cards** | **list[str]** | Identifier of a loyalty card. | [optional] **state** | **str** | 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-sessions). | [default to 'open'] **cart_items** | [**list[CartItem]**](CartItem.md) | The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. | **additional_costs** | [**dict(str, 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** | **list[str]** | 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] +**identifiers** | **list[str]** | 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). - We recommend passing an anonymized (hashed) version of the identifier value. | [optional] **attributes** | [**object**](.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. | -**first_session** | **bool** | Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. | +**first_session** | **bool** | Indicates whether this is the first session for the customer's profile. It's always `true` for anonymous sessions. | **total** | **float** | The total value of cart items and additional costs in the session, before any discounts are applied. | **cart_item_total** | **float** | The total value of cart items, before any discounts are applied. | **additional_cost_total** | **float** | The total value of additional costs, before any discounts are applied. | **updated** | **datetime** | Timestamp of the most recent event received on this session. | +**closure_prediction** | **float** | The likelihood of the customer session closing based on predictive modeling, expressed as a decimal between `0` and `1`. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/DeactivateUserRequest.md b/docs/DeactivateUserRequest.md index 53b3717..e880cc4 100644 --- a/docs/DeactivateUserRequest.md +++ b/docs/DeactivateUserRequest.md @@ -1,6 +1,5 @@ # DeactivateUserRequest - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Effect.md b/docs/Effect.md index 4a7d2a9..223e895 100644 --- a/docs/Effect.md +++ b/docs/Effect.md @@ -1,6 +1,6 @@ # Effect - +A generic effect that is fired by a triggered campaign. The props property will contain information specific to the specific effect type. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -14,6 +14,8 @@ Name | Type | Description | Notes **condition_index** | **int** | The index of the condition that was triggered. | [optional] **evaluation_group_id** | **int** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] **evaluation_group_mode** | **str** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] +**campaign_revision_id** | **int** | The revision ID of the campaign that was used when triggering the effect. | [optional] +**campaign_revision_version_id** | **int** | The revision version ID of the campaign that was used when triggering the effect. | [optional] **props** | [**object**](.md) | The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/EffectEntity.md b/docs/EffectEntity.md index 4139325..7868632 100644 --- a/docs/EffectEntity.md +++ b/docs/EffectEntity.md @@ -14,6 +14,8 @@ Name | Type | Description | Notes **condition_index** | **int** | The index of the condition that was triggered. | [optional] **evaluation_group_id** | **int** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] **evaluation_group_mode** | **str** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] +**campaign_revision_id** | **int** | The revision ID of the campaign that was used when triggering the effect. | [optional] +**campaign_revision_version_id** | **int** | The revision version ID of the campaign that was used when triggering the effect. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Environment.md b/docs/Environment.md index 13702fc..4822bb0 100644 --- a/docs/Environment.md +++ b/docs/Environment.md @@ -1,6 +1,5 @@ # Environment - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -18,6 +17,7 @@ Name | Type | Description | Notes **additional_costs** | [**list[AccountAdditionalCost]**](AccountAdditionalCost.md) | The additional costs that the application is subscribed to. | [optional] **audiences** | [**list[Audience]**](Audience.md) | The audiences contained in the account which the application belongs to. | [optional] **collections** | [**list[Collection]**](Collection.md) | The account-level collections that the application is subscribed to. | [optional] +**application_cart_item_filters** | [**list[ApplicationCIF]**](ApplicationCIF.md) | The cart item filters belonging to the Application. | [optional] [[Back to Model list]](../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 889511c..076d58e 100644 --- a/docs/Event.md +++ b/docs/Event.md @@ -1,6 +1,5 @@ # Event - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/EventType.md b/docs/EventType.md index d301cdf..3c77546 100644 --- a/docs/EventType.md +++ b/docs/EventType.md @@ -1,6 +1,5 @@ # EventType - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/EventV2.md b/docs/EventV2.md index dd6ba9e..5445be1 100644 --- a/docs/EventV2.md +++ b/docs/EventV2.md @@ -1,6 +1,5 @@ # EventV2 - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Export.md b/docs/Export.md index 9819a8e..ef43173 100644 --- a/docs/Export.md +++ b/docs/Export.md @@ -1,6 +1,5 @@ # Export - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FeaturesFeed.md b/docs/FeaturesFeed.md index 06b80f7..fd9e6cc 100644 --- a/docs/FeaturesFeed.md +++ b/docs/FeaturesFeed.md @@ -1,6 +1,5 @@ # FeaturesFeed - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/GenerateCampaignDescription.md b/docs/GenerateCampaignDescription.md index e04b286..83f83b9 100644 --- a/docs/GenerateCampaignDescription.md +++ b/docs/GenerateCampaignDescription.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**campaign_id** | **int** | ID of the campaign. | +**ruleset_id** | **int** | ID of a ruleset. | **currency** | **str** | Currency for the campaign. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GenerateCampaignTags.md b/docs/GenerateCampaignTags.md index 1d6ed56..9f3bdad 100644 --- a/docs/GenerateCampaignTags.md +++ b/docs/GenerateCampaignTags.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**campaign_id** | **int** | ID of the campaign. | +**ruleset_id** | **int** | ID of a ruleset. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GenerateLoyaltyCard.md b/docs/GenerateLoyaltyCard.md index 889f4dd..06e6923 100644 --- a/docs/GenerateLoyaltyCard.md +++ b/docs/GenerateLoyaltyCard.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **status** | **str** | Status of the loyalty card. | [optional] [default to 'active'] **customer_profile_ids** | **list[str]** | Integration IDs of the customer profiles linked to the card. | [optional] +**card_identifier** | **str** | The alphanumeric identifier of the loyalty card. | [optional] [[Back to Model list]](../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 3143894..347472a 100644 --- a/docs/Giveaway.md +++ b/docs/Giveaway.md @@ -1,6 +1,5 @@ # Giveaway - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/InlineResponse20020.md b/docs/InlineResponse20020.md index 2734a09..c100c38 100644 --- a/docs/InlineResponse20020.md +++ b/docs/InlineResponse20020.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_result_size** | **int** | | -**data** | [**list[AccessLogEntry]**](AccessLogEntry.md) | | +**data** | [**list[CampaignAnalytics]**](CampaignAnalytics.md) | | [[Back to Model list]](../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 e5a8135..7a4b57c 100644 --- a/docs/InlineResponse20021.md +++ b/docs/InlineResponse20021.md @@ -3,8 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total_result_size** | **int** | | -**data** | [**list[CampaignAnalytics]**](CampaignAnalytics.md) | | +**total_result_size** | **int** | | [optional] +**has_more** | **bool** | | [optional] +**data** | [**list[ApplicationCustomer]**](ApplicationCustomer.md) | | [[Back to Model list]](../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 ee336d5..7ca8d4d 100644 --- a/docs/InlineResponse20022.md +++ b/docs/InlineResponse20022.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total_result_size** | **int** | | [optional] **has_more** | **bool** | | [optional] +**total_result_size** | **int** | | [optional] **data** | [**list[ApplicationCustomer]**](ApplicationCustomer.md) | | [[Back to Model list]](../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 68e75c8..ed1fc42 100644 --- a/docs/InlineResponse20023.md +++ b/docs/InlineResponse20023.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **has_more** | **bool** | | [optional] **total_result_size** | **int** | | [optional] -**data** | [**list[ApplicationCustomer]**](ApplicationCustomer.md) | | +**data** | [**list[CustomerProfile]**](CustomerProfile.md) | | [[Back to Model list]](../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 39ea162..62b1d3b 100644 --- a/docs/InlineResponse20024.md +++ b/docs/InlineResponse20024.md @@ -3,8 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**has_more** | **bool** | | [optional] -**total_result_size** | **int** | | [optional] +**has_more** | **bool** | | **data** | [**list[CustomerProfile]**](CustomerProfile.md) | | [[Back to Model list]](../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 7aac1b7..a2fa9dd 100644 --- a/docs/InlineResponse20025.md +++ b/docs/InlineResponse20025.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **has_more** | **bool** | | -**data** | [**list[CustomerProfile]**](CustomerProfile.md) | | +**data** | [**list[CustomerActivityReport]**](CustomerActivityReport.md) | | [[Back to Model list]](../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 67174d9..3eecc83 100644 --- a/docs/InlineResponse20026.md +++ b/docs/InlineResponse20026.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**has_more** | **bool** | | -**data** | [**list[CustomerActivityReport]**](CustomerActivityReport.md) | | +**has_more** | **bool** | | [optional] +**data** | [**list[ApplicationSession]**](ApplicationSession.md) | | [[Back to Model list]](../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 837ba0c..284e9ce 100644 --- a/docs/InlineResponse20027.md +++ b/docs/InlineResponse20027.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**has_more** | **bool** | | [optional] -**data** | [**list[ApplicationSession]**](ApplicationSession.md) | | +**has_more** | **bool** | | +**data** | [**list[ApplicationEvent]**](ApplicationEvent.md) | | [[Back to Model list]](../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 5991ab3..da5d9a4 100644 --- a/docs/InlineResponse20028.md +++ b/docs/InlineResponse20028.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**has_more** | **bool** | | -**data** | [**list[ApplicationEvent]**](ApplicationEvent.md) | | +**total_result_size** | **int** | | +**data** | **list[str]** | | [[Back to Model list]](../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 b52a1e6..1b17c5a 100644 --- a/docs/InlineResponse20029.md +++ b/docs/InlineResponse20029.md @@ -3,8 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total_result_size** | **int** | | -**data** | **list[str]** | | +**has_more** | **bool** | | [optional] +**total_result_size** | **int** | | [optional] +**data** | [**list[Audience]**](Audience.md) | | [[Back to Model list]](../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 bd81dc5..685e5c0 100644 --- a/docs/InlineResponse20030.md +++ b/docs/InlineResponse20030.md @@ -4,8 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **has_more** | **bool** | | [optional] -**total_result_size** | **int** | | [optional] -**data** | [**list[Audience]**](Audience.md) | | +**data** | [**list[AudienceAnalytics]**](AudienceAnalytics.md) | | [[Back to Model list]](../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 8ee7cf5..d3582d6 100644 --- a/docs/InlineResponse20031.md +++ b/docs/InlineResponse20031.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **has_more** | **bool** | | [optional] -**data** | [**list[AudienceAnalytics]**](AudienceAnalytics.md) | | +**data** | [**list[CustomerProfile]**](CustomerProfile.md) | | [[Back to Model list]](../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 08957e4..f79bbad 100644 --- a/docs/InlineResponse20032.md +++ b/docs/InlineResponse20032.md @@ -4,7 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **has_more** | **bool** | | [optional] -**data** | [**list[CustomerProfile]**](CustomerProfile.md) | | +**total_result_size** | **int** | | [optional] +**data** | [**list[ApplicationReferee]**](ApplicationReferee.md) | | [[Back to Model list]](../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 22769ba..7b393e9 100644 --- a/docs/InlineResponse20033.md +++ b/docs/InlineResponse20033.md @@ -3,9 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**has_more** | **bool** | | [optional] -**total_result_size** | **int** | | [optional] -**data** | [**list[ApplicationReferee]**](ApplicationReferee.md) | | +**total_result_size** | **int** | | +**data** | [**list[Attribute]**](Attribute.md) | | [[Back to Model list]](../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 467d773..a415ef4 100644 --- a/docs/InlineResponse20034.md +++ b/docs/InlineResponse20034.md @@ -3,8 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total_result_size** | **int** | | -**data** | [**list[Attribute]**](Attribute.md) | | +**has_more** | **bool** | | [optional] +**total_result_size** | **int** | | [optional] +**data** | [**list[CatalogItem]**](CatalogItem.md) | | [[Back to Model list]](../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 index a2c96c9..c4a4b94 100644 --- a/docs/InlineResponse20035.md +++ b/docs/InlineResponse20035.md @@ -3,9 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**has_more** | **bool** | | [optional] -**total_result_size** | **int** | | [optional] -**data** | [**list[CatalogItem]**](CatalogItem.md) | | +**total_result_size** | **int** | | +**data** | [**list[AccountAdditionalCost]**](AccountAdditionalCost.md) | | [[Back to Model list]](../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 index e430457..9c402dc 100644 --- a/docs/InlineResponse20036.md +++ b/docs/InlineResponse20036.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_result_size** | **int** | | -**data** | [**list[AccountAdditionalCost]**](AccountAdditionalCost.md) | | +**data** | [**list[WebhookWithOutgoingIntegrationDetails]**](WebhookWithOutgoingIntegrationDetails.md) | | [[Back to Model list]](../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 index 038f709..3a69182 100644 --- a/docs/InlineResponse20037.md +++ b/docs/InlineResponse20037.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_result_size** | **int** | | -**data** | [**list[WebhookWithOutgoingIntegrationDetails]**](WebhookWithOutgoingIntegrationDetails.md) | | +**data** | [**list[WebhookActivationLogEntry]**](WebhookActivationLogEntry.md) | | [[Back to Model list]](../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 index 21cbe23..e843a91 100644 --- a/docs/InlineResponse20038.md +++ b/docs/InlineResponse20038.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_result_size** | **int** | | -**data** | [**list[WebhookActivationLogEntry]**](WebhookActivationLogEntry.md) | | +**data** | [**list[WebhookLogEntry]**](WebhookLogEntry.md) | | [[Back to Model list]](../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 index 4ca7712..2fc39fa 100644 --- a/docs/InlineResponse20039.md +++ b/docs/InlineResponse20039.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_result_size** | **int** | | -**data** | [**list[WebhookLogEntry]**](WebhookLogEntry.md) | | +**data** | [**list[EventType]**](EventType.md) | | [[Back to Model list]](../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 index 691a956..36951d5 100644 --- a/docs/InlineResponse20040.md +++ b/docs/InlineResponse20040.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_result_size** | **int** | | -**data** | [**list[EventType]**](EventType.md) | | +**data** | [**list[User]**](User.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20041.md b/docs/InlineResponse20041.md index b206173..e3407d8 100644 --- a/docs/InlineResponse20041.md +++ b/docs/InlineResponse20041.md @@ -3,8 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total_result_size** | **int** | | -**data** | [**list[User]**](User.md) | | +**total_result_size** | **int** | | [optional] +**has_more** | **bool** | | [optional] +**data** | [**list[Change]**](Change.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20042.md b/docs/InlineResponse20042.md index ef31ca5..4891598 100644 --- a/docs/InlineResponse20042.md +++ b/docs/InlineResponse20042.md @@ -3,9 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total_result_size** | **int** | | [optional] -**has_more** | **bool** | | [optional] -**data** | [**list[Change]**](Change.md) | | +**total_result_size** | **int** | | +**data** | [**list[Export]**](Export.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20043.md b/docs/InlineResponse20043.md index c01e742..8d6163d 100644 --- a/docs/InlineResponse20043.md +++ b/docs/InlineResponse20043.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_result_size** | **int** | | -**data** | [**list[Export]**](Export.md) | | +**data** | [**list[RoleV2]**](RoleV2.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20044.md b/docs/InlineResponse20044.md index 325bb5e..188aa0f 100644 --- a/docs/InlineResponse20044.md +++ b/docs/InlineResponse20044.md @@ -3,8 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total_result_size** | **int** | | -**data** | [**list[RoleV2]**](RoleV2.md) | | +**has_more** | **bool** | | [optional] +**total_result_size** | **int** | | [optional] +**data** | [**list[Store]**](Store.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20045.md b/docs/InlineResponse20045.md index eb0db8d..e3c9b04 100644 --- a/docs/InlineResponse20045.md +++ b/docs/InlineResponse20045.md @@ -4,8 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **has_more** | **bool** | | [optional] -**total_result_size** | **int** | | [optional] -**data** | [**list[Store]**](Store.md) | | +**data** | [**list[Achievement]**](Achievement.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20046.md b/docs/InlineResponse20046.md index bc4001b..e980ca6 100644 --- a/docs/InlineResponse20046.md +++ b/docs/InlineResponse20046.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**has_more** | **bool** | | [optional] -**data** | [**list[Achievement]**](Achievement.md) | | +**has_more** | **bool** | | +**data** | [**list[AchievementProgress]**](AchievementProgress.md) | | [[Back to Model list]](../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 f9c8062..4276339 100644 --- a/docs/IntegrationApi.md +++ b/docs/IntegrationApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description [**generate_loyalty_card**](IntegrationApi.md#generate_loyalty_card) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card [**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | List customer data [**get_customer_session**](IntegrationApi.md#get_customer_session) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session -[**get_loyalty_balances**](IntegrationApi.md#get_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty points +[**get_loyalty_balances**](IntegrationApi.md#get_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty balances [**get_loyalty_card_balances**](IntegrationApi.md#get_loyalty_card_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances | Get card's point balances [**get_loyalty_card_points**](IntegrationApi.md#get_loyalty_card_points) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points | List card's unused loyalty points [**get_loyalty_card_transactions**](IntegrationApi.md#get_loyalty_card_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions | List card's transactions @@ -120,7 +120,7 @@ Name | Type | Description | Notes Create coupon reservation -Create a coupon reservation for the 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). - If the **Reservation mandatory** option was selected when creating the specified coupon, the endpoint creates a **hard** reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a **soft** reservation, meaning the coupon will be associated with the specified customer profiles (they show up when using the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint), but any user can redeem it. This can be useful, for example, to display a _coupon wallet_ for customers when they visit your store. - If the **Coupon visibility** option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. +Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect. **Note:** - If the **Reservation mandatory** option was selected when creating the specified coupon, the endpoint creates a **hard** reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a **soft** reservation, meaning the coupon is associated with the specified customer profiles (they show up when using the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint), but any user can redeem it. This can be useful, for example, to display a _coupon wallet_ for customers when they visit your store. - If the **Coupon visibility** option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. - This endpoint overrides the coupon reservation limit set when [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons). To ensure that coupons cannot be reserved after the reservation limit is reached, use the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect in the Rule Builder and the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. ### Example @@ -601,7 +601,7 @@ void (empty response body) Delete customer's personal data -Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. +Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. ### Example @@ -928,9 +928,9 @@ Name | Type | Description | Notes # **get_loyalty_balances** > LoyaltyBalancesWithTiers get_loyalty_balances(loyalty_program_id, integration_id, end_date=end_date, subledger_id=subledger_id, include_tiers=include_tiers, include_projected_tier=include_projected_tier) -Get customer's loyalty points +Get customer's loyalty balances -Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID. **Note**: 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. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data) +Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: 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. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data) ### Example @@ -971,10 +971,10 @@ integration_id = 'integration_id_example' # str | The integration identifier for end_date = '2013-10-20T19:20:30+01:00' # datetime | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional) subledger_id = 'subledger_id_example' # str | The ID of the subledger by which we filter the data. (optional) include_tiers = False # bool | Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. (optional) (default to False) -include_projected_tier = False # bool | Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer’s active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional) (default to False) +include_projected_tier = False # bool | Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. (optional) (default to False) try: - # Get customer's loyalty points + # Get customer's loyalty balances api_response = api_instance.get_loyalty_balances(loyalty_program_id, integration_id, end_date=end_date, subledger_id=subledger_id, include_tiers=include_tiers, include_projected_tier=include_projected_tier) pprint(api_response) except ApiException as e: @@ -990,7 +990,7 @@ Name | Type | Description | Notes **end_date** | **datetime**| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] **subledger_id** | **str**| The ID of the subledger by which we filter the data. | [optional] **include_tiers** | **bool**| Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. | [optional] [default to False] - **include_projected_tier** | **bool**| Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer’s active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. | [optional] [default to False] + **include_projected_tier** | **bool**| Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. | [optional] [default to False] ### Return type @@ -2411,7 +2411,7 @@ with talon_one.ApiClient(configuration) as api_client: api_instance = talon_one.IntegrationApi(api_client) customer_session_id = 'customer_session_id_example' # str | 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. body = talon_one.IntegrationRequest() # IntegrationRequest | body -dry = True # bool | Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). (optional) +dry = True # bool | Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). (optional) now = '2013-10-20T19:20:30+01:00' # datetime | A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`. (optional) try: @@ -2428,7 +2428,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **customer_session_id** | **str**| 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. | **body** | [**IntegrationRequest**](IntegrationRequest.md)| body | - **dry** | **bool**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). | [optional] + **dry** | **bool**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). | [optional] **now** | **datetime**| A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`. | [optional] ### Return type diff --git a/docs/IntegrationCoupon.md b/docs/IntegrationCoupon.md index ad05149..a3009ea 100644 --- a/docs/IntegrationCoupon.md +++ b/docs/IntegrationCoupon.md @@ -1,6 +1,5 @@ # IntegrationCoupon - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/IntegrationCustomerSessionResponse.md b/docs/IntegrationCustomerSessionResponse.md index 48b83de..09d1a6d 100644 --- a/docs/IntegrationCustomerSessionResponse.md +++ b/docs/IntegrationCustomerSessionResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **customer_session** | [**CustomerSessionV2**](CustomerSessionV2.md) | | [optional] -**effects** | [**list[Effect]**](Effect.md) | | [optional] +**effects** | [**list[Effect]**](Effect.md) | The returned effects. **Note:** This endpoint returns only the effects that are valid after any rollback effects and their corresponding non-rollback effects are removed. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/IntegrationEvent.md b/docs/IntegrationEvent.md index a04c5af..944dffd 100644 --- a/docs/IntegrationEvent.md +++ b/docs/IntegrationEvent.md @@ -1,6 +1,5 @@ # IntegrationEvent - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/IntegrationEventV2Request.md b/docs/IntegrationEventV2Request.md index 10186bf..8eeaa4f 100644 --- a/docs/IntegrationEventV2Request.md +++ b/docs/IntegrationEventV2Request.md @@ -1,6 +1,5 @@ # IntegrationEventV2Request - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/InventoryCoupon.md b/docs/InventoryCoupon.md index a885e06..bde3d33 100644 --- a/docs/InventoryCoupon.md +++ b/docs/InventoryCoupon.md @@ -1,6 +1,5 @@ # InventoryCoupon - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/InventoryReferral.md b/docs/InventoryReferral.md index 63710a9..a25d32d 100644 --- a/docs/InventoryReferral.md +++ b/docs/InventoryReferral.md @@ -1,6 +1,5 @@ # InventoryReferral - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ItemAttribute.md b/docs/ItemAttribute.md index 0623749..035b3c3 100644 --- a/docs/ItemAttribute.md +++ b/docs/ItemAttribute.md @@ -1,6 +1,5 @@ # ItemAttribute - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/LedgerEntry.md b/docs/LedgerEntry.md index 30a6b17..3dbaa7b 100644 --- a/docs/LedgerEntry.md +++ b/docs/LedgerEntry.md @@ -1,6 +1,6 @@ # LedgerEntry - +Entry in the point ledger. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/LedgerInfo.md b/docs/LedgerInfo.md index 71e6fc4..3519f95 100644 --- a/docs/LedgerInfo.md +++ b/docs/LedgerInfo.md @@ -1,6 +1,6 @@ # LedgerInfo - +The balance in a Loyalty Program for some Customer. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -8,8 +8,8 @@ Name | Type | Description | Notes **pending_balance** | **float** | Sum of pending points. | **expired_balance** | **float** | **DEPRECATED** Value is shown as 0. | **spent_balance** | **float** | **DEPRECATED** Value is shown as 0. | -**tentative_current_balance** | **float** | 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. | -**tentative_pending_balance** | **float** | 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] +**tentative_current_balance** | **float** | The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. | +**tentative_pending_balance** | **float** | The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. | [optional] **current_tier** | [**Tier**](Tier.md) | | [optional] **points_to_next_tier** | **float** | Points required to move up a tier. | [optional] diff --git a/docs/LibraryAttribute.md b/docs/LibraryAttribute.md index e57c54e..943da1c 100644 --- a/docs/LibraryAttribute.md +++ b/docs/LibraryAttribute.md @@ -1,6 +1,5 @@ # LibraryAttribute - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/LimitCounter.md b/docs/LimitCounter.md index a724d23..b4a2e18 100644 --- a/docs/LimitCounter.md +++ b/docs/LimitCounter.md @@ -1,6 +1,5 @@ # LimitCounter - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ListCampaignStoreBudgets.md b/docs/ListCampaignStoreBudgets.md new file mode 100644 index 0000000..11b8f80 --- /dev/null +++ b/docs/ListCampaignStoreBudgets.md @@ -0,0 +1,13 @@ +# ListCampaignStoreBudgets + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**store** | [**ListCampaignStoreBudgetsStore**](ListCampaignStoreBudgetsStore.md) | | +**limit** | **int** | | +**action** | **str** | | +**period** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ListCampaignStoreBudgetsStore.md b/docs/ListCampaignStoreBudgetsStore.md new file mode 100644 index 0000000..70c340a --- /dev/null +++ b/docs/ListCampaignStoreBudgetsStore.md @@ -0,0 +1,12 @@ +# ListCampaignStoreBudgetsStore + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | +**integration_id** | **str** | | +**name** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoginParams.md b/docs/LoginParams.md index d415f6d..749ea05 100644 --- a/docs/LoginParams.md +++ b/docs/LoginParams.md @@ -1,6 +1,5 @@ # LoginParams - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/LoyaltyBalanceWithTier.md b/docs/LoyaltyBalanceWithTier.md index 0c4bbca..7c583a8 100644 --- a/docs/LoyaltyBalanceWithTier.md +++ b/docs/LoyaltyBalanceWithTier.md @@ -1,6 +1,6 @@ # LoyaltyBalanceWithTier - +Point balance of a ledger in the Loyalty Program. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/LoyaltyCard.md b/docs/LoyaltyCard.md index 228c5ec..d86ccfb 100644 --- a/docs/LoyaltyCard.md +++ b/docs/LoyaltyCard.md @@ -1,12 +1,13 @@ # LoyaltyCard - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Internal ID of this entity. | **created** | **datetime** | The time this entity was created. | **program_id** | **int** | The ID of the loyalty program that owns this entity. | +**program_name** | **str** | The integration name of the loyalty program that owns this entity. | [optional] +**program_title** | **str** | The Campaign Manager-displayed name of the loyalty program that owns this entity. | [optional] **status** | **str** | Status of the loyalty card. Can be `active` or `inactive`. | **block_reason** | **str** | Reason for transferring and blocking the loyalty card. | [optional] **identifier** | **str** | The alphanumeric identifier of the loyalty card. | @@ -17,6 +18,7 @@ Name | Type | Description | Notes **modified** | **datetime** | Timestamp of the most recent update of the loyalty card. | [optional] **old_card_identifier** | **str** | The alphanumeric identifier of the loyalty card. | [optional] **new_card_identifier** | **str** | The alphanumeric identifier of the loyalty card. | [optional] +**batch_id** | **str** | The ID of the batch in which the loyalty card was created. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LoyaltyCardBalances.md b/docs/LoyaltyCardBalances.md index 10d82be..76443cc 100644 --- a/docs/LoyaltyCardBalances.md +++ b/docs/LoyaltyCardBalances.md @@ -1,6 +1,6 @@ # LoyaltyCardBalances - +List of customer profiles linked to the loyalty card. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/LoyaltyCardBatch.md b/docs/LoyaltyCardBatch.md new file mode 100644 index 0000000..b5496d2 --- /dev/null +++ b/docs/LoyaltyCardBatch.md @@ -0,0 +1,13 @@ +# LoyaltyCardBatch + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number_of_cards** | **int** | Number of loyalty cards in the batch. | +**batch_id** | **str** | ID of the loyalty card batch. | [optional] +**status** | **str** | Status of the loyalty cards in the batch. | [optional] [default to 'active'] +**card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoyaltyCardBatchResponse.md b/docs/LoyaltyCardBatchResponse.md new file mode 100644 index 0000000..569345f --- /dev/null +++ b/docs/LoyaltyCardBatchResponse.md @@ -0,0 +1,11 @@ +# LoyaltyCardBatchResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number_of_cards_generated** | **int** | Number of loyalty cards in the batch. | +**batch_id** | **str** | ID of the loyalty card batch. | + +[[Back to Model list]](../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 b22cc44..23fe6f0 100644 --- a/docs/LoyaltyProgram.md +++ b/docs/LoyaltyProgram.md @@ -1,10 +1,10 @@ # LoyaltyProgram - +A Loyalty Program ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | The ID of loyalty program. Internal ID of this entity. | +**id** | **int** | The ID of loyalty program. | **created** | **datetime** | The time this entity was created. | **title** | **str** | The display title for the Loyalty Program. | **description** | **str** | Description of our Loyalty Program. | @@ -20,6 +20,7 @@ Name | Type | Description | Notes **tiers_expire_in** | **str** | The amount of time after which the tier expires and is reevaluated. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years 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, months and years. Signifies the end of the day, week, month or year. | [optional] **tiers_downgrade_policy** | **str** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional] **card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**return_policy** | **str** | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. | [optional] **account_id** | **int** | The ID of the Talon.One account that owns this program. | **name** | **str** | The internal name for the Loyalty Program. This is an immutable value. | **tiers** | [**list[LoyaltyTier]**](LoyaltyTier.md) | The tiers in this loyalty program. | [optional] @@ -29,6 +30,7 @@ Name | Type | Description | Notes **can_update_join_policy** | **bool** | `True` if the program join policy can be updated. | [optional] **can_update_tier_expiration_policy** | **bool** | `True` if the tier expiration policy can be updated. | [optional] **can_upgrade_to_advanced_tiers** | **bool** | `True` if the program can be upgraded to use the `tiersExpireIn` and `tiersDowngradePolicy` properties. | [optional] [default to False] +**can_update_subledgers** | **bool** | `True` if the `allowSubledger` property can be updated in the loyalty program. | [optional] [default to False] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LoyaltyProgramBalance.md b/docs/LoyaltyProgramBalance.md index 089fb10..9407ee9 100644 --- a/docs/LoyaltyProgramBalance.md +++ b/docs/LoyaltyProgramBalance.md @@ -8,8 +8,8 @@ Name | Type | Description | Notes **pending_balance** | **float** | Sum of pending points. | **expired_balance** | **float** | **DEPRECATED** Value is shown as 0. | **spent_balance** | **float** | **DEPRECATED** Value is shown as 0. | -**tentative_current_balance** | **float** | 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. | -**tentative_pending_balance** | **float** | 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] +**tentative_current_balance** | **float** | The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. | +**tentative_pending_balance** | **float** | The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LoyaltyProgramEntity.md b/docs/LoyaltyProgramEntity.md index f0f29db..9d6be61 100644 --- a/docs/LoyaltyProgramEntity.md +++ b/docs/LoyaltyProgramEntity.md @@ -4,6 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **program_id** | **int** | The ID of the loyalty program that owns this entity. | +**program_name** | **str** | The integration name of the loyalty program that owns this entity. | [optional] +**program_title** | **str** | The Campaign Manager-displayed name of the loyalty program that owns this entity. | [optional] [[Back to Model list]](../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 ba90056..f19da0c 100644 --- a/docs/LoyaltyTier.md +++ b/docs/LoyaltyTier.md @@ -1,14 +1,16 @@ # LoyaltyTier - +A tier in a loyalty program. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Internal ID of this entity. | **created** | **datetime** | The time this entity was created. | **program_id** | **int** | The ID of the loyalty program that owns this entity. | -**name** | **str** | The name of the tier | -**min_points** | **float** | The minimum amount of points required to be eligible for the tier. | +**program_name** | **str** | The integration name of the loyalty program that owns this entity. | [optional] +**program_title** | **str** | The Campaign Manager-displayed name of the loyalty program that owns this entity. | [optional] +**name** | **str** | The name of the tier. | +**min_points** | **float** | The minimum amount of points required to enter the tier. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ManagementApi.md b/docs/ManagementApi.md index eae79e5..0039707 100644 --- a/docs/ManagementApi.md +++ b/docs/ManagementApi.md @@ -12,6 +12,7 @@ Method | HTTP request | Description [**create_achievement**](ManagementApi.md#create_achievement) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | Create achievement [**create_additional_cost**](ManagementApi.md#create_additional_cost) | **POST** /v1/additional_costs | Create additional cost [**create_attribute**](ManagementApi.md#create_attribute) | **POST** /v1/attributes | Create custom attribute +[**create_batch_loyalty_cards**](ManagementApi.md#create_batch_loyalty_cards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards [**create_campaign_from_template**](ManagementApi.md#create_campaign_from_template) | **POST** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template [**create_collection**](ManagementApi.md#create_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection [**create_coupons**](ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons @@ -51,6 +52,7 @@ Method | HTTP request | Description [**export_loyalty_balances**](ManagementApi.md#export_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances [**export_loyalty_card_balances**](ManagementApi.md#export_loyalty_card_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export all card transaction logs [**export_loyalty_card_ledger**](ManagementApi.md#export_loyalty_card_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log | Export card's ledger log +[**export_loyalty_cards**](ManagementApi.md#export_loyalty_cards) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/export | Export loyalty cards [**export_loyalty_ledger**](ManagementApi.md#export_loyalty_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs [**export_pool_giveaways**](ManagementApi.md#export_pool_giveaways) | **GET** /v1/giveaways/pools/{poolId}/export | Export giveaway codes of a giveaway pool [**export_referrals**](ManagementApi.md#export_referrals) | **GET** /v1/applications/{applicationId}/export_referrals | Export referrals @@ -61,7 +63,6 @@ Method | HTTP request | Description [**get_achievement**](ManagementApi.md#get_achievement) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Get achievement [**get_additional_cost**](ManagementApi.md#get_additional_cost) | **GET** /v1/additional_costs/{additionalCostId} | Get additional cost [**get_additional_costs**](ManagementApi.md#get_additional_costs) | **GET** /v1/additional_costs | List additional costs -[**get_all_access_logs**](ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | List access logs [**get_application**](ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application [**get_application_api_health**](ManagementApi.md#get_application_api_health) | **GET** /v1/applications/{applicationId}/health_report | Get Application health [**get_application_customer**](ManagementApi.md#get_application_customer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get application's customer @@ -147,7 +148,7 @@ Method | HTTP request | Description [**scim_delete_user**](ManagementApi.md#scim_delete_user) | **DELETE** /v1/provisioning/scim/Users/{userId} | Delete SCIM user [**scim_get_resource_types**](ManagementApi.md#scim_get_resource_types) | **GET** /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types [**scim_get_schemas**](ManagementApi.md#scim_get_schemas) | **GET** /v1/provisioning/scim/Schemas | List supported SCIM schemas -[**scim_get_service_provider_config**](ManagementApi.md#scim_get_service_provider_config) | **GET** /v1/provisioning/scim/ServiceProviderConfig | Service config endpoint for SCIM provisioning protocol +[**scim_get_service_provider_config**](ManagementApi.md#scim_get_service_provider_config) | **GET** /v1/provisioning/scim/ServiceProviderConfig | Get SCIM service provider configuration [**scim_get_user**](ManagementApi.md#scim_get_user) | **GET** /v1/provisioning/scim/Users/{userId} | Get SCIM user [**scim_get_users**](ManagementApi.md#scim_get_users) | **GET** /v1/provisioning/scim/Users | List SCIM users [**scim_patch_user**](ManagementApi.md#scim_patch_user) | **PATCH** /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes @@ -221,7 +222,7 @@ configuration = talon_one.Configuration( with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) - body = talon_one.ActivateUserRequest() # ActivateUserRequest | body + body = talon_one.DeactivateUserRequest() # DeactivateUserRequest | body try: # Enable user by email address @@ -272,7 +273,7 @@ configuration = talon_one.Configuration( with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) - body = talon_one.ActivateUserRequest() # ActivateUserRequest | body + body = talon_one.DeactivateUserRequest() # DeactivateUserRequest | body try: # Enable user by email address @@ -285,7 +286,7 @@ with talon_one.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ActivateUserRequest**](ActivateUserRequest.md)| body | + **body** | **DeactivateUserRequest**| body | ### Return type @@ -1312,6 +1313,151 @@ Name | Type | Description | Notes [[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) +# **create_batch_loyalty_cards** +> LoyaltyCardBatchResponse create_batch_loyalty_cards(loyalty_program_id, body) + +Create loyalty cards + +Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. **Important:** - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code. + +### Example + +* Api Key Authentication (management_key): +```python +from __future__ import print_function +import time +import talon_one +from talon_one.rest import ApiException +from pprint import pprint +# Defining the host is optional and defaults to https://yourbaseurl.talon.one +# See configuration.py for a list of all supported configuration parameters. +configuration = talon_one.Configuration( + host = "https://yourbaseurl.talon.one" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: management_key +configuration = talon_one.Configuration( + host = "https://yourbaseurl.talon.one", + api_key = { + 'Authorization': 'YOUR_API_KEY' + } +) +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Configure API key authorization: manager_auth +configuration = talon_one.Configuration( + host = "https://yourbaseurl.talon.one", + api_key = { + 'Authorization': 'YOUR_API_KEY' + } +) +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with talon_one.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = talon_one.ManagementApi(api_client) + loyalty_program_id = 56 # int | 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. +body = talon_one.LoyaltyCardBatch() # LoyaltyCardBatch | body + + try: + # Create loyalty cards + api_response = api_instance.create_batch_loyalty_cards(loyalty_program_id, body) + pprint(api_response) + except ApiException as e: + print("Exception when calling ManagementApi->create_batch_loyalty_cards: %s\n" % e) +``` + +* Api Key Authentication (manager_auth): +```python +from __future__ import print_function +import time +import talon_one +from talon_one.rest import ApiException +from pprint import pprint +# Defining the host is optional and defaults to https://yourbaseurl.talon.one +# See configuration.py for a list of all supported configuration parameters. +configuration = talon_one.Configuration( + host = "https://yourbaseurl.talon.one" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: management_key +configuration = talon_one.Configuration( + host = "https://yourbaseurl.talon.one", + api_key = { + 'Authorization': 'YOUR_API_KEY' + } +) +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Configure API key authorization: manager_auth +configuration = talon_one.Configuration( + host = "https://yourbaseurl.talon.one", + api_key = { + 'Authorization': 'YOUR_API_KEY' + } +) +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with talon_one.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = talon_one.ManagementApi(api_client) + loyalty_program_id = 56 # int | 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. +body = talon_one.LoyaltyCardBatch() # LoyaltyCardBatch | body + + try: + # Create loyalty cards + api_response = api_instance.create_batch_loyalty_cards(loyalty_program_id, body) + pprint(api_response) + except ApiException as e: + print("Exception when calling ManagementApi->create_batch_loyalty_cards: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **loyalty_program_id** | **int**| 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. | + **body** | [**LoyaltyCardBatch**](LoyaltyCardBatch.md)| body | + +### Return type + +[**LoyaltyCardBatchResponse**](LoyaltyCardBatchResponse.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad request | - | +**401** | Unauthorized | - | +**404** | Not found | - | + +[[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) + # **create_campaign_from_template** > CreateTemplateCampaignResponse create_campaign_from_template(application_id, body) @@ -3944,7 +4090,7 @@ valid = 'valid_example' # str | - `expired`: Matches coupons in which the expira batch_id = 'batch_id_example' # str | Filter results by batches of coupons (optional) usable = 'usable_example' # str | - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. (optional) referral_id = 56 # int | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) -recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. (optional) +recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field. (optional) exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code (optional) (default to False) try: @@ -4009,7 +4155,7 @@ valid = 'valid_example' # str | - `expired`: Matches coupons in which the expira batch_id = 'batch_id_example' # str | Filter results by batches of coupons (optional) usable = 'usable_example' # str | - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. (optional) referral_id = 56 # int | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) -recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. (optional) +recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field. (optional) exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code (optional) (default to False) try: @@ -4036,7 +4182,7 @@ Name | Type | Description | Notes **batch_id** | **str**| Filter results by batches of coupons | [optional] **usable** | **str**| - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. | [optional] **referral_id** | **int**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional] - **recipient_integration_id** | **str**| Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. | [optional] + **recipient_integration_id** | **str**| Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field. | [optional] **exact_match** | **bool**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to False] ### Return type @@ -4673,7 +4819,7 @@ configuration = talon_one.Configuration( with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) - body = talon_one.DeleteUserRequest() # DeleteUserRequest | body + body = talon_one.DeactivateUserRequest() # DeactivateUserRequest | body try: # Delete user by email address @@ -4724,7 +4870,7 @@ configuration = talon_one.Configuration( with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) - body = talon_one.DeleteUserRequest() # DeleteUserRequest | body + body = talon_one.DeactivateUserRequest() # DeactivateUserRequest | body try: # Delete user by email address @@ -4737,7 +4883,7 @@ with talon_one.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**DeleteUserRequest**](DeleteUserRequest.md)| body | + **body** | **DeactivateUserRequest**| body | ### Return type @@ -5762,7 +5908,7 @@ Name | Type | Description | Notes 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 can contain 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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. +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 can contain 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 in RFC3339 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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. ### Example @@ -5809,7 +5955,7 @@ with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) application_id = 56 # int | The ID of the Application. It is displayed in your Talon.One deployment URL. -campaign_id = 3.4 # float | Filter results by campaign. (optional) +campaign_id = 3.4 # float | Filter results by campaign ID. (optional) sort = 'sort_example' # str | 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. (optional) value = 'value_example' # str | 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. (optional) created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -5875,7 +6021,7 @@ with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) application_id = 56 # int | The ID of the Application. It is displayed in your Talon.One deployment URL. -campaign_id = 3.4 # float | Filter results by campaign. (optional) +campaign_id = 3.4 # float | Filter results by campaign ID. (optional) sort = 'sort_example' # str | 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. (optional) value = 'value_example' # str | 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. (optional) created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -5903,7 +6049,7 @@ values_only = False # bool | Filter results to only return the coupon codes (`va Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **application_id** | **int**| The ID of the Application. It is displayed in your Talon.One deployment URL. | - **campaign_id** | **float**| Filter results by campaign. | [optional] + **campaign_id** | **float**| Filter results by campaign ID. | [optional] **sort** | **str**| 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. | [optional] **value** | **str**| 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. | [optional] **created_before** | **datetime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] @@ -6289,9 +6435,9 @@ with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) application_id = 56 # int | The ID of the Application. It is displayed in your Talon.One deployment URL. -campaign_id = 3.4 # float | Filter results by campaign. (optional) -created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) -created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) +campaign_id = 3.4 # float | Filter results by campaign ID. (optional) +created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) +created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) date_format = 'date_format_example' # str | Determines the format of dates in the export document. (optional) try: @@ -6345,9 +6491,9 @@ with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) application_id = 56 # int | The ID of the Application. It is displayed in your Talon.One deployment URL. -campaign_id = 3.4 # float | Filter results by campaign. (optional) -created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) -created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) +campaign_id = 3.4 # float | Filter results by campaign ID. (optional) +created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) +created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) date_format = 'date_format_example' # str | Determines the format of dates in the export document. (optional) try: @@ -6363,9 +6509,9 @@ date_format = 'date_format_example' # str | Determines the format of dates in th Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **application_id** | **int**| The ID of the Application. It is displayed in your Talon.One deployment URL. | - **campaign_id** | **float**| Filter results by campaign. | [optional] - **created_before** | **datetime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] - **created_after** | **datetime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] + **campaign_id** | **float**| Filter results by campaign ID. | [optional] + **created_before** | **datetime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] + **created_after** | **datetime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **date_format** | **str**| Determines the format of dates in the export document. | [optional] ### Return type @@ -6973,12 +7119,159 @@ Name | Type | Description | Notes [[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) +# **export_loyalty_cards** +> str export_loyalty_cards(loyalty_program_id, batch_id=batch_id, date_format=date_format) + +Export loyalty cards + +Download a CSV file containing the loyalty cards from a specified 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: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in. + +### Example + +* Api Key Authentication (management_key): +```python +from __future__ import print_function +import time +import talon_one +from talon_one.rest import ApiException +from pprint import pprint +# Defining the host is optional and defaults to https://yourbaseurl.talon.one +# See configuration.py for a list of all supported configuration parameters. +configuration = talon_one.Configuration( + host = "https://yourbaseurl.talon.one" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: management_key +configuration = talon_one.Configuration( + host = "https://yourbaseurl.talon.one", + api_key = { + 'Authorization': 'YOUR_API_KEY' + } +) +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Configure API key authorization: manager_auth +configuration = talon_one.Configuration( + host = "https://yourbaseurl.talon.one", + api_key = { + 'Authorization': 'YOUR_API_KEY' + } +) +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with talon_one.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = talon_one.ManagementApi(api_client) + loyalty_program_id = 56 # int | 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. +batch_id = 'batch_id_example' # str | Filter results by loyalty card batch ID. (optional) +date_format = 'date_format_example' # str | Determines the format of dates in the export document. (optional) + + try: + # Export loyalty cards + api_response = api_instance.export_loyalty_cards(loyalty_program_id, batch_id=batch_id, date_format=date_format) + pprint(api_response) + except ApiException as e: + print("Exception when calling ManagementApi->export_loyalty_cards: %s\n" % e) +``` + +* Api Key Authentication (manager_auth): +```python +from __future__ import print_function +import time +import talon_one +from talon_one.rest import ApiException +from pprint import pprint +# Defining the host is optional and defaults to https://yourbaseurl.talon.one +# See configuration.py for a list of all supported configuration parameters. +configuration = talon_one.Configuration( + host = "https://yourbaseurl.talon.one" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: management_key +configuration = talon_one.Configuration( + host = "https://yourbaseurl.talon.one", + api_key = { + 'Authorization': 'YOUR_API_KEY' + } +) +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Configure API key authorization: manager_auth +configuration = talon_one.Configuration( + host = "https://yourbaseurl.talon.one", + api_key = { + 'Authorization': 'YOUR_API_KEY' + } +) +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with talon_one.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = talon_one.ManagementApi(api_client) + loyalty_program_id = 56 # int | 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. +batch_id = 'batch_id_example' # str | Filter results by loyalty card batch ID. (optional) +date_format = 'date_format_example' # str | Determines the format of dates in the export document. (optional) + + try: + # Export loyalty cards + api_response = api_instance.export_loyalty_cards(loyalty_program_id, batch_id=batch_id, date_format=date_format) + pprint(api_response) + except ApiException as e: + print("Exception when calling ManagementApi->export_loyalty_cards: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **loyalty_program_id** | **int**| 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. | + **batch_id** | **str**| Filter results by loyalty card batch ID. | [optional] + **date_format** | **str**| Determines the format of dates in the export document. | [optional] + +### Return type + +**str** + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/csv + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**400** | Bad request | - | +**401** | Unauthorized | - | + +[[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) + # **export_loyalty_ledger** > str export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, date_format=date_format) 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. - `campaignid`: The ID of the campaign. +Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. ### Example @@ -7322,7 +7615,7 @@ with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) application_id = 56 # int | The ID of the Application. It is displayed in your Talon.One deployment URL. -campaign_id = 3.4 # float | Filter results by campaign. (optional) +campaign_id = 3.4 # float | Filter results by campaign ID. (optional) created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) valid = 'valid_example' # str | - `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. (optional) @@ -7381,7 +7674,7 @@ with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) application_id = 56 # int | The ID of the Application. It is displayed in your Talon.One deployment URL. -campaign_id = 3.4 # float | Filter results by campaign. (optional) +campaign_id = 3.4 # float | Filter results by campaign ID. (optional) created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) valid = 'valid_example' # str | - `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. (optional) @@ -7402,7 +7695,7 @@ date_format = 'date_format_example' # str | Determines the format of dates in th Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **application_id** | **int**| The ID of the Application. It is displayed in your Talon.One deployment URL. | - **campaign_id** | **float**| Filter results by campaign. | [optional] + **campaign_id** | **float**| Filter results by campaign ID. | [optional] **created_before** | **datetime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **created_after** | **datetime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **valid** | **str**| - `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. | [optional] @@ -8298,7 +8591,7 @@ Name | Type | Description | Notes [[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) # **get_additional_costs** -> InlineResponse20036 get_additional_costs(page_size=page_size, skip=skip, sort=sort) +> InlineResponse20035 get_additional_costs(page_size=page_size, skip=skip, sort=sort) List additional costs @@ -8424,167 +8717,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20036**](InlineResponse20036.md) - -### Authorization - -[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | OK | - | - -[[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) - -# **get_all_access_logs** -> InlineResponse20020 get_all_access_logs(range_start=range_start, range_end=range_end, path=path, method=method, status=status, page_size=page_size, skip=skip, sort=sort) - -List access logs - -Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs. - -### Example - -* Api Key Authentication (management_key): -```python -from __future__ import print_function -import time -import talon_one -from talon_one.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://yourbaseurl.talon.one -# See configuration.py for a list of all supported configuration parameters. -configuration = talon_one.Configuration( - host = "https://yourbaseurl.talon.one" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: management_key -configuration = talon_one.Configuration( - host = "https://yourbaseurl.talon.one", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure API key authorization: manager_auth -configuration = talon_one.Configuration( - host = "https://yourbaseurl.talon.one", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with talon_one.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = talon_one.ManagementApi(api_client) - range_start = '2013-10-20T19:20:30+01:00' # datetime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional) -range_end = '2013-10-20T19:20:30+01:00' # datetime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional) -path = 'path_example' # str | Only return results where the request path matches the given regular expression. (optional) -method = 'method_example' # str | Only return results where the request method matches the given regular expression. (optional) -status = 'status_example' # str | Filter results by HTTP status codes. (optional) -page_size = 1000 # int | The number of items in the response. (optional) (default to 1000) -skip = 56 # int | The number of items to skip when paging through large result sets. (optional) -sort = 'sort_example' # str | 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. (optional) - - try: - # List access logs - api_response = api_instance.get_all_access_logs(range_start=range_start, range_end=range_end, path=path, method=method, status=status, page_size=page_size, skip=skip, sort=sort) - pprint(api_response) - except ApiException as e: - print("Exception when calling ManagementApi->get_all_access_logs: %s\n" % e) -``` - -* Api Key Authentication (manager_auth): -```python -from __future__ import print_function -import time -import talon_one -from talon_one.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://yourbaseurl.talon.one -# See configuration.py for a list of all supported configuration parameters. -configuration = talon_one.Configuration( - host = "https://yourbaseurl.talon.one" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: management_key -configuration = talon_one.Configuration( - host = "https://yourbaseurl.talon.one", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Configure API key authorization: manager_auth -configuration = talon_one.Configuration( - host = "https://yourbaseurl.talon.one", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with talon_one.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = talon_one.ManagementApi(api_client) - range_start = '2013-10-20T19:20:30+01:00' # datetime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional) -range_end = '2013-10-20T19:20:30+01:00' # datetime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. (optional) -path = 'path_example' # str | Only return results where the request path matches the given regular expression. (optional) -method = 'method_example' # str | Only return results where the request method matches the given regular expression. (optional) -status = 'status_example' # str | Filter results by HTTP status codes. (optional) -page_size = 1000 # int | The number of items in the response. (optional) (default to 1000) -skip = 56 # int | The number of items to skip when paging through large result sets. (optional) -sort = 'sort_example' # str | 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. (optional) - - try: - # List access logs - api_response = api_instance.get_all_access_logs(range_start=range_start, range_end=range_end, path=path, method=method, status=status, page_size=page_size, skip=skip, sort=sort) - pprint(api_response) - except ApiException as e: - print("Exception when calling ManagementApi->get_all_access_logs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **range_start** | **datetime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] - **range_end** | **datetime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional] - **path** | **str**| Only return results where the request path matches the given regular expression. | [optional] - **method** | **str**| Only return results where the request method matches the given regular expression. | [optional] - **status** | **str**| Filter results by HTTP status codes. | [optional] - **page_size** | **int**| The number of items in the response. | [optional] [default to 1000] - **skip** | **int**| The number of items to skip when paging through large result sets. | [optional] - **sort** | **str**| 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. | [optional] - -### Return type - -[**InlineResponse20020**](InlineResponse20020.md) +[**InlineResponse20035**](InlineResponse20035.md) ### Authorization @@ -8746,7 +8879,7 @@ Name | Type | Description | Notes Get Application health -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). +Display the health of the Application and show the last time the Application was used. You can also find this information in the Campaign Manager. In your Application, click **Settings** > **Integration API Keys**. See the [docs](https://docs.talon.one/docs/dev/tutorials/monitoring-integration-status). ### Example @@ -9023,7 +9156,7 @@ Name | Type | Description | Notes [[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) # **get_application_customer_friends** -> InlineResponse20033 get_application_customer_friends(application_id, integration_id, page_size=page_size, skip=skip, sort=sort, with_total_result_size=with_total_result_size) +> InlineResponse20032 get_application_customer_friends(application_id, integration_id, page_size=page_size, skip=skip, sort=sort, with_total_result_size=with_total_result_size) List friends referred by customer profile @@ -9158,7 +9291,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20033**](InlineResponse20033.md) +[**InlineResponse20032**](InlineResponse20032.md) ### Authorization @@ -9177,7 +9310,7 @@ Name | Type | Description | Notes [[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) # **get_application_customers** -> InlineResponse20022 get_application_customers(application_id, integration_id=integration_id, page_size=page_size, skip=skip, with_total_result_size=with_total_result_size) +> InlineResponse20021 get_application_customers(application_id, integration_id=integration_id, page_size=page_size, skip=skip, with_total_result_size=with_total_result_size) List application's customers @@ -9309,7 +9442,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20022**](InlineResponse20022.md) +[**InlineResponse20021**](InlineResponse20021.md) ### Authorization @@ -9328,7 +9461,7 @@ Name | Type | Description | Notes [[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) # **get_application_customers_by_attributes** -> InlineResponse20023 get_application_customers_by_attributes(application_id, body, page_size=page_size, skip=skip, with_total_result_size=with_total_result_size) +> InlineResponse20022 get_application_customers_by_attributes(application_id, body, page_size=page_size, skip=skip, with_total_result_size=with_total_result_size) List application customers matching the given attributes @@ -9460,7 +9593,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20023**](InlineResponse20023.md) +[**InlineResponse20022**](InlineResponse20022.md) ### Authorization @@ -9479,7 +9612,7 @@ Name | Type | Description | Notes [[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) # **get_application_event_types** -> InlineResponse20029 get_application_event_types(application_id, page_size=page_size, skip=skip, sort=sort) +> InlineResponse20028 get_application_event_types(application_id, page_size=page_size, skip=skip, sort=sort) List Applications event types @@ -9608,7 +9741,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20029**](InlineResponse20029.md) +[**InlineResponse20028**](InlineResponse20028.md) ### Authorization @@ -9627,7 +9760,7 @@ Name | Type | Description | Notes [[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) # **get_application_events_without_total_count** -> InlineResponse20028 get_application_events_without_total_count(application_id, page_size=page_size, skip=skip, sort=sort, type=type, created_before=created_before, created_after=created_after, session=session, profile=profile, customer_name=customer_name, customer_email=customer_email, coupon_code=coupon_code, referral_code=referral_code, rule_query=rule_query, campaign_query=campaign_query) +> InlineResponse20027 get_application_events_without_total_count(application_id, page_size=page_size, skip=skip, sort=sort, type=type, created_before=created_before, created_after=created_after, session=session, profile=profile, customer_name=customer_name, customer_email=customer_email, coupon_code=coupon_code, referral_code=referral_code, rule_query=rule_query, campaign_query=campaign_query) List Applications events @@ -9789,7 +9922,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20028**](InlineResponse20028.md) +[**InlineResponse20027**](InlineResponse20027.md) ### Authorization @@ -9950,7 +10083,7 @@ Name | Type | Description | Notes [[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) # **get_application_sessions** -> InlineResponse20027 get_application_sessions(application_id, page_size=page_size, skip=skip, sort=sort, profile=profile, state=state, created_before=created_before, created_after=created_after, coupon=coupon, referral=referral, integration_id=integration_id, store_integration_id=store_integration_id) +> InlineResponse20026 get_application_sessions(application_id, page_size=page_size, skip=skip, sort=sort, profile=profile, state=state, created_before=created_before, created_after=created_after, coupon=coupon, referral=referral, integration_id=integration_id, store_integration_id=store_integration_id) List Application sessions @@ -10010,7 +10143,7 @@ created_before = '2013-10-20T19:20:30+01:00' # datetime | Only return events cre created_after = '2013-10-20T19:20:30+01:00' # datetime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) coupon = 'coupon_example' # str | Filter by sessions with this coupon. Must be exact match. (optional) referral = 'referral_example' # str | Filter by sessions with this referral. Must be exact match. (optional) -integration_id = 'integration_id_example' # str | Filter by sessions with this integrationId. Must be exact match. (optional) +integration_id = 'integration_id_example' # str | Filter by sessions with this integration ID. Must be exact match. (optional) store_integration_id = 'store_integration_id_example' # str | The integration ID of the store. You choose this ID when you create a store. (optional) try: @@ -10073,7 +10206,7 @@ created_before = '2013-10-20T19:20:30+01:00' # datetime | Only return events cre created_after = '2013-10-20T19:20:30+01:00' # datetime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) coupon = 'coupon_example' # str | Filter by sessions with this coupon. Must be exact match. (optional) referral = 'referral_example' # str | Filter by sessions with this referral. Must be exact match. (optional) -integration_id = 'integration_id_example' # str | Filter by sessions with this integrationId. Must be exact match. (optional) +integration_id = 'integration_id_example' # str | Filter by sessions with this integration ID. Must be exact match. (optional) store_integration_id = 'store_integration_id_example' # str | The integration ID of the store. You choose this ID when you create a store. (optional) try: @@ -10098,12 +10231,12 @@ Name | Type | Description | Notes **created_after** | **datetime**| Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **coupon** | **str**| Filter by sessions with this coupon. Must be exact match. | [optional] **referral** | **str**| Filter by sessions with this referral. Must be exact match. | [optional] - **integration_id** | **str**| Filter by sessions with this integrationId. Must be exact match. | [optional] + **integration_id** | **str**| Filter by sessions with this integration ID. Must be exact match. | [optional] **store_integration_id** | **str**| The integration ID of the store. You choose this ID when you create a store. | [optional] ### Return type -[**InlineResponse20027**](InlineResponse20027.md) +[**InlineResponse20026**](InlineResponse20026.md) ### Authorization @@ -10406,7 +10539,7 @@ Name | Type | Description | Notes [[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) # **get_attributes** -> InlineResponse20034 get_attributes(page_size=page_size, skip=skip, sort=sort, entity=entity) +> InlineResponse20033 get_attributes(page_size=page_size, skip=skip, sort=sort, entity=entity) List custom attributes @@ -10535,7 +10668,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20034**](InlineResponse20034.md) +[**InlineResponse20033**](InlineResponse20033.md) ### Authorization @@ -10554,7 +10687,7 @@ Name | Type | Description | Notes [[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) # **get_audience_memberships** -> InlineResponse20032 get_audience_memberships(audience_id, page_size=page_size, skip=skip, sort=sort, profile_query=profile_query) +> InlineResponse20031 get_audience_memberships(audience_id, page_size=page_size, skip=skip, sort=sort, profile_query=profile_query) List audience members @@ -10686,7 +10819,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20032**](InlineResponse20032.md) +[**InlineResponse20031**](InlineResponse20031.md) ### Authorization @@ -10706,7 +10839,7 @@ Name | Type | Description | Notes [[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) # **get_audiences** -> InlineResponse20030 get_audiences(page_size=page_size, skip=skip, sort=sort, with_total_result_size=with_total_result_size) +> InlineResponse20029 get_audiences(page_size=page_size, skip=skip, sort=sort, with_total_result_size=with_total_result_size) List audiences @@ -10835,7 +10968,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20030**](InlineResponse20030.md) +[**InlineResponse20029**](InlineResponse20029.md) ### Authorization @@ -10854,7 +10987,7 @@ Name | Type | Description | Notes [[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) # **get_audiences_analytics** -> InlineResponse20031 get_audiences_analytics(audience_ids, sort=sort) +> InlineResponse20030 get_audiences_analytics(audience_ids, sort=sort) List audience analytics @@ -10977,7 +11110,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20031**](InlineResponse20031.md) +[**InlineResponse20030**](InlineResponse20030.md) ### Authorization @@ -11138,7 +11271,7 @@ Name | Type | Description | Notes [[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) # **get_campaign_analytics** -> InlineResponse20021 get_campaign_analytics(application_id, campaign_id, range_start, range_end, granularity=granularity) +> InlineResponse20020 get_campaign_analytics(application_id, campaign_id, range_start, range_end, granularity=granularity) Get analytics of campaigns @@ -11270,7 +11403,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20021**](InlineResponse20021.md) +[**InlineResponse20020**](InlineResponse20020.md) ### Authorization @@ -11944,7 +12077,7 @@ tags = 'tags_example' # str | Filter results performing case-insensitive matchin created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) campaign_group_id = 56 # int | Filter results to campaigns owned by the specified campaign access group ID. (optional) -template_id = 56 # int | The ID of the Campaign Template this Campaign was created from. (optional) +template_id = 56 # int | The ID of the campaign template this campaign was created from. (optional) store_id = 56 # int | Filter results to campaigns linked to the specified store ID. (optional) try: @@ -12007,7 +12140,7 @@ tags = 'tags_example' # str | Filter results performing case-insensitive matchin created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) campaign_group_id = 56 # int | Filter results to campaigns owned by the specified campaign access group ID. (optional) -template_id = 56 # int | The ID of the Campaign Template this Campaign was created from. (optional) +template_id = 56 # int | The ID of the campaign template this campaign was created from. (optional) store_id = 56 # int | Filter results to campaigns linked to the specified store ID. (optional) try: @@ -12032,7 +12165,7 @@ Name | Type | Description | Notes **created_before** | **datetime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **created_after** | **datetime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **campaign_group_id** | **int**| Filter results to campaigns owned by the specified campaign access group ID. | [optional] - **template_id** | **int**| The ID of the Campaign Template this Campaign was created from. | [optional] + **template_id** | **int**| The ID of the campaign template this campaign was created from. | [optional] **store_id** | **int**| Filter results to campaigns linked to the specified store ID. | [optional] ### Return type @@ -12057,7 +12190,7 @@ Name | Type | Description | Notes [[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) # **get_changes** -> InlineResponse20042 get_changes(page_size=page_size, skip=skip, sort=sort, application_id=application_id, entity_path=entity_path, user_id=user_id, created_before=created_before, created_after=created_after, with_total_result_size=with_total_result_size, management_key_id=management_key_id, include_old=include_old) +> InlineResponse20041 get_changes(page_size=page_size, skip=skip, sort=sort, application_id=application_id, entity_path=entity_path, user_id=user_id, created_before=created_before, created_after=created_after, with_total_result_size=with_total_result_size, management_key_id=management_key_id, include_old=include_old) Get audit logs for an account @@ -12207,7 +12340,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20042**](InlineResponse20042.md) +[**InlineResponse20041**](InlineResponse20041.md) ### Authorization @@ -12580,9 +12713,9 @@ valid = 'valid_example' # str | Either \"expired\", \"validNow\", or \"validFutu usable = 'usable_example' # str | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) redeemed = 'redeemed_example' # str | - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. (optional) referral_id = 56 # int | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) -recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) +recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) batch_id = 'batch_id_example' # str | Filter results by batches of coupons (optional) -exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code (optional) (default to False) +exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code. (optional) (default to False) expires_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) expires_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) starts_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -12651,9 +12784,9 @@ valid = 'valid_example' # str | Either \"expired\", \"validNow\", or \"validFutu usable = 'usable_example' # str | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) redeemed = 'redeemed_example' # str | - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. (optional) referral_id = 56 # int | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) -recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) +recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) batch_id = 'batch_id_example' # str | Filter results by batches of coupons (optional) -exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code (optional) (default to False) +exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code. (optional) (default to False) expires_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) expires_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) starts_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -12684,9 +12817,9 @@ Name | Type | Description | Notes **usable** | **str**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional] **redeemed** | **str**| - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. | [optional] **referral_id** | **int**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional] - **recipient_integration_id** | **str**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional] + **recipient_integration_id** | **str**| Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. | [optional] **batch_id** | **str**| Filter results by batches of coupons | [optional] - **exact_match** | **bool**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to False] + **exact_match** | **bool**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to False] **expires_before** | **datetime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **expires_after** | **datetime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **starts_before** | **datetime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] @@ -12868,7 +13001,7 @@ Name | Type | Description | Notes [[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) # **get_customer_activity_reports_without_total_count** -> InlineResponse20026 get_customer_activity_reports_without_total_count(range_start, range_end, application_id, page_size=page_size, skip=skip, sort=sort, name=name, integration_id=integration_id, campaign_name=campaign_name, advocate_name=advocate_name) +> InlineResponse20025 get_customer_activity_reports_without_total_count(range_start, range_end, application_id, page_size=page_size, skip=skip, sort=sort, name=name, integration_id=integration_id, campaign_name=campaign_name, advocate_name=advocate_name) Get Activity Reports for Application Customers @@ -12924,10 +13057,10 @@ application_id = 56 # int | The ID of the Application. It is displayed in your T page_size = 1000 # int | The number of items in the response. (optional) (default to 1000) skip = 56 # int | The number of items to skip when paging through large result sets. (optional) sort = 'sort_example' # str | 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. (optional) -name = 'name_example' # str | Only return reports matching the customer name (optional) +name = 'name_example' # str | Only return reports matching the customer name. (optional) integration_id = 'integration_id_example' # str | Filter results performing an exact matching against the profile integration identifier. (optional) -campaign_name = 'campaign_name_example' # str | Only return reports matching the campaignName (optional) -advocate_name = 'advocate_name_example' # str | Only return reports matching the current customer referrer name (optional) +campaign_name = 'campaign_name_example' # str | Only return reports matching the campaign name. (optional) +advocate_name = 'advocate_name_example' # str | Only return reports matching the current customer referrer name. (optional) try: # Get Activity Reports for Application Customers @@ -12985,10 +13118,10 @@ application_id = 56 # int | The ID of the Application. It is displayed in your T page_size = 1000 # int | The number of items in the response. (optional) (default to 1000) skip = 56 # int | The number of items to skip when paging through large result sets. (optional) sort = 'sort_example' # str | 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. (optional) -name = 'name_example' # str | Only return reports matching the customer name (optional) +name = 'name_example' # str | Only return reports matching the customer name. (optional) integration_id = 'integration_id_example' # str | Filter results performing an exact matching against the profile integration identifier. (optional) -campaign_name = 'campaign_name_example' # str | Only return reports matching the campaignName (optional) -advocate_name = 'advocate_name_example' # str | Only return reports matching the current customer referrer name (optional) +campaign_name = 'campaign_name_example' # str | Only return reports matching the campaign name. (optional) +advocate_name = 'advocate_name_example' # str | Only return reports matching the current customer referrer name. (optional) try: # Get Activity Reports for Application Customers @@ -13008,14 +13141,14 @@ Name | Type | Description | Notes **page_size** | **int**| The number of items in the response. | [optional] [default to 1000] **skip** | **int**| The number of items to skip when paging through large result sets. | [optional] **sort** | **str**| 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. | [optional] - **name** | **str**| Only return reports matching the customer name | [optional] + **name** | **str**| Only return reports matching the customer name. | [optional] **integration_id** | **str**| Filter results performing an exact matching against the profile integration identifier. | [optional] - **campaign_name** | **str**| Only return reports matching the campaignName | [optional] - **advocate_name** | **str**| Only return reports matching the current customer referrer name | [optional] + **campaign_name** | **str**| Only return reports matching the campaign name. | [optional] + **advocate_name** | **str**| Only return reports matching the current customer referrer name. | [optional] ### Return type -[**InlineResponse20026**](InlineResponse20026.md) +[**InlineResponse20025**](InlineResponse20025.md) ### Authorization @@ -13324,7 +13457,7 @@ Name | Type | Description | Notes [[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) # **get_customer_profile_achievement_progress** -> InlineResponse20047 get_customer_profile_achievement_progress(application_id, integration_id, page_size=page_size, skip=skip, achievement_id=achievement_id, title=title) +> InlineResponse20046 get_customer_profile_achievement_progress(application_id, integration_id, page_size=page_size, skip=skip, achievement_id=achievement_id, title=title) List customer achievements @@ -13459,7 +13592,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20047**](InlineResponse20047.md) +[**InlineResponse20046**](InlineResponse20046.md) ### Authorization @@ -13480,7 +13613,7 @@ Name | Type | Description | Notes [[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) # **get_customer_profiles** -> InlineResponse20025 get_customer_profiles(page_size=page_size, skip=skip, sandbox=sandbox) +> InlineResponse20024 get_customer_profiles(page_size=page_size, skip=skip, sandbox=sandbox) List customer profiles @@ -13532,7 +13665,7 @@ with talon_one.ApiClient(configuration) as api_client: api_instance = talon_one.ManagementApi(api_client) page_size = 1000 # int | The number of items in the response. (optional) (default to 1000) skip = 56 # int | The number of items to skip when paging through large result sets. (optional) -sandbox = False # bool | Indicates whether you are pointing to a sandbox or Live customer. (optional) (default to False) +sandbox = False # bool | Indicates whether you are pointing to a sandbox or live customer. (optional) (default to False) try: # List customer profiles @@ -13586,7 +13719,7 @@ with talon_one.ApiClient(configuration) as api_client: api_instance = talon_one.ManagementApi(api_client) page_size = 1000 # int | The number of items in the response. (optional) (default to 1000) skip = 56 # int | The number of items to skip when paging through large result sets. (optional) -sandbox = False # bool | Indicates whether you are pointing to a sandbox or Live customer. (optional) (default to False) +sandbox = False # bool | Indicates whether you are pointing to a sandbox or live customer. (optional) (default to False) try: # List customer profiles @@ -13602,11 +13735,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **int**| The number of items in the response. | [optional] [default to 1000] **skip** | **int**| The number of items to skip when paging through large result sets. | [optional] - **sandbox** | **bool**| Indicates whether you are pointing to a sandbox or Live customer. | [optional] [default to False] + **sandbox** | **bool**| Indicates whether you are pointing to a sandbox or live customer. | [optional] [default to False] ### Return type -[**InlineResponse20025**](InlineResponse20025.md) +[**InlineResponse20024**](InlineResponse20024.md) ### Authorization @@ -13625,7 +13758,7 @@ Name | Type | Description | Notes [[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) # **get_customers_by_attributes** -> InlineResponse20024 get_customers_by_attributes(body, page_size=page_size, skip=skip, sandbox=sandbox) +> InlineResponse20023 get_customers_by_attributes(body, page_size=page_size, skip=skip, sandbox=sandbox) List customer profiles matching the given attributes @@ -13678,7 +13811,7 @@ with talon_one.ApiClient(configuration) as api_client: body = talon_one.CustomerProfileSearchQuery() # CustomerProfileSearchQuery | body page_size = 1000 # int | The number of items in the response. (optional) (default to 1000) skip = 56 # int | The number of items to skip when paging through large result sets. (optional) -sandbox = False # bool | Indicates whether you are pointing to a sandbox or Live customer. (optional) (default to False) +sandbox = False # bool | Indicates whether you are pointing to a sandbox or live customer. (optional) (default to False) try: # List customer profiles matching the given attributes @@ -13733,7 +13866,7 @@ with talon_one.ApiClient(configuration) as api_client: body = talon_one.CustomerProfileSearchQuery() # CustomerProfileSearchQuery | body page_size = 1000 # int | The number of items in the response. (optional) (default to 1000) skip = 56 # int | The number of items to skip when paging through large result sets. (optional) -sandbox = False # bool | Indicates whether you are pointing to a sandbox or Live customer. (optional) (default to False) +sandbox = False # bool | Indicates whether you are pointing to a sandbox or live customer. (optional) (default to False) try: # List customer profiles matching the given attributes @@ -13750,11 +13883,11 @@ Name | Type | Description | Notes **body** | [**CustomerProfileSearchQuery**](CustomerProfileSearchQuery.md)| body | **page_size** | **int**| The number of items in the response. | [optional] [default to 1000] **skip** | **int**| The number of items to skip when paging through large result sets. | [optional] - **sandbox** | **bool**| Indicates whether you are pointing to a sandbox or Live customer. | [optional] [default to False] + **sandbox** | **bool**| Indicates whether you are pointing to a sandbox or live customer. | [optional] [default to False] ### Return type -[**InlineResponse20024**](InlineResponse20024.md) +[**InlineResponse20023**](InlineResponse20023.md) ### Authorization @@ -13773,7 +13906,7 @@ Name | Type | Description | Notes [[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) # **get_event_types** -> InlineResponse20040 get_event_types(name=name, include_old_versions=include_old_versions, page_size=page_size, skip=skip, sort=sort) +> InlineResponse20039 get_event_types(name=name, include_old_versions=include_old_versions, page_size=page_size, skip=skip, sort=sort) List event types @@ -13905,7 +14038,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20040**](InlineResponse20040.md) +[**InlineResponse20039**](InlineResponse20039.md) ### Authorization @@ -13924,7 +14057,7 @@ Name | Type | Description | Notes [[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) # **get_exports** -> InlineResponse20043 get_exports(page_size=page_size, skip=skip, application_id=application_id, campaign_id=campaign_id, entity=entity) +> InlineResponse20042 get_exports(page_size=page_size, skip=skip, application_id=application_id, campaign_id=campaign_id, entity=entity) Get exports @@ -14056,7 +14189,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20043**](InlineResponse20043.md) +[**InlineResponse20042**](InlineResponse20042.md) ### Authorization @@ -14379,7 +14512,7 @@ Name | Type | Description | Notes [[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) # **get_loyalty_cards** -> InlineResponse20015 get_loyalty_cards(loyalty_program_id, page_size=page_size, skip=skip, sort=sort, identifier=identifier, profile_id=profile_id) +> InlineResponse20015 get_loyalty_cards(loyalty_program_id, page_size=page_size, skip=skip, sort=sort, identifier=identifier, profile_id=profile_id, batch_id=batch_id) List loyalty cards @@ -14433,12 +14566,13 @@ with talon_one.ApiClient(configuration) as api_client: page_size = 1000 # int | The number of items in the response. (optional) (default to 1000) skip = 56 # int | The number of items to skip when paging through large result sets. (optional) sort = 'sort_example' # str | 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. (optional) -identifier = 'identifier_example' # str | Optional query parameter to search cards by identifier. (optional) -profile_id = 56 # int | Filter by the profile ID. (optional) +identifier = 'identifier_example' # str | The card code by which to filter loyalty cards in the response. (optional) +profile_id = 56 # int | Filter results by customer profile ID. (optional) +batch_id = 'batch_id_example' # str | Filter results by loyalty card batch ID. (optional) try: # List loyalty cards - api_response = api_instance.get_loyalty_cards(loyalty_program_id, page_size=page_size, skip=skip, sort=sort, identifier=identifier, profile_id=profile_id) + api_response = api_instance.get_loyalty_cards(loyalty_program_id, page_size=page_size, skip=skip, sort=sort, identifier=identifier, profile_id=profile_id, batch_id=batch_id) pprint(api_response) except ApiException as e: print("Exception when calling ManagementApi->get_loyalty_cards: %s\n" % e) @@ -14490,12 +14624,13 @@ with talon_one.ApiClient(configuration) as api_client: page_size = 1000 # int | The number of items in the response. (optional) (default to 1000) skip = 56 # int | The number of items to skip when paging through large result sets. (optional) sort = 'sort_example' # str | 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. (optional) -identifier = 'identifier_example' # str | Optional query parameter to search cards by identifier. (optional) -profile_id = 56 # int | Filter by the profile ID. (optional) +identifier = 'identifier_example' # str | The card code by which to filter loyalty cards in the response. (optional) +profile_id = 56 # int | Filter results by customer profile ID. (optional) +batch_id = 'batch_id_example' # str | Filter results by loyalty card batch ID. (optional) try: # List loyalty cards - api_response = api_instance.get_loyalty_cards(loyalty_program_id, page_size=page_size, skip=skip, sort=sort, identifier=identifier, profile_id=profile_id) + api_response = api_instance.get_loyalty_cards(loyalty_program_id, page_size=page_size, skip=skip, sort=sort, identifier=identifier, profile_id=profile_id, batch_id=batch_id) pprint(api_response) except ApiException as e: print("Exception when calling ManagementApi->get_loyalty_cards: %s\n" % e) @@ -14509,8 +14644,9 @@ Name | Type | Description | Notes **page_size** | **int**| The number of items in the response. | [optional] [default to 1000] **skip** | **int**| The number of items to skip when paging through large result sets. | [optional] **sort** | **str**| 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. | [optional] - **identifier** | **str**| Optional query parameter to search cards by identifier. | [optional] - **profile_id** | **int**| Filter by the profile ID. | [optional] + **identifier** | **str**| The card code by which to filter loyalty cards in the response. | [optional] + **profile_id** | **int**| Filter results by customer profile ID. | [optional] + **batch_id** | **str**| Filter results by loyalty card batch ID. | [optional] ### Return type @@ -15309,7 +15445,7 @@ created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results compari created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) valid = 'valid_example' # str | 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. (optional) usable = 'usable_example' # str | Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. (optional) -advocate = 'advocate_example' # str | Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field (optional) +advocate = 'advocate_example' # str | Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field. (optional) try: # List referrals @@ -15371,7 +15507,7 @@ created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results compari created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) valid = 'valid_example' # str | 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. (optional) usable = 'usable_example' # str | Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. (optional) -advocate = 'advocate_example' # str | Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field (optional) +advocate = 'advocate_example' # str | Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field. (optional) try: # List referrals @@ -15395,7 +15531,7 @@ Name | Type | Description | Notes **created_after** | **datetime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **valid** | **str**| 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. | [optional] **usable** | **str**| Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. | [optional] - **advocate** | **str**| Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field | [optional] + **advocate** | **str**| Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field. | [optional] ### Return type @@ -16135,7 +16271,7 @@ Name | Type | Description | Notes [[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) # **get_users** -> InlineResponse20041 get_users(page_size=page_size, skip=skip, sort=sort) +> InlineResponse20040 get_users(page_size=page_size, skip=skip, sort=sort) List users in account @@ -16261,7 +16397,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20041**](InlineResponse20041.md) +[**InlineResponse20040**](InlineResponse20040.md) ### Authorization @@ -16419,7 +16555,7 @@ Name | Type | Description | Notes [[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) # **get_webhook_activation_logs** -> InlineResponse20038 get_webhook_activation_logs(page_size=page_size, skip=skip, sort=sort, integration_request_uuid=integration_request_uuid, webhook_id=webhook_id, application_id=application_id, campaign_id=campaign_id, created_before=created_before, created_after=created_after) +> InlineResponse20037 get_webhook_activation_logs(page_size=page_size, skip=skip, sort=sort, integration_request_uuid=integration_request_uuid, webhook_id=webhook_id, application_id=application_id, campaign_id=campaign_id, created_before=created_before, created_after=created_after) List webhook activation log entries @@ -16473,9 +16609,9 @@ with talon_one.ApiClient(configuration) as api_client: skip = 56 # int | The number of items to skip when paging through large result sets. (optional) sort = 'sort_example' # str | 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. (optional) integration_request_uuid = 'integration_request_uuid_example' # str | Filter results by integration request UUID. (optional) -webhook_id = 3.4 # float | Filter results by Webhook. (optional) +webhook_id = 3.4 # float | Filter results by webhook id. (optional) application_id = 3.4 # float | Filter results by Application ID. (optional) -campaign_id = 3.4 # float | Filter results by campaign. (optional) +campaign_id = 3.4 # float | Filter results by campaign ID. (optional) created_before = '2013-10-20T19:20:30+01:00' # datetime | Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) created_after = '2013-10-20T19:20:30+01:00' # datetime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -16533,9 +16669,9 @@ with talon_one.ApiClient(configuration) as api_client: skip = 56 # int | The number of items to skip when paging through large result sets. (optional) sort = 'sort_example' # str | 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. (optional) integration_request_uuid = 'integration_request_uuid_example' # str | Filter results by integration request UUID. (optional) -webhook_id = 3.4 # float | Filter results by Webhook. (optional) +webhook_id = 3.4 # float | Filter results by webhook id. (optional) application_id = 3.4 # float | Filter results by Application ID. (optional) -campaign_id = 3.4 # float | Filter results by campaign. (optional) +campaign_id = 3.4 # float | Filter results by campaign ID. (optional) created_before = '2013-10-20T19:20:30+01:00' # datetime | Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) created_after = '2013-10-20T19:20:30+01:00' # datetime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -16555,15 +16691,15 @@ Name | Type | Description | Notes **skip** | **int**| The number of items to skip when paging through large result sets. | [optional] **sort** | **str**| 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. | [optional] **integration_request_uuid** | **str**| Filter results by integration request UUID. | [optional] - **webhook_id** | **float**| Filter results by Webhook. | [optional] + **webhook_id** | **float**| Filter results by webhook id. | [optional] **application_id** | **float**| Filter results by Application ID. | [optional] - **campaign_id** | **float**| Filter results by campaign. | [optional] + **campaign_id** | **float**| Filter results by campaign ID. | [optional] **created_before** | **datetime**| Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **created_after** | **datetime**| Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] ### Return type -[**InlineResponse20038**](InlineResponse20038.md) +[**InlineResponse20037**](InlineResponse20037.md) ### Authorization @@ -16582,7 +16718,7 @@ Name | Type | Description | Notes [[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) # **get_webhook_logs** -> InlineResponse20039 get_webhook_logs(page_size=page_size, skip=skip, sort=sort, status=status, webhook_id=webhook_id, application_id=application_id, campaign_id=campaign_id, request_uuid=request_uuid, created_before=created_before, created_after=created_after) +> InlineResponse20038 get_webhook_logs(page_size=page_size, skip=skip, sort=sort, status=status, webhook_id=webhook_id, application_id=application_id, campaign_id=campaign_id, request_uuid=request_uuid, created_before=created_before, created_after=created_after) List webhook log entries @@ -16636,9 +16772,9 @@ with talon_one.ApiClient(configuration) as api_client: skip = 56 # int | The number of items to skip when paging through large result sets. (optional) sort = 'sort_example' # str | 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. (optional) status = 'status_example' # str | Filter results by HTTP status codes. (optional) -webhook_id = 3.4 # float | Filter results by Webhook. (optional) +webhook_id = 3.4 # float | Filter results by webhook id. (optional) application_id = 3.4 # float | Filter results by Application ID. (optional) -campaign_id = 3.4 # float | Filter results by campaign. (optional) +campaign_id = 3.4 # float | Filter results by campaign ID. (optional) request_uuid = 'request_uuid_example' # str | Filter results by request UUID. (optional) created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -16697,9 +16833,9 @@ with talon_one.ApiClient(configuration) as api_client: skip = 56 # int | The number of items to skip when paging through large result sets. (optional) sort = 'sort_example' # str | 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. (optional) status = 'status_example' # str | Filter results by HTTP status codes. (optional) -webhook_id = 3.4 # float | Filter results by Webhook. (optional) +webhook_id = 3.4 # float | Filter results by webhook id. (optional) application_id = 3.4 # float | Filter results by Application ID. (optional) -campaign_id = 3.4 # float | Filter results by campaign. (optional) +campaign_id = 3.4 # float | Filter results by campaign ID. (optional) request_uuid = 'request_uuid_example' # str | Filter results by request UUID. (optional) created_before = '2013-10-20T19:20:30+01:00' # datetime | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. (optional) @@ -16720,16 +16856,16 @@ Name | Type | Description | Notes **skip** | **int**| The number of items to skip when paging through large result sets. | [optional] **sort** | **str**| 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. | [optional] **status** | **str**| Filter results by HTTP status codes. | [optional] - **webhook_id** | **float**| Filter results by Webhook. | [optional] + **webhook_id** | **float**| Filter results by webhook id. | [optional] **application_id** | **float**| Filter results by Application ID. | [optional] - **campaign_id** | **float**| Filter results by campaign. | [optional] + **campaign_id** | **float**| Filter results by campaign ID. | [optional] **request_uuid** | **str**| Filter results by request UUID. | [optional] **created_before** | **datetime**| Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] **created_after** | **datetime**| Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] ### Return type -[**InlineResponse20039**](InlineResponse20039.md) +[**InlineResponse20038**](InlineResponse20038.md) ### Authorization @@ -16748,7 +16884,7 @@ Name | Type | Description | Notes [[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) # **get_webhooks** -> InlineResponse20037 get_webhooks(application_ids=application_ids, sort=sort, page_size=page_size, skip=skip, creation_type=creation_type, visibility=visibility, outgoing_integrations_type_id=outgoing_integrations_type_id, title=title) +> InlineResponse20036 get_webhooks(application_ids=application_ids, sort=sort, page_size=page_size, skip=skip, creation_type=creation_type, visibility=visibility, outgoing_integrations_type_id=outgoing_integrations_type_id, title=title) List webhooks @@ -16889,7 +17025,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20037**](InlineResponse20037.md) +[**InlineResponse20036**](InlineResponse20036.md) ### Authorization @@ -17791,7 +17927,7 @@ Name | Type | Description | Notes 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. 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 ``` +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. The identifiers should be separated with a semicolon (;). **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ``` ### Example @@ -18080,7 +18216,7 @@ Name | Type | Description | Notes 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. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` +Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` ### Example @@ -18796,7 +18932,7 @@ Name | Type | Description | Notes [[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) # **list_achievements** -> InlineResponse20046 list_achievements(application_id, campaign_id, page_size=page_size, skip=skip, title=title) +> InlineResponse20045 list_achievements(application_id, campaign_id, page_size=page_size, skip=skip, title=title) List achievements @@ -18928,7 +19064,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20046**](InlineResponse20046.md) +[**InlineResponse20045**](InlineResponse20045.md) ### Authorization @@ -18947,7 +19083,7 @@ Name | Type | Description | Notes [[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) # **list_all_roles_v2** -> InlineResponse20044 list_all_roles_v2() +> InlineResponse20043 list_all_roles_v2() List roles @@ -19062,7 +19198,7 @@ This endpoint does not need any parameter. ### Return type -[**InlineResponse20044**](InlineResponse20044.md) +[**InlineResponse20043**](InlineResponse20043.md) ### Authorization @@ -19081,7 +19217,7 @@ This endpoint does not need any parameter. [[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) # **list_catalog_items** -> InlineResponse20035 list_catalog_items(catalog_id, page_size=page_size, skip=skip, with_total_result_size=with_total_result_size, sku=sku, product_names=product_names) +> InlineResponse20034 list_catalog_items(catalog_id, page_size=page_size, skip=skip, with_total_result_size=with_total_result_size, sku=sku, product_names=product_names) List items in a catalog @@ -19216,7 +19352,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20035**](InlineResponse20035.md) +[**InlineResponse20034**](InlineResponse20034.md) ### Authorization @@ -19548,7 +19684,7 @@ Name | Type | Description | Notes [[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) # **list_stores** -> InlineResponse20045 list_stores(application_id, page_size=page_size, skip=skip, sort=sort, with_total_result_size=with_total_result_size, campaign_id=campaign_id, name=name, integration_id=integration_id, query=query) +> InlineResponse20044 list_stores(application_id, page_size=page_size, skip=skip, sort=sort, with_total_result_size=with_total_result_size, campaign_id=campaign_id, name=name, integration_id=integration_id, query=query) List stores @@ -19603,7 +19739,7 @@ page_size = 1000 # int | The number of items in the response. (optional) (defaul skip = 56 # int | The number of items to skip when paging through large result sets. (optional) sort = 'sort_example' # str | 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. (optional) with_total_result_size = True # 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. (optional) -campaign_id = 3.4 # float | Filter results by campaign. (optional) +campaign_id = 3.4 # float | Filter results by campaign ID. (optional) name = 'name_example' # str | The name of the store. (optional) integration_id = 'integration_id_example' # str | The integration ID of the store. (optional) query = 'query_example' # str | Filter results by `name` or `integrationId`. (optional) @@ -19663,7 +19799,7 @@ page_size = 1000 # int | The number of items in the response. (optional) (defaul skip = 56 # int | The number of items to skip when paging through large result sets. (optional) sort = 'sort_example' # str | 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. (optional) with_total_result_size = True # 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. (optional) -campaign_id = 3.4 # float | Filter results by campaign. (optional) +campaign_id = 3.4 # float | Filter results by campaign ID. (optional) name = 'name_example' # str | The name of the store. (optional) integration_id = 'integration_id_example' # str | The integration ID of the store. (optional) query = 'query_example' # str | Filter results by `name` or `integrationId`. (optional) @@ -19685,14 +19821,14 @@ Name | Type | Description | Notes **skip** | **int**| The number of items to skip when paging through large result sets. | [optional] **sort** | **str**| 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. | [optional] **with_total_result_size** | **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. | [optional] - **campaign_id** | **float**| Filter results by campaign. | [optional] + **campaign_id** | **float**| Filter results by campaign ID. | [optional] **name** | **str**| The name of the store. | [optional] **integration_id** | **str**| The integration ID of the store. | [optional] **query** | **str**| Filter results by `name` or `integrationId`. | [optional] ### Return type -[**InlineResponse20045**](InlineResponse20045.md) +[**InlineResponse20044**](InlineResponse20044.md) ### Authorization @@ -20753,7 +20889,7 @@ configuration = talon_one.Configuration( with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) - body = None # object | body + body = talon_one.ScimNewUser() # ScimNewUser | body try: # Create SCIM user @@ -20805,7 +20941,7 @@ configuration = talon_one.Configuration( with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) - body = None # object | body + body = talon_one.ScimNewUser() # ScimNewUser | body try: # Create SCIM user @@ -20819,7 +20955,7 @@ with talon_one.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **object**| body | + **body** | [**ScimNewUser**](ScimNewUser.md)| body | ### Return type @@ -21113,7 +21249,7 @@ This endpoint does not need any parameter. [[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) # **scim_get_schemas** -> scim_get_schemas() +> ScimSchemasListResponse scim_get_schemas() List supported SCIM schemas @@ -21166,7 +21302,8 @@ with talon_one.ApiClient(configuration) as api_client: try: # List supported SCIM schemas - api_instance.scim_get_schemas() + api_response = api_instance.scim_get_schemas() + pprint(api_response) except ApiException as e: print("Exception when calling ManagementApi->scim_get_schemas: %s\n" % e) ``` @@ -21216,7 +21353,8 @@ with talon_one.ApiClient(configuration) as api_client: try: # List supported SCIM schemas - api_instance.scim_get_schemas() + api_response = api_instance.scim_get_schemas() + pprint(api_response) except ApiException as e: print("Exception when calling ManagementApi->scim_get_schemas: %s\n" % e) ``` @@ -21226,7 +21364,7 @@ This endpoint does not need any parameter. ### Return type -void (empty response body) +[**ScimSchemasListResponse**](ScimSchemasListResponse.md) ### Authorization @@ -21235,21 +21373,21 @@ void (empty response body) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Schemas | - | +**200** | List of schemas supported by the SCIM provisioning protocol | - | [[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) # **scim_get_service_provider_config** -> scim_get_service_provider_config() +> ScimServiceProviderConfigResponse scim_get_service_provider_config() -Service config endpoint for SCIM provisioning protocol +Get SCIM service provider configuration -Service config endpoint for SCIM provisioning protocol +Retrieve the configuration settings of the SCIM service provider. It provides details about the features and capabilities supported by the SCIM API, such as the different operation settings. ### Example @@ -21297,8 +21435,9 @@ with talon_one.ApiClient(configuration) as api_client: api_instance = talon_one.ManagementApi(api_client) try: - # Service config endpoint for SCIM provisioning protocol - api_instance.scim_get_service_provider_config() + # Get SCIM service provider configuration + api_response = api_instance.scim_get_service_provider_config() + pprint(api_response) except ApiException as e: print("Exception when calling ManagementApi->scim_get_service_provider_config: %s\n" % e) ``` @@ -21347,8 +21486,9 @@ with talon_one.ApiClient(configuration) as api_client: api_instance = talon_one.ManagementApi(api_client) try: - # Service config endpoint for SCIM provisioning protocol - api_instance.scim_get_service_provider_config() + # Get SCIM service provider configuration + api_response = api_instance.scim_get_service_provider_config() + pprint(api_response) except ApiException as e: print("Exception when calling ManagementApi->scim_get_service_provider_config: %s\n" % e) ``` @@ -21358,7 +21498,7 @@ This endpoint does not need any parameter. ### Return type -void (empty response body) +[**ScimServiceProviderConfigResponse**](ScimServiceProviderConfigResponse.md) ### Authorization @@ -21367,12 +21507,12 @@ void (empty response body) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Service config | - | +**200** | Service configuration | - | [[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) @@ -21650,7 +21790,7 @@ This endpoint does not need any parameter. [[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) # **scim_patch_user** -> ScimUser scim_patch_user(user_id) +> ScimUser scim_patch_user(user_id, body) Update SCIM user attributes @@ -21701,10 +21841,11 @@ with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) user_id = 56 # int | The ID of the user. +body = talon_one.ScimPatchRequest() # ScimPatchRequest | body try: # Update SCIM user attributes - api_response = api_instance.scim_patch_user(user_id) + api_response = api_instance.scim_patch_user(user_id, body) pprint(api_response) except ApiException as e: print("Exception when calling ManagementApi->scim_patch_user: %s\n" % e) @@ -21753,10 +21894,11 @@ with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) user_id = 56 # int | The ID of the user. +body = talon_one.ScimPatchRequest() # ScimPatchRequest | body try: # Update SCIM user attributes - api_response = api_instance.scim_patch_user(user_id) + api_response = api_instance.scim_patch_user(user_id, body) pprint(api_response) except ApiException as e: print("Exception when calling ManagementApi->scim_patch_user: %s\n" % e) @@ -21767,6 +21909,7 @@ with talon_one.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **int**| The ID of the user. | + **body** | [**ScimPatchRequest**](ScimPatchRequest.md)| body | ### Return type @@ -21778,7 +21921,7 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details @@ -21840,7 +21983,7 @@ with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) user_id = 56 # int | The ID of the user. -body = None # object | body +body = talon_one.ScimNewUser() # ScimNewUser | body try: # Update SCIM user @@ -21893,7 +22036,7 @@ with talon_one.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = talon_one.ManagementApi(api_client) user_id = 56 # int | The ID of the user. -body = None # object | body +body = talon_one.ScimNewUser() # ScimNewUser | body try: # Update SCIM user @@ -21908,7 +22051,7 @@ body = None # object | body Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **int**| The ID of the user. | - **body** | **object**| body | + **body** | [**ScimNewUser**](ScimNewUser.md)| body | ### Return type @@ -21992,9 +22135,9 @@ created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparin valid = 'valid_example' # str | 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. (optional) usable = 'usable_example' # str | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) referral_id = 56 # int | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) -recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) +recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) batch_id = 'batch_id_example' # str | Filter results by batches of coupons (optional) -exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code (optional) (default to False) +exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code. (optional) (default to False) campaign_state = 'campaign_state_example' # str | 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. (optional) try: @@ -22058,9 +22201,9 @@ created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparin valid = 'valid_example' # str | 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. (optional) usable = 'usable_example' # str | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) referral_id = 56 # int | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) -recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) +recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) batch_id = 'batch_id_example' # str | Filter results by batches of coupons (optional) -exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code (optional) (default to False) +exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code. (optional) (default to False) campaign_state = 'campaign_state_example' # str | 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. (optional) try: @@ -22086,9 +22229,9 @@ Name | Type | Description | Notes **valid** | **str**| 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. | [optional] **usable** | **str**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional] **referral_id** | **int**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional] - **recipient_integration_id** | **str**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional] + **recipient_integration_id** | **str**| Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. | [optional] **batch_id** | **str**| Filter results by batches of coupons | [optional] - **exact_match** | **bool**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to False] + **exact_match** | **bool**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to False] **campaign_state** | **str**| 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. | [optional] ### Return type @@ -22174,8 +22317,8 @@ created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparin valid = 'valid_example' # str | 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. (optional) usable = 'usable_example' # str | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) referral_id = 56 # int | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) -recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) -exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code (optional) (default to False) +recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) +exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code. (optional) (default to False) batch_id = 'batch_id_example' # str | Filter results by batches of coupons (optional) try: @@ -22240,8 +22383,8 @@ created_after = '2013-10-20T19:20:30+01:00' # datetime | Filter results comparin valid = 'valid_example' # str | 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. (optional) usable = 'usable_example' # str | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. (optional) referral_id = 56 # int | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. (optional) -recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field (optional) -exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code (optional) (default to False) +recipient_integration_id = 'recipient_integration_id_example' # str | Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. (optional) +exact_match = False # bool | Filter results to an exact case-insensitive matching against the coupon code. (optional) (default to False) batch_id = 'batch_id_example' # str | Filter results by batches of coupons (optional) try: @@ -22268,8 +22411,8 @@ Name | Type | Description | Notes **valid** | **str**| 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. | [optional] **usable** | **str**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional] **referral_id** | **int**| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional] - **recipient_integration_id** | **str**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional] - **exact_match** | **bool**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to False] + **recipient_integration_id** | **str**| Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. | [optional] + **exact_match** | **bool**| Filter results to an exact case-insensitive matching against the coupon code. | [optional] [default to False] **batch_id** | **str**| Filter results by batches of coupons | [optional] ### Return type @@ -23023,7 +23166,7 @@ Name | Type | Description | Notes Update campaign -Update the given campaign. +Update the given campaign. **Important:** You cannot use this endpoint to update campaigns if [campaign staging and revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) is enabled for your Application. ### Example @@ -23317,7 +23460,7 @@ Name | Type | Description | Notes Update coupon -Update the specified coupon.

Important

With this PUT endpoint alone, if you do not explicitly set a value for the startDate, expiryDate, and recipientIntegrationId properties in your request, it is automatically set to null.

+Update the specified coupon.

Important

With this PUT endpoint, if you do not explicitly set a value for the startDate, expiryDate, and recipientIntegrationId properties in your request, it is automatically set to null.

### Example @@ -23465,7 +23608,7 @@ Name | Type | Description | Notes Update coupons -Update all coupons, or a specific batch of coupons in the given campaign. You can find the `batchId` in the **Coupons** view of your Application in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount).

Important

To update a specific coupon, use [Update coupon](#operation/updateCoupon). +Update all coupons or a specific batch of coupons in the given campaign. You can find the `batchId` on the **Coupons** page of your campaign in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount).

Important

To update a specific coupon, use [Update coupon](#operation/updateCoupon). ### Example diff --git a/docs/ManagementKey.md b/docs/ManagementKey.md index 2df3314..253b359 100644 --- a/docs/ManagementKey.md +++ b/docs/ManagementKey.md @@ -1,6 +1,5 @@ # ManagementKey - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/MessageLogEntry.md b/docs/MessageLogEntry.md index 3dd1106..d0e760c 100644 --- a/docs/MessageLogEntry.md +++ b/docs/MessageLogEntry.md @@ -9,12 +9,16 @@ Name | Type | Description | Notes **change_type** | **str** | Type of change that triggered the notification. | [optional] **notification_id** | **int** | ID of the notification. | [optional] **notification_name** | **str** | The name of the notification. | [optional] +**webhook_id** | **int** | ID of the webhook. | [optional] +**webhook_name** | **str** | The name of the webhook. | [optional] **request** | [**MessageLogRequest**](MessageLogRequest.md) | | [optional] **response** | [**MessageLogResponse**](MessageLogResponse.md) | | [optional] **created_at** | **datetime** | Timestamp when the log entry was created. | -**entity_type** | **str** | The entity type the notification is related to. | [optional] +**entity_type** | **str** | The entity type the log is related to. | +**url** | **str** | The target URL of the request. | [optional] **application_id** | **int** | Identifier of the Application. | [optional] **loyalty_program_id** | **int** | Identifier of the loyalty program. | [optional] +**campaign_id** | **int** | Identifier of the campaign. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ModelImport.md b/docs/ModelImport.md index 0869ad9..b686f81 100644 --- a/docs/ModelImport.md +++ b/docs/ModelImport.md @@ -1,6 +1,5 @@ # ModelImport - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ModelReturn.md b/docs/ModelReturn.md index 94365b7..aa8079d 100644 --- a/docs/ModelReturn.md +++ b/docs/ModelReturn.md @@ -1,6 +1,5 @@ # ModelReturn - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/MultipleAudiencesItem.md b/docs/MultipleAudiencesItem.md index 4ef0370..5e11898 100644 --- a/docs/MultipleAudiencesItem.md +++ b/docs/MultipleAudiencesItem.md @@ -1,6 +1,5 @@ # MultipleAudiencesItem - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/MultipleCustomerProfileIntegrationRequestItem.md b/docs/MultipleCustomerProfileIntegrationRequestItem.md index 037c153..0eb57dd 100644 --- a/docs/MultipleCustomerProfileIntegrationRequestItem.md +++ b/docs/MultipleCustomerProfileIntegrationRequestItem.md @@ -1,6 +1,6 @@ # MultipleCustomerProfileIntegrationRequestItem - +The body of a V2 integration API request (customer profile update). Next to the customer profile details, this contains an optional listing of extra properties that should be returned in the response. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewAccountSignUp.md b/docs/NewAccountSignUp.md index 0326985..c42ec78 100644 --- a/docs/NewAccountSignUp.md +++ b/docs/NewAccountSignUp.md @@ -1,6 +1,5 @@ # NewAccountSignUp - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewAdditionalCost.md b/docs/NewAdditionalCost.md index ed2924f..af4b43d 100644 --- a/docs/NewAdditionalCost.md +++ b/docs/NewAdditionalCost.md @@ -1,6 +1,5 @@ # NewAdditionalCost - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewApplicationAPIKey.md b/docs/NewApplicationAPIKey.md index e9a4ffc..abfa4c9 100644 --- a/docs/NewApplicationAPIKey.md +++ b/docs/NewApplicationAPIKey.md @@ -1,6 +1,5 @@ # NewApplicationAPIKey - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewApplicationCIF.md b/docs/NewApplicationCIF.md new file mode 100644 index 0000000..f86e7b0 --- /dev/null +++ b/docs/NewApplicationCIF.md @@ -0,0 +1,15 @@ +# NewApplicationCIF + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the Application cart item filter used in API requests. | +**description** | **str** | A short description of the Application cart item filter. | [optional] +**active_expression_id** | **int** | The ID of the expression that the Application cart item filter uses. | [optional] +**modified_by** | **int** | The ID of the user who last updated the Application cart item filter. | [optional] +**created_by** | **int** | The ID of the user who created the Application cart item filter. | [optional] +**modified** | **datetime** | Timestamp of the most recent update to the Application cart item filter. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewApplicationCIFExpression.md b/docs/NewApplicationCIFExpression.md new file mode 100644 index 0000000..5055953 --- /dev/null +++ b/docs/NewApplicationCIFExpression.md @@ -0,0 +1,12 @@ +# NewApplicationCIFExpression + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cart_item_filter_id** | **int** | The ID of the Application cart item filter. | [optional] +**created_by** | **int** | The ID of the user who created the Application cart item filter. | [optional] +**expression** | **list[object]** | Arbitrary additional JSON data associated with the Application cart item filter. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewAttribute.md b/docs/NewAttribute.md index cd9bd83..2331569 100644 --- a/docs/NewAttribute.md +++ b/docs/NewAttribute.md @@ -1,6 +1,5 @@ # NewAttribute - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewAudience.md b/docs/NewAudience.md index 640ae82..1a7de72 100644 --- a/docs/NewAudience.md +++ b/docs/NewAudience.md @@ -1,6 +1,5 @@ # NewAudience - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewBaseNotification.md b/docs/NewBaseNotification.md index 0d99a97..c9ca27a 100644 --- a/docs/NewBaseNotification.md +++ b/docs/NewBaseNotification.md @@ -1,6 +1,5 @@ # NewBaseNotification - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewCampaign.md b/docs/NewCampaign.md index c0d105a..5917168 100644 --- a/docs/NewCampaign.md +++ b/docs/NewCampaign.md @@ -1,6 +1,5 @@ # NewCampaign - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewCampaignCollection.md b/docs/NewCampaignCollection.md index 3e51caf..c604c12 100644 --- a/docs/NewCampaignCollection.md +++ b/docs/NewCampaignCollection.md @@ -1,6 +1,5 @@ # NewCampaignCollection - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewCampaignSet.md b/docs/NewCampaignSet.md index 133cbf4..e9cc893 100644 --- a/docs/NewCampaignSet.md +++ b/docs/NewCampaignSet.md @@ -1,6 +1,5 @@ # NewCampaignSet - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewCampaignStoreBudget.md b/docs/NewCampaignStoreBudget.md new file mode 100644 index 0000000..a889d76 --- /dev/null +++ b/docs/NewCampaignStoreBudget.md @@ -0,0 +1,12 @@ +# NewCampaignStoreBudget + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | **str** | | +**store_limits** | [**list[NewCampaignStoreBudgetStoreLimit]**](NewCampaignStoreBudgetStoreLimit.md) | The set of budget limits for stores linked to the campaign. | +**period** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewCampaignStoreBudgetStoreLimit.md b/docs/NewCampaignStoreBudgetStoreLimit.md new file mode 100644 index 0000000..14819b3 --- /dev/null +++ b/docs/NewCampaignStoreBudgetStoreLimit.md @@ -0,0 +1,11 @@ +# NewCampaignStoreBudgetStoreLimit + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**store_id** | **int** | The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. | +**limit** | **float** | The value to set for the limit. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewCampaignTemplate.md b/docs/NewCampaignTemplate.md index 5e8c5a8..dda6199 100644 --- a/docs/NewCampaignTemplate.md +++ b/docs/NewCampaignTemplate.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **tags** | **list[str]** | A list of tags for the campaign template. | [optional] **features** | **list[str]** | A list of features for the campaign template. | [optional] **coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**coupon_reservation_settings** | [**CampaignTemplateCouponReservationSettings**](CampaignTemplateCouponReservationSettings.md) | | [optional] **referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **limits** | [**list[TemplateLimitConfig]**](TemplateLimitConfig.md) | The set of limits that will operate for this campaign template. | [optional] **template_params** | [**list[CampaignTemplateParams]**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional] diff --git a/docs/NewCatalog.md b/docs/NewCatalog.md index 19fc651..67e979b 100644 --- a/docs/NewCatalog.md +++ b/docs/NewCatalog.md @@ -1,6 +1,5 @@ # NewCatalog - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewCollection.md b/docs/NewCollection.md index 5d06d3c..8351e58 100644 --- a/docs/NewCollection.md +++ b/docs/NewCollection.md @@ -1,6 +1,5 @@ # NewCollection - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewCouponCreationJob.md b/docs/NewCouponCreationJob.md index 2a0afcb..9066e2c 100644 --- a/docs/NewCouponCreationJob.md +++ b/docs/NewCouponCreationJob.md @@ -1,6 +1,5 @@ # NewCouponCreationJob - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewCoupons.md b/docs/NewCoupons.md index 195b738..794fbe0 100644 --- a/docs/NewCoupons.md +++ b/docs/NewCoupons.md @@ -1,6 +1,5 @@ # NewCoupons - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewCouponsForMultipleRecipients.md b/docs/NewCouponsForMultipleRecipients.md index 22a842a..104c617 100644 --- a/docs/NewCouponsForMultipleRecipients.md +++ b/docs/NewCouponsForMultipleRecipients.md @@ -1,6 +1,5 @@ # NewCouponsForMultipleRecipients - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewCustomEffect.md b/docs/NewCustomEffect.md index e51b4c8..de79800 100644 --- a/docs/NewCustomEffect.md +++ b/docs/NewCustomEffect.md @@ -1,6 +1,5 @@ # NewCustomEffect - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewCustomerSession.md b/docs/NewCustomerSession.md index 08e5eaa..bc73a77 100644 --- a/docs/NewCustomerSession.md +++ b/docs/NewCustomerSession.md @@ -1,6 +1,5 @@ # NewCustomerSession - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewCustomerSessionV2.md b/docs/NewCustomerSessionV2.md index b169745..8a4b0c8 100644 --- a/docs/NewCustomerSessionV2.md +++ b/docs/NewCustomerSessionV2.md @@ -7,13 +7,13 @@ Name | Type | Description | Notes **profile_id** | **str** | 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] **store_integration_id** | **str** | The integration ID of the store. You choose this ID when you create a store. | [optional] **evaluable_campaign_ids** | **list[int]** | 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] -**coupon_codes** | **list[str]** | 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] -**referral_code** | **str** | 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] +**coupon_codes** | **list[str]** | Any coupon codes entered. **Important - for requests only**: - 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. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, omit the parameter entirely. | [optional] +**referral_code** | **str** | Any referral code entered. **Important - for requests only**: - 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. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, omit the parameter entirely. | [optional] **loyalty_cards** | **list[str]** | Identifier of a loyalty card. | [optional] **state** | **str** | 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-sessions). | [optional] [default to 'open'] **cart_items** | [**list[CartItem]**](CartItem.md) | The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. | [optional] **additional_costs** | [**dict(str, 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** | **list[str]** | 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] +**identifiers** | **list[str]** | 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). - We recommend passing an anonymized (hashed) version of the identifier value. | [optional] **attributes** | [**object**](.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] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/NewEvent.md b/docs/NewEvent.md index 90a8668..3cd5e6a 100644 --- a/docs/NewEvent.md +++ b/docs/NewEvent.md @@ -1,6 +1,5 @@ # NewEvent - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewEventType.md b/docs/NewEventType.md index b54c5b2..90348b8 100644 --- a/docs/NewEventType.md +++ b/docs/NewEventType.md @@ -1,6 +1,5 @@ # NewEventType - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewLoyaltyProgram.md b/docs/NewLoyaltyProgram.md index b88fc70..b109a8b 100644 --- a/docs/NewLoyaltyProgram.md +++ b/docs/NewLoyaltyProgram.md @@ -1,6 +1,6 @@ # NewLoyaltyProgram - +A new loyalty program ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -18,6 +18,7 @@ Name | Type | Description | Notes **tiers_expire_in** | **str** | The amount of time after which the tier expires and is reevaluated. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years 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, months and years. Signifies the end of the day, week, month or year. | [optional] **tiers_downgrade_policy** | **str** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional] **card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**return_policy** | **str** | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. | [optional] **name** | **str** | The internal name for the Loyalty Program. This is an immutable value. | **tiers** | [**list[NewLoyaltyTier]**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] **timezone** | **str** | A string containing an IANA timezone descriptor. | diff --git a/docs/NewLoyaltyTier.md b/docs/NewLoyaltyTier.md index 464d3a4..ad61223 100644 --- a/docs/NewLoyaltyTier.md +++ b/docs/NewLoyaltyTier.md @@ -4,8 +4,8 @@ A tier in a loyalty program. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | The name of the tier | -**min_points** | **float** | The minimum amount of points required to be eligible for the tier. | +**name** | **str** | The name of the tier. | +**min_points** | **float** | The minimum amount of points required to enter the tier. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/NewManagementKey.md b/docs/NewManagementKey.md index 5ecbddb..3ee33a0 100644 --- a/docs/NewManagementKey.md +++ b/docs/NewManagementKey.md @@ -1,6 +1,5 @@ # NewManagementKey - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewMultipleAudiencesItem.md b/docs/NewMultipleAudiencesItem.md index c524db0..ed92857 100644 --- a/docs/NewMultipleAudiencesItem.md +++ b/docs/NewMultipleAudiencesItem.md @@ -1,6 +1,5 @@ # NewMultipleAudiencesItem - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewReferral.md b/docs/NewReferral.md index 4d96019..3979f35 100644 --- a/docs/NewReferral.md +++ b/docs/NewReferral.md @@ -1,6 +1,5 @@ # NewReferral - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewReferralsForMultipleAdvocates.md b/docs/NewReferralsForMultipleAdvocates.md index 2033aa5..448ad01 100644 --- a/docs/NewReferralsForMultipleAdvocates.md +++ b/docs/NewReferralsForMultipleAdvocates.md @@ -1,6 +1,5 @@ # NewReferralsForMultipleAdvocates - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewRevisionVersion.md b/docs/NewRevisionVersion.md new file mode 100644 index 0000000..fabebeb --- /dev/null +++ b/docs/NewRevisionVersion.md @@ -0,0 +1,20 @@ +# NewRevisionVersion + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | A user-facing name for this campaign. | [optional] +**start_time** | **datetime** | Timestamp when the campaign will become active. | [optional] +**end_time** | **datetime** | Timestamp when the campaign will become inactive. | [optional] +**attributes** | [**object**](.md) | Arbitrary properties associated with this campaign. | [optional] +**description** | **str** | A detailed description of the campaign. | [optional] +**active_ruleset_id** | **int** | The ID of the ruleset this campaign template will use. | [optional] +**tags** | **list[str]** | A list of tags for the campaign template. | [optional] +**coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**limits** | [**list[LimitConfig]**](LimitConfig.md) | The set of limits that will operate for this campaign version. | [optional] +**features** | **list[str]** | A list of features for the campaign template. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewRole.md b/docs/NewRole.md index 512a843..3ae6685 100644 --- a/docs/NewRole.md +++ b/docs/NewRole.md @@ -1,6 +1,5 @@ # NewRole - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewRoleV2.md b/docs/NewRoleV2.md index 624b76f..af263da 100644 --- a/docs/NewRoleV2.md +++ b/docs/NewRoleV2.md @@ -1,6 +1,5 @@ # NewRoleV2 - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewSamlConnection.md b/docs/NewSamlConnection.md index 5c543c3..6f57c45 100644 --- a/docs/NewSamlConnection.md +++ b/docs/NewSamlConnection.md @@ -1,6 +1,6 @@ # NewSamlConnection - +A new SAML 2.0 connection. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewStore.md b/docs/NewStore.md index 54cc9f3..b5d9661 100644 --- a/docs/NewStore.md +++ b/docs/NewStore.md @@ -1,6 +1,5 @@ # NewStore - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewUser.md b/docs/NewUser.md index 1426e4a..0e4e3db 100644 --- a/docs/NewUser.md +++ b/docs/NewUser.md @@ -1,6 +1,5 @@ # NewUser - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NewWebhook.md b/docs/NewWebhook.md index 934b33f..7a36c9a 100644 --- a/docs/NewWebhook.md +++ b/docs/NewWebhook.md @@ -1,10 +1,9 @@ # NewWebhook - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**application_ids** | **list[int]** | The IDs of the Applications that are related to this entity. | +**application_ids** | **list[int]** | The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. | **title** | **str** | Name or title for this webhook. | **description** | **str** | A description of the webhook. | [optional] **verb** | **str** | API method for this webhook. | diff --git a/docs/OutgoingIntegrationTemplateWithConfigurationDetails.md b/docs/OutgoingIntegrationTemplateWithConfigurationDetails.md index bc6f4e3..e69cef5 100644 --- a/docs/OutgoingIntegrationTemplateWithConfigurationDetails.md +++ b/docs/OutgoingIntegrationTemplateWithConfigurationDetails.md @@ -1,6 +1,5 @@ # OutgoingIntegrationTemplateWithConfigurationDetails - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Picklist.md b/docs/Picklist.md index db521d3..b4ef02d 100644 --- a/docs/Picklist.md +++ b/docs/Picklist.md @@ -1,6 +1,5 @@ # Picklist - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Product.md b/docs/Product.md index a0c6641..04785fd 100644 --- a/docs/Product.md +++ b/docs/Product.md @@ -4,7 +4,7 @@ The specific properties of the product this item belongs to, if available. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | The name of the product. | +**name** | **str** | The product the item belongs to. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ProductSearchMatch.md b/docs/ProductSearchMatch.md new file mode 100644 index 0000000..335576c --- /dev/null +++ b/docs/ProductSearchMatch.md @@ -0,0 +1,12 @@ +# ProductSearchMatch + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**product_id** | **int** | The ID of the product. | +**value** | **str** | The string matching the given value. Either a product name or SKU. | +**product_sku_id** | **int** | The ID of the SKU linked to a product. If empty, this is an analytics-level product. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ProductSkuUnitAnalytics.md b/docs/ProductSkuUnitAnalytics.md new file mode 100644 index 0000000..239ab4a --- /dev/null +++ b/docs/ProductSkuUnitAnalytics.md @@ -0,0 +1,13 @@ +# ProductSkuUnitAnalytics + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_time** | **datetime** | The start of the aggregation time frame in UTC. | +**end_time** | **datetime** | The end of the aggregation time frame in UTC. | +**purchased_units** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | +**sku** | **str** | The SKU linked to the analytics-level product. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ProductUnitAnalytics.md b/docs/ProductUnitAnalytics.md new file mode 100644 index 0000000..792b419 --- /dev/null +++ b/docs/ProductUnitAnalytics.md @@ -0,0 +1,14 @@ +# ProductUnitAnalytics + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_time** | **datetime** | The start of the aggregation time frame in UTC. | +**end_time** | **datetime** | The end of the aggregation time frame in UTC. | +**purchased_units** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | +**product_id** | **int** | The ID of the analytics-level product. | +**product_name** | **str** | The name of the analytics-level product. | + +[[Back to Model list]](../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 7be1750..0784578 100644 --- a/docs/Referral.md +++ b/docs/Referral.md @@ -1,6 +1,5 @@ # Referral - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Revision.md b/docs/Revision.md new file mode 100644 index 0000000..25bdb77 --- /dev/null +++ b/docs/Revision.md @@ -0,0 +1,19 @@ +# Revision + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**activate_at** | **datetime** | | [optional] +**account_id** | **int** | | +**application_id** | **int** | | +**campaign_id** | **int** | | +**created** | **datetime** | | +**created_by** | **int** | | +**activated_at** | **datetime** | | [optional] +**activated_by** | **int** | | [optional] +**current_version** | [**RevisionVersion**](RevisionVersion.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RevisionActivation.md b/docs/RevisionActivation.md new file mode 100644 index 0000000..26074af --- /dev/null +++ b/docs/RevisionActivation.md @@ -0,0 +1,10 @@ +# RevisionActivation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**activate_at** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RevisionVersion.md b/docs/RevisionVersion.md new file mode 100644 index 0000000..e58228f --- /dev/null +++ b/docs/RevisionVersion.md @@ -0,0 +1,28 @@ +# RevisionVersion + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | +**account_id** | **int** | | +**application_id** | **int** | | +**campaign_id** | **int** | | +**created** | **datetime** | | +**created_by** | **int** | | +**revision_id** | **int** | | +**version** | **int** | | +**name** | **str** | A user-facing name for this campaign. | [optional] +**start_time** | **datetime** | Timestamp when the campaign will become active. | [optional] +**end_time** | **datetime** | Timestamp when the campaign will become inactive. | [optional] +**attributes** | [**object**](.md) | Arbitrary properties associated with this campaign. | [optional] +**description** | **str** | A detailed description of the campaign. | [optional] +**active_ruleset_id** | **int** | The ID of the ruleset this campaign template will use. | [optional] +**tags** | **list[str]** | A list of tags for the campaign template. | [optional] +**coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**limits** | [**list[LimitConfig]**](LimitConfig.md) | The set of limits that will operate for this campaign version. | [optional] +**features** | **list[str]** | A list of features for the campaign template. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Role.md b/docs/Role.md index 2804761..c1bf9a0 100644 --- a/docs/Role.md +++ b/docs/Role.md @@ -1,6 +1,5 @@ # Role - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RoleAssign.md b/docs/RoleAssign.md index 0c2acd9..7c7402d 100644 --- a/docs/RoleAssign.md +++ b/docs/RoleAssign.md @@ -1,6 +1,5 @@ # RoleAssign - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RoleV2.md b/docs/RoleV2.md index 646cca5..0ed6f1d 100644 --- a/docs/RoleV2.md +++ b/docs/RoleV2.md @@ -1,6 +1,5 @@ # RoleV2 - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Ruleset.md b/docs/Ruleset.md index 7688c83..60560e7 100644 --- a/docs/Ruleset.md +++ b/docs/Ruleset.md @@ -1,6 +1,5 @@ # Ruleset - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/SamlConnection.md b/docs/SamlConnection.md index d3fc342..fc8af0c 100644 --- a/docs/SamlConnection.md +++ b/docs/SamlConnection.md @@ -1,6 +1,6 @@ # SamlConnection - +A SAML 2.0 connection. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ScimBaseUser.md b/docs/ScimBaseUser.md new file mode 100644 index 0000000..c07367a --- /dev/null +++ b/docs/ScimBaseUser.md @@ -0,0 +1,14 @@ +# ScimBaseUser + +Schema definition for base user fields, provisioned using the SCIM protocol and used by Talon.One. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**active** | **bool** | Status of the user. | [optional] +**display_name** | **str** | Display name of the user. | [optional] +**user_name** | **str** | Unique identifier of the user. This is usually an email address. | [optional] +**name** | [**ScimBaseUserName**](ScimBaseUserName.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScimBaseUserName.md b/docs/ScimBaseUserName.md new file mode 100644 index 0000000..059872b --- /dev/null +++ b/docs/ScimBaseUserName.md @@ -0,0 +1,11 @@ +# ScimBaseUserName + +The components of the user’s real name. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**formatted** | **str** | The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScimNewUser.md b/docs/ScimNewUser.md index 5c5c317..c43b234 100644 --- a/docs/ScimNewUser.md +++ b/docs/ScimNewUser.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **active** | **bool** | Status of the user. | [optional] **display_name** | **str** | Display name of the user. | [optional] **user_name** | **str** | Unique identifier of the user. This is usually an email address. | +**name** | [**ScimBaseUserName**](ScimBaseUserName.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ScimPatchOperation.md b/docs/ScimPatchOperation.md new file mode 100644 index 0000000..be4c12e --- /dev/null +++ b/docs/ScimPatchOperation.md @@ -0,0 +1,13 @@ +# ScimPatchOperation + +Patch operation that is used to update the information. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **str** | The method that should be used in the operation. | +**path** | **str** | The path specifying the attribute that should be updated. | [optional] +**value** | **str** | The value that should be updated. Required if `op` is `add` or `replace`. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScimPatchRequest.md b/docs/ScimPatchRequest.md new file mode 100644 index 0000000..b667516 --- /dev/null +++ b/docs/ScimPatchRequest.md @@ -0,0 +1,12 @@ +# ScimPatchRequest + +SCIM Patch request +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**schemas** | **list[str]** | SCIM schema for the given resource. | [optional] +**operations** | [**list[ScimPatchOperation]**](ScimPatchOperation.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScimResource.md b/docs/ScimResource.md index b1ad35c..067cd6e 100644 --- a/docs/ScimResource.md +++ b/docs/ScimResource.md @@ -1,11 +1,12 @@ # ScimResource -Resource schema definition for the SCIM provisioning protocol. +Resource definition for the SCIM provisioning protocol. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | ID of the resource. | [optional] **name** | **str** | Name of the resource. | [optional] +**description** | **str** | Human-readable description of the resource. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ScimSchemaResource.md b/docs/ScimSchemaResource.md new file mode 100644 index 0000000..35c509e --- /dev/null +++ b/docs/ScimSchemaResource.md @@ -0,0 +1,14 @@ +# ScimSchemaResource + +Resource schema definition for the SCIM provisioning protocol. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the resource. | [optional] +**name** | **str** | Name of the resource. | [optional] +**description** | **str** | Human-readable description of the schema resource. | [optional] +**attributes** | **list[object]** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScimSchemasListResponse.md b/docs/ScimSchemasListResponse.md new file mode 100644 index 0000000..a257d9a --- /dev/null +++ b/docs/ScimSchemasListResponse.md @@ -0,0 +1,13 @@ +# ScimSchemasListResponse + +List of resource schemas supported by the SCIM provisioning protocol. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**resources** | [**list[ScimSchemaResource]**](ScimSchemaResource.md) | | +**schemas** | **list[str]** | SCIM schema for the given resource. | [optional] +**total_results** | **int** | Number of total results in the response. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScimServiceProviderConfigResponse.md b/docs/ScimServiceProviderConfigResponse.md new file mode 100644 index 0000000..e29d525 --- /dev/null +++ b/docs/ScimServiceProviderConfigResponse.md @@ -0,0 +1,17 @@ +# ScimServiceProviderConfigResponse + +Service provider configuration details. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bulk** | [**ScimServiceProviderConfigResponseBulk**](ScimServiceProviderConfigResponseBulk.md) | | [optional] +**change_password** | [**ScimServiceProviderConfigResponseChangePassword**](ScimServiceProviderConfigResponseChangePassword.md) | | [optional] +**documentation_uri** | **str** | The URI that points to the SCIM service provider's documentation, providing further details about the service's capabilities and usage. | [optional] +**filter** | [**ScimServiceProviderConfigResponseFilter**](ScimServiceProviderConfigResponseFilter.md) | | [optional] +**patch** | [**ScimServiceProviderConfigResponsePatch**](ScimServiceProviderConfigResponsePatch.md) | | [optional] +**schemas** | **list[str]** | A list of SCIM schemas that define the structure and data types supported by the service provider. | [optional] +**sort** | [**ScimServiceProviderConfigResponseSort**](ScimServiceProviderConfigResponseSort.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScimServiceProviderConfigResponseBulk.md b/docs/ScimServiceProviderConfigResponseBulk.md new file mode 100644 index 0000000..d3c81ed --- /dev/null +++ b/docs/ScimServiceProviderConfigResponseBulk.md @@ -0,0 +1,13 @@ +# ScimServiceProviderConfigResponseBulk + +Configuration related to bulk operations, which allow multiple SCIM requests to be processed in a single HTTP request. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_operations** | **int** | The maximum number of individual operations that can be included in a single bulk request. | [optional] +**max_payload_size** | **int** | The maximum size, in bytes, of the entire payload for a bulk operation request. | [optional] +**supported** | **bool** | Indicates whether the SCIM service provider supports bulk operations. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScimServiceProviderConfigResponseChangePassword.md b/docs/ScimServiceProviderConfigResponseChangePassword.md new file mode 100644 index 0000000..b5eeee7 --- /dev/null +++ b/docs/ScimServiceProviderConfigResponseChangePassword.md @@ -0,0 +1,11 @@ +# ScimServiceProviderConfigResponseChangePassword + +Configuration settings related to the ability to change user passwords. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**supported** | **bool** | Indicates whether the service provider supports password changes via the SCIM API. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScimServiceProviderConfigResponseFilter.md b/docs/ScimServiceProviderConfigResponseFilter.md new file mode 100644 index 0000000..3c6fb7b --- /dev/null +++ b/docs/ScimServiceProviderConfigResponseFilter.md @@ -0,0 +1,12 @@ +# ScimServiceProviderConfigResponseFilter + +Configuration settings related to filtering SCIM resources based on specific criteria. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_results** | **int** | The maximum number of resources that can be returned in a single filtered query response. | [optional] +**supported** | **bool** | Indicates whether the SCIM service provider supports filtering operations. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScimServiceProviderConfigResponsePatch.md b/docs/ScimServiceProviderConfigResponsePatch.md new file mode 100644 index 0000000..371bb5d --- /dev/null +++ b/docs/ScimServiceProviderConfigResponsePatch.md @@ -0,0 +1,11 @@ +# ScimServiceProviderConfigResponsePatch + +Configuration settings related to patch operations, which allow partial updates to SCIM resources. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**supported** | **bool** | Indicates whether the service provider supports patch operations for modifying resources. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScimServiceProviderConfigResponseSort.md b/docs/ScimServiceProviderConfigResponseSort.md new file mode 100644 index 0000000..ef46c42 --- /dev/null +++ b/docs/ScimServiceProviderConfigResponseSort.md @@ -0,0 +1,11 @@ +# ScimServiceProviderConfigResponseSort + +Configuration settings related to sorting SCIM resources in query responses. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**supported** | **bool** | Indicates whether the service provider supports sorting operations for ordered query results. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ScimUser.md b/docs/ScimUser.md index 75ce666..2a7af95 100644 --- a/docs/ScimUser.md +++ b/docs/ScimUser.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **active** | **bool** | Status of the user. | [optional] **display_name** | **str** | Display name of the user. | [optional] **user_name** | **str** | Unique identifier of the user. This is usually an email address. | +**name** | [**ScimBaseUserName**](ScimBaseUserName.md) | | [optional] **id** | **str** | ID of the user. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ScimUsersListResponse.md b/docs/ScimUsersListResponse.md index d775c2d..2d5ba4a 100644 --- a/docs/ScimUsersListResponse.md +++ b/docs/ScimUsersListResponse.md @@ -5,7 +5,7 @@ List of users that have been provisioned using the SCIM protocol with an identit Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **resources** | [**list[ScimUser]**](ScimUser.md) | | -**schemas** | **list[str]** | | [optional] +**schemas** | **list[str]** | SCIM schema for the given resource. | [optional] **total_results** | **int** | Number of total results in the response. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Store.md b/docs/Store.md index 4315283..609db91 100644 --- a/docs/Store.md +++ b/docs/Store.md @@ -1,11 +1,10 @@ # Store - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Internal ID of this entity. | -**created** | **datetime** | The time this entity was created. The time this entity was created. | +**created** | **datetime** | The time this entity was created. | **name** | **str** | The name of the store. | **description** | **str** | The description of the store. | **attributes** | [**object**](.md) | The attributes of the store. | [optional] diff --git a/docs/StrikethroughDebugResponse.md b/docs/StrikethroughDebugResponse.md new file mode 100644 index 0000000..2fb8c1e --- /dev/null +++ b/docs/StrikethroughDebugResponse.md @@ -0,0 +1,11 @@ +# StrikethroughDebugResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaigns_i_ds** | **list[int]** | The campaign IDs that got fetched for the evaluation process. | [optional] +**effects** | [**list[StrikethroughEffect]**](StrikethroughEffect.md) | The strikethrough effects that are returned from the evaluation process. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/SummaryCampaignStoreBudget.md b/docs/SummaryCampaignStoreBudget.md new file mode 100644 index 0000000..6e28b80 --- /dev/null +++ b/docs/SummaryCampaignStoreBudget.md @@ -0,0 +1,12 @@ +# SummaryCampaignStoreBudget + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | **str** | | +**period** | **str** | | [optional] +**store_count** | **int** | | + +[[Back to Model list]](../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 index d9923c8..4c6e3ea 100644 --- a/docs/TalangAttribute.md +++ b/docs/TalangAttribute.md @@ -1,6 +1,5 @@ # TalangAttribute - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TemplateArgDef.md b/docs/TemplateArgDef.md index 3c62f5e..bbfc8e7 100644 --- a/docs/TemplateArgDef.md +++ b/docs/TemplateArgDef.md @@ -1,6 +1,5 @@ # TemplateArgDef - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -8,6 +7,7 @@ Name | Type | Description | Notes **description** | **str** | A campaigner-friendly description of the argument, this will also be shown in the rule editor. | [optional] **title** | **str** | A campaigner friendly name for the argument, this will be shown in the rule editor. | **ui** | [**object**](.md) | Arbitrary metadata that may be used to render an input for this argument. | +**key** | **str** | The identifier for the associated value within the JSON object. | [optional] **picklist_id** | **int** | ID of the picklist linked to a template. | [optional] **restricted_by_picklist** | **bool** | Whether or not this attribute's value is restricted by picklist (`picklist` property) | [optional] diff --git a/docs/TemplateDef.md b/docs/TemplateDef.md index bb153ef..c6e7e21 100644 --- a/docs/TemplateDef.md +++ b/docs/TemplateDef.md @@ -1,6 +1,5 @@ # TemplateDef - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TemplateLimitConfig.md b/docs/TemplateLimitConfig.md index b901267..5273a40 100644 --- a/docs/TemplateLimitConfig.md +++ b/docs/TemplateLimitConfig.md @@ -1,6 +1,5 @@ # TemplateLimitConfig - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/UpdateAchievement.md b/docs/UpdateAchievement.md index 98e202b..ea49c7d 100644 --- a/docs/UpdateAchievement.md +++ b/docs/UpdateAchievement.md @@ -9,6 +9,10 @@ Name | Type | Description | Notes **target** | **float** | The required number of actions or the transactional milestone to complete the achievement. | [optional] **period** | **str** | The relative duration after which the achievement ends and resets for a particular customer profile. | [optional] **period_end_override** | [**TimePoint**](TimePoint.md) | | [optional] +**recurrence_policy** | **str** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional] +**activation_policy** | **str** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional] +**fixed_start_date** | **datetime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional] +**end_date** | **datetime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional] [[Back to Model list]](../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 eab5178..6862890 100644 --- a/docs/UpdateApplication.md +++ b/docs/UpdateApplication.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes **enable_partial_discounts** | **bool** | Indicates if this Application supports partial discounts. | [optional] **default_discount_additional_cost_per_item_scope** | **str** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional] **default_evaluation_group_id** | **int** | The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign. | [optional] +**default_cart_item_filter_id** | **int** | The ID of the default Cart-Item-Filter for this application. | [optional] **enable_campaign_state_management** | **bool** | Indicates whether the campaign staging and revisions feature is enabled for the Application. **Important:** After this feature is enabled, it cannot be disabled. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateApplicationCIF.md b/docs/UpdateApplicationCIF.md new file mode 100644 index 0000000..68b69fe --- /dev/null +++ b/docs/UpdateApplicationCIF.md @@ -0,0 +1,13 @@ +# UpdateApplicationCIF + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | A short description of the Application cart item filter. | [optional] +**active_expression_id** | **int** | The ID of the expression that the Application cart item filter uses. | [optional] +**modified_by** | **int** | The ID of the user who last updated the Application cart item filter. | [optional] +**modified** | **datetime** | Timestamp of the most recent update to the Application cart item filter. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateCampaign.md b/docs/UpdateCampaign.md index a368861..2919eb7 100644 --- a/docs/UpdateCampaign.md +++ b/docs/UpdateCampaign.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes **campaign_groups** | **list[int]** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to. | [optional] **evaluation_group_id** | **int** | The ID of the campaign evaluation group the campaign belongs to. | [optional] **type** | **str** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] [default to 'advanced'] -**linked_store_ids** | **list[int]** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] +**linked_store_ids** | **list[int]** | A list of store IDs that you want to link to the campaign. **Note:** - Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty. - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateCampaignEvaluationGroup.md b/docs/UpdateCampaignEvaluationGroup.md index a0ca0b7..7936c73 100644 --- a/docs/UpdateCampaignEvaluationGroup.md +++ b/docs/UpdateCampaignEvaluationGroup.md @@ -1,6 +1,5 @@ # UpdateCampaignEvaluationGroup - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/UpdateCampaignGroup.md b/docs/UpdateCampaignGroup.md index 16bac45..3425444 100644 --- a/docs/UpdateCampaignGroup.md +++ b/docs/UpdateCampaignGroup.md @@ -1,6 +1,5 @@ # UpdateCampaignGroup - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/UpdateCampaignTemplate.md b/docs/UpdateCampaignTemplate.md index a14e012..75f76e1 100644 --- a/docs/UpdateCampaignTemplate.md +++ b/docs/UpdateCampaignTemplate.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **tags** | **list[str]** | A list of tags for the campaign template. | [optional] **features** | **list[str]** | A list of features for the campaign template. | [optional] **coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**coupon_reservation_settings** | [**CampaignTemplateCouponReservationSettings**](CampaignTemplateCouponReservationSettings.md) | | [optional] **referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **limits** | [**list[TemplateLimitConfig]**](TemplateLimitConfig.md) | The set of limits that operate for this campaign template. | [optional] **template_params** | [**list[CampaignTemplateParams]**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional] diff --git a/docs/UpdateCoupon.md b/docs/UpdateCoupon.md index e713fea..e0a27cb 100644 --- a/docs/UpdateCoupon.md +++ b/docs/UpdateCoupon.md @@ -1,6 +1,5 @@ # UpdateCoupon - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/UpdateCouponBatch.md b/docs/UpdateCouponBatch.md index 152277c..b53e5a7 100644 --- a/docs/UpdateCouponBatch.md +++ b/docs/UpdateCouponBatch.md @@ -1,6 +1,5 @@ # UpdateCouponBatch - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/UpdateLoyaltyProgram.md b/docs/UpdateLoyaltyProgram.md index 75f78db..b66d3a1 100644 --- a/docs/UpdateLoyaltyProgram.md +++ b/docs/UpdateLoyaltyProgram.md @@ -1,6 +1,6 @@ # UpdateLoyaltyProgram - +An updated loyalty program. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -18,6 +18,7 @@ Name | Type | Description | Notes **tiers_expire_in** | **str** | The amount of time after which the tier expires and is reevaluated. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years 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, months and years. Signifies the end of the day, week, month or year. | [optional] **tiers_downgrade_policy** | **str** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional] **card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**return_policy** | **str** | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. | [optional] **tiers** | [**list[NewLoyaltyTier]**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateLoyaltyProgramTier.md b/docs/UpdateLoyaltyProgramTier.md new file mode 100644 index 0000000..b7540e5 --- /dev/null +++ b/docs/UpdateLoyaltyProgramTier.md @@ -0,0 +1,13 @@ +# UpdateLoyaltyProgramTier + +Update a tier in a specified loyalty program. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | The internal ID of the tier. | +**name** | **str** | The name of the tier. | [optional] +**min_points** | **float** | The minimum amount of points required to enter the tier. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdatePicklist.md b/docs/UpdatePicklist.md index 268f43a..34b03e2 100644 --- a/docs/UpdatePicklist.md +++ b/docs/UpdatePicklist.md @@ -1,6 +1,5 @@ # UpdatePicklist - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/User.md b/docs/User.md index ad9e384..aaf3ba3 100644 --- a/docs/User.md +++ b/docs/User.md @@ -1,6 +1,5 @@ # User - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ValueMap.md b/docs/ValueMap.md new file mode 100644 index 0000000..f16ef43 --- /dev/null +++ b/docs/ValueMap.md @@ -0,0 +1,13 @@ +# ValueMap + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | Unique 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** | **datetime** | | [optional] +**created_by** | **int** | The ID of the user who created the value map. | [optional] +**campaign_id** | **int** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Webhook.md b/docs/Webhook.md index 1b02dbe..bc83f44 100644 --- a/docs/Webhook.md +++ b/docs/Webhook.md @@ -1,13 +1,12 @@ # Webhook - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Internal ID of this entity. | **created** | **datetime** | The time this entity was created. | **modified** | **datetime** | The time this entity was last modified. | -**application_ids** | **list[int]** | The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity. | +**application_ids** | **list[int]** | The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. | **title** | **str** | Name or title for this webhook. | **description** | **str** | A description of the webhook. | [optional] **verb** | **str** | API method for this webhook. | diff --git a/docs/WebhookLogEntry.md b/docs/WebhookLogEntry.md index e7375be..09da9e9 100644 --- a/docs/WebhookLogEntry.md +++ b/docs/WebhookLogEntry.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **integration_request_uuid** | **str** | UUID reference of the integration request linked to this webhook request. | **webhook_id** | **int** | ID of the webhook that triggered the request. | **application_id** | **int** | ID of the application that triggered the webhook. | [optional] -**url** | **str** | Target url of request | +**url** | **str** | The target URL of the request. | **request** | **str** | Request message | **response** | **str** | Response message | [optional] **status** | **int** | HTTP status code of response. | [optional] diff --git a/docs/WebhookWithOutgoingIntegrationDetails.md b/docs/WebhookWithOutgoingIntegrationDetails.md index b19ffd9..72cc420 100644 --- a/docs/WebhookWithOutgoingIntegrationDetails.md +++ b/docs/WebhookWithOutgoingIntegrationDetails.md @@ -1,13 +1,12 @@ # WebhookWithOutgoingIntegrationDetails - ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **int** | Internal ID of this entity. | **created** | **datetime** | The time this entity was created. | **modified** | **datetime** | The time this entity was last modified. | -**application_ids** | **list[int]** | The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity. | +**application_ids** | **list[int]** | The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. | **title** | **str** | Name or title for this webhook. | **description** | **str** | A description of the webhook. | [optional] **verb** | **str** | API method for this webhook. | diff --git a/setup.py b/setup.py index 1ed2e4e..a5539d4 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ # http://pypi.python.org/pypi/setuptools NAME = "talon-one-python-sdk" -VERSION = "6.1.1" +VERSION = "7.0.0" # Get the long description from the README.md file here = pathlib.Path(__file__).parent.resolve() diff --git a/talon_one/__init__.py b/talon_one/__init__.py index f8ea252..bd58973 100644 --- a/talon_one/__init__.py +++ b/talon_one/__init__.py @@ -14,7 +14,7 @@ from __future__ import absolute_import -__version__ = "6.1.1" +__version__ = "7.0.0" # import apis into sdk package from talon_one.api.integration_api import IntegrationApi @@ -47,7 +47,6 @@ from talon_one.models.achievement import Achievement from talon_one.models.achievement_additional_properties import AchievementAdditionalProperties from talon_one.models.achievement_progress import AchievementProgress -from talon_one.models.activate_user_request import ActivateUserRequest from talon_one.models.add_free_item_effect_props import AddFreeItemEffectProps from talon_one.models.add_item_catalog_action import AddItemCatalogAction from talon_one.models.add_loyalty_points import AddLoyaltyPoints @@ -60,10 +59,14 @@ from talon_one.models.analytics_data_point_with_trend import AnalyticsDataPointWithTrend from talon_one.models.analytics_data_point_with_trend_and_influenced_rate import AnalyticsDataPointWithTrendAndInfluencedRate from talon_one.models.analytics_data_point_with_trend_and_uplift import AnalyticsDataPointWithTrendAndUplift +from talon_one.models.analytics_product import AnalyticsProduct +from talon_one.models.analytics_product_sku import AnalyticsProductSKU from talon_one.models.application import Application from talon_one.models.application_api_key import ApplicationAPIKey from talon_one.models.application_analytics_data_point import ApplicationAnalyticsDataPoint from talon_one.models.application_api_health import ApplicationApiHealth +from talon_one.models.application_cif import ApplicationCIF +from talon_one.models.application_cif_expression import ApplicationCIFExpression from talon_one.models.application_campaign_analytics import ApplicationCampaignAnalytics from talon_one.models.application_campaign_stats import ApplicationCampaignStats from talon_one.models.application_customer import ApplicationCustomer @@ -123,9 +126,12 @@ from talon_one.models.campaign_set_leaf_node import CampaignSetLeafNode from talon_one.models.campaign_set_node import CampaignSetNode from talon_one.models.campaign_state_changed_notification import CampaignStateChangedNotification +from talon_one.models.campaign_store_budget import CampaignStoreBudget from talon_one.models.campaign_template import CampaignTemplate from talon_one.models.campaign_template_collection import CampaignTemplateCollection +from talon_one.models.campaign_template_coupon_reservation_settings import CampaignTemplateCouponReservationSettings from talon_one.models.campaign_template_params import CampaignTemplateParams +from talon_one.models.campaign_versions import CampaignVersions from talon_one.models.card_added_deducted_points_notification_policy import CardAddedDeductedPointsNotificationPolicy from talon_one.models.card_expiring_points_notification_policy import CardExpiringPointsNotificationPolicy from talon_one.models.card_expiring_points_notification_trigger import CardExpiringPointsNotificationTrigger @@ -180,7 +186,6 @@ from talon_one.models.deactivate_user_request import DeactivateUserRequest from talon_one.models.deduct_loyalty_points import DeductLoyaltyPoints from talon_one.models.deduct_loyalty_points_effect_props import DeductLoyaltyPointsEffectProps -from talon_one.models.delete_user_request import DeleteUserRequest from talon_one.models.effect import Effect from talon_one.models.effect_entity import EffectEntity from talon_one.models.email_entity import EmailEntity @@ -259,7 +264,6 @@ from talon_one.models.inline_response20044 import InlineResponse20044 from talon_one.models.inline_response20045 import InlineResponse20045 from talon_one.models.inline_response20046 import InlineResponse20046 -from talon_one.models.inline_response20047 import InlineResponse20047 from talon_one.models.inline_response2005 import InlineResponse2005 from talon_one.models.inline_response2006 import InlineResponse2006 from talon_one.models.inline_response2007 import InlineResponse2007 @@ -286,6 +290,8 @@ from talon_one.models.library_attribute import LibraryAttribute from talon_one.models.limit_config import LimitConfig from talon_one.models.limit_counter import LimitCounter +from talon_one.models.list_campaign_store_budgets import ListCampaignStoreBudgets +from talon_one.models.list_campaign_store_budgets_store import ListCampaignStoreBudgetsStore from talon_one.models.login_params import LoginParams from talon_one.models.loyalty import Loyalty from talon_one.models.loyalty_balance import LoyaltyBalance @@ -294,6 +300,8 @@ from talon_one.models.loyalty_balances_with_tiers import LoyaltyBalancesWithTiers from talon_one.models.loyalty_card import LoyaltyCard from talon_one.models.loyalty_card_balances import LoyaltyCardBalances +from talon_one.models.loyalty_card_batch import LoyaltyCardBatch +from talon_one.models.loyalty_card_batch_response import LoyaltyCardBatchResponse from talon_one.models.loyalty_card_profile_registration import LoyaltyCardProfileRegistration from talon_one.models.loyalty_card_registration import LoyaltyCardRegistration from talon_one.models.loyalty_dashboard_data import LoyaltyDashboardData @@ -306,7 +314,6 @@ from talon_one.models.loyalty_program_balance import LoyaltyProgramBalance from talon_one.models.loyalty_program_entity import LoyaltyProgramEntity from talon_one.models.loyalty_program_ledgers import LoyaltyProgramLedgers -from talon_one.models.loyalty_program_subledgers import LoyaltyProgramSubledgers from talon_one.models.loyalty_program_transaction import LoyaltyProgramTransaction from talon_one.models.loyalty_sub_ledger import LoyaltySubLedger from talon_one.models.loyalty_tier import LoyaltyTier @@ -335,6 +342,8 @@ from talon_one.models.new_app_wide_coupon_deletion_job import NewAppWideCouponDeletionJob from talon_one.models.new_application import NewApplication from talon_one.models.new_application_api_key import NewApplicationAPIKey +from talon_one.models.new_application_cif import NewApplicationCIF +from talon_one.models.new_application_cif_expression import NewApplicationCIFExpression from talon_one.models.new_attribute import NewAttribute from talon_one.models.new_audience import NewAudience from talon_one.models.new_base_notification import NewBaseNotification @@ -343,6 +352,8 @@ from talon_one.models.new_campaign_evaluation_group import NewCampaignEvaluationGroup from talon_one.models.new_campaign_group import NewCampaignGroup from talon_one.models.new_campaign_set import NewCampaignSet +from talon_one.models.new_campaign_store_budget import NewCampaignStoreBudget +from talon_one.models.new_campaign_store_budget_store_limit import NewCampaignStoreBudgetStoreLimit from talon_one.models.new_campaign_template import NewCampaignTemplate from talon_one.models.new_catalog import NewCatalog from talon_one.models.new_collection import NewCollection @@ -374,6 +385,7 @@ from talon_one.models.new_referral import NewReferral from talon_one.models.new_referrals_for_multiple_advocates import NewReferralsForMultipleAdvocates from talon_one.models.new_return import NewReturn +from talon_one.models.new_revision_version import NewRevisionVersion from talon_one.models.new_role import NewRole from talon_one.models.new_role_v2 import NewRoleV2 from talon_one.models.new_ruleset import NewRuleset @@ -406,6 +418,9 @@ from talon_one.models.pending_points_notification_policy import PendingPointsNotificationPolicy from talon_one.models.picklist import Picklist from talon_one.models.product import Product +from talon_one.models.product_search_match import ProductSearchMatch +from talon_one.models.product_sku_unit_analytics import ProductSkuUnitAnalytics +from talon_one.models.product_unit_analytics import ProductUnitAnalytics from talon_one.models.profile_audiences_changes import ProfileAudiencesChanges from talon_one.models.projected_tier import ProjectedTier from talon_one.models.redeem_referral_effect_props import RedeemReferralEffectProps @@ -422,6 +437,9 @@ from talon_one.models.reserve_coupon_effect_props import ReserveCouponEffectProps from talon_one.models.return_integration_request import ReturnIntegrationRequest from talon_one.models.returned_cart_item import ReturnedCartItem +from talon_one.models.revision import Revision +from talon_one.models.revision_activation import RevisionActivation +from talon_one.models.revision_version import RevisionVersion from talon_one.models.role import Role from talon_one.models.role_assign import RoleAssign from talon_one.models.role_membership import RoleMembership @@ -445,9 +463,21 @@ from talon_one.models.saml_connection_internal import SamlConnectionInternal from talon_one.models.saml_connection_metadata import SamlConnectionMetadata from talon_one.models.saml_login_endpoint import SamlLoginEndpoint +from talon_one.models.scim_base_user import ScimBaseUser +from talon_one.models.scim_base_user_name import ScimBaseUserName from talon_one.models.scim_new_user import ScimNewUser +from talon_one.models.scim_patch_operation import ScimPatchOperation +from talon_one.models.scim_patch_request import ScimPatchRequest from talon_one.models.scim_resource import ScimResource from talon_one.models.scim_resource_types_list_response import ScimResourceTypesListResponse +from talon_one.models.scim_schema_resource import ScimSchemaResource +from talon_one.models.scim_schemas_list_response import ScimSchemasListResponse +from talon_one.models.scim_service_provider_config_response import ScimServiceProviderConfigResponse +from talon_one.models.scim_service_provider_config_response_bulk import ScimServiceProviderConfigResponseBulk +from talon_one.models.scim_service_provider_config_response_change_password import ScimServiceProviderConfigResponseChangePassword +from talon_one.models.scim_service_provider_config_response_filter import ScimServiceProviderConfigResponseFilter +from talon_one.models.scim_service_provider_config_response_patch import ScimServiceProviderConfigResponsePatch +from talon_one.models.scim_service_provider_config_response_sort import ScimServiceProviderConfigResponseSort from talon_one.models.scim_user import ScimUser from talon_one.models.scim_users_list_response import ScimUsersListResponse from talon_one.models.session import Session @@ -461,10 +491,12 @@ from talon_one.models.store import Store from talon_one.models.strikethrough_changed_item import StrikethroughChangedItem from talon_one.models.strikethrough_custom_effect_per_item_props import StrikethroughCustomEffectPerItemProps +from talon_one.models.strikethrough_debug_response import StrikethroughDebugResponse from talon_one.models.strikethrough_effect import StrikethroughEffect from talon_one.models.strikethrough_labeling_notification import StrikethroughLabelingNotification from talon_one.models.strikethrough_set_discount_per_item_effect_props import StrikethroughSetDiscountPerItemEffectProps from talon_one.models.strikethrough_trigger import StrikethroughTrigger +from talon_one.models.summary_campaign_store_budget import SummaryCampaignStoreBudget from talon_one.models.talang_attribute import TalangAttribute from talon_one.models.talang_attribute_visibility import TalangAttributeVisibility from talon_one.models.template_arg_def import TemplateArgDef @@ -484,6 +516,7 @@ from talon_one.models.update_achievement import UpdateAchievement from talon_one.models.update_application import UpdateApplication from talon_one.models.update_application_api_key import UpdateApplicationAPIKey +from talon_one.models.update_application_cif import UpdateApplicationCIF from talon_one.models.update_attribute_effect_props import UpdateAttributeEffectProps from talon_one.models.update_audience import UpdateAudience from talon_one.models.update_campaign import UpdateCampaign @@ -495,9 +528,9 @@ from talon_one.models.update_collection import UpdateCollection from talon_one.models.update_coupon import UpdateCoupon from talon_one.models.update_coupon_batch import UpdateCouponBatch -from talon_one.models.update_custom_effect import UpdateCustomEffect from talon_one.models.update_loyalty_card import UpdateLoyaltyCard from talon_one.models.update_loyalty_program import UpdateLoyaltyProgram +from talon_one.models.update_loyalty_program_tier import UpdateLoyaltyProgramTier from talon_one.models.update_picklist import UpdatePicklist from talon_one.models.update_referral import UpdateReferral from talon_one.models.update_referral_batch import UpdateReferralBatch @@ -506,6 +539,7 @@ from talon_one.models.update_user import UpdateUser from talon_one.models.user import User from talon_one.models.user_entity import UserEntity +from talon_one.models.value_map import ValueMap from talon_one.models.webhook import Webhook from talon_one.models.webhook_activation_log_entry import WebhookActivationLogEntry from talon_one.models.webhook_log_entry import WebhookLogEntry diff --git a/talon_one/api/integration_api.py b/talon_one/api/integration_api.py index b76fa3e..78dcf28 100644 --- a/talon_one/api/integration_api.py +++ b/talon_one/api/integration_api.py @@ -157,7 +157,7 @@ def create_audience_v2_with_http_info(self, body, **kwargs): # noqa: E501 def create_coupon_reservation(self, coupon_value, body, **kwargs): # noqa: E501 """Create coupon reservation # noqa: E501 - Create a coupon reservation for the 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). - If the **Reservation mandatory** option was selected when creating the specified coupon, the endpoint creates a **hard** reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a **soft** reservation, meaning the coupon will be associated with the specified customer profiles (they show up when using the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint), but any user can redeem it. This can be useful, for example, to display a _coupon wallet_ for customers when they visit your store. - If the **Coupon visibility** option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. # noqa: E501 + Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect. **Note:** - If the **Reservation mandatory** option was selected when creating the specified coupon, the endpoint creates a **hard** reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a **soft** reservation, meaning the coupon is associated with the specified customer profiles (they show up when using the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint), but any user can redeem it. This can be useful, for example, to display a _coupon wallet_ for customers when they visit your store. - If the **Coupon visibility** option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. - This endpoint overrides the coupon reservation limit set when [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons). To ensure that coupons cannot be reserved after the reservation limit is reached, use the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect in the Rule Builder and the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_coupon_reservation(coupon_value, body, async_req=True) @@ -183,7 +183,7 @@ def create_coupon_reservation(self, coupon_value, body, **kwargs): # noqa: E501 def create_coupon_reservation_with_http_info(self, coupon_value, body, **kwargs): # noqa: E501 """Create coupon reservation # noqa: E501 - Create a coupon reservation for the 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). - If the **Reservation mandatory** option was selected when creating the specified coupon, the endpoint creates a **hard** reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a **soft** reservation, meaning the coupon will be associated with the specified customer profiles (they show up when using the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint), but any user can redeem it. This can be useful, for example, to display a _coupon wallet_ for customers when they visit your store. - If the **Coupon visibility** option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. # noqa: E501 + Create a coupon reservation for the specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect. **Note:** - If the **Reservation mandatory** option was selected when creating the specified coupon, the endpoint creates a **hard** reservation, meaning only users who have this coupon code reserved can redeem it. Otherwise, the endpoint creates a **soft** reservation, meaning the coupon is associated with the specified customer profiles (they show up when using the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint), but any user can redeem it. This can be useful, for example, to display a _coupon wallet_ for customers when they visit your store. - If the **Coupon visibility** option was selected when creating the specified coupon, the coupon code is implicitly soft-reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. - This endpoint overrides the coupon reservation limit set when [the coupon is created](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons). To ensure that coupons cannot be reserved after the reservation limit is reached, use the [Create coupon code reservation](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code) effect in the Rule Builder and the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint. To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_coupon_reservation_with_http_info(coupon_value, body, async_req=True) @@ -880,7 +880,7 @@ def delete_coupon_reservation_with_http_info(self, coupon_value, body, **kwargs) def delete_customer_data(self, integration_id, **kwargs): # noqa: E501 """Delete customer's personal data # noqa: E501 - Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. # noqa: E501 + Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_customer_data(integration_id, async_req=True) @@ -905,7 +905,7 @@ def delete_customer_data(self, integration_id, **kwargs): # noqa: E501 def delete_customer_data_with_http_info(self, integration_id, **kwargs): # noqa: E501 """Delete customer's personal data # noqa: E501 - Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. # noqa: E501 + Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** - Customer data is deleted from all Applications in the [environment](https://docs.talon.one/docs/product/applications/overview#application-environments) that the API key belongs to. For example, if you use this endpoint with an API key that belongs to a sandbox Application, customer data will be deleted from all sandbox Applications. This is because customer data is shared between Applications from the same environment. - To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_customer_data_with_http_info(integration_id, async_req=True) @@ -1377,9 +1377,9 @@ def get_customer_session_with_http_info(self, customer_session_id, **kwargs): # collection_formats=collection_formats) def get_loyalty_balances(self, loyalty_program_id, integration_id, **kwargs): # noqa: E501 - """Get customer's loyalty points # noqa: E501 + """Get customer's loyalty balances # noqa: E501 - Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID. **Note**: 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. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data) # noqa: E501 + Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: 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. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_loyalty_balances(loyalty_program_id, integration_id, async_req=True) @@ -1391,7 +1391,7 @@ def get_loyalty_balances(self, loyalty_program_id, integration_id, **kwargs): # :param datetime end_date: Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. :param str subledger_id: The ID of the subledger by which we filter the data. :param bool include_tiers: Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. - :param bool include_projected_tier: Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer’s active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. + :param bool include_projected_tier: Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -1407,9 +1407,9 @@ def get_loyalty_balances(self, loyalty_program_id, integration_id, **kwargs): # return self.get_loyalty_balances_with_http_info(loyalty_program_id, integration_id, **kwargs) # noqa: E501 def get_loyalty_balances_with_http_info(self, loyalty_program_id, integration_id, **kwargs): # noqa: E501 - """Get customer's loyalty points # noqa: E501 + """Get customer's loyalty balances # noqa: E501 - Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID. **Note**: 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. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data) # noqa: E501 + Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response. **Note**: 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. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_loyalty_balances_with_http_info(loyalty_program_id, integration_id, async_req=True) @@ -1421,7 +1421,7 @@ def get_loyalty_balances_with_http_info(self, loyalty_program_id, integration_id :param datetime end_date: Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. :param str subledger_id: The ID of the subledger by which we filter the data. :param bool include_tiers: Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. - :param bool include_projected_tier: Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer’s active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. + :param bool include_projected_tier: Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer's active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -1625,7 +1625,7 @@ def get_loyalty_card_balances_with_http_info(self, loyalty_program_id, loyalty_c query_params.append(('endDate', local_var_params['end_date'])) # noqa: E501 if 'subledger_id' in local_var_params and local_var_params['subledger_id'] is not None: # noqa: E501 query_params.append(('subledgerId', local_var_params['subledger_id'])) # noqa: E501 - collection_formats['subledgerId'] = 'csv' # noqa: E501 + collection_formats['subledgerId'] = 'multi' # noqa: E501 header_params = {} @@ -1772,7 +1772,7 @@ def get_loyalty_card_points_with_http_info(self, loyalty_program_id, loyalty_car query_params.append(('status', local_var_params['status'])) # noqa: E501 if 'subledger_id' in local_var_params and local_var_params['subledger_id'] is not None: # noqa: E501 query_params.append(('subledgerId', local_var_params['subledger_id'])) # noqa: E501 - collection_formats['subledgerId'] = 'csv' # noqa: E501 + collection_formats['subledgerId'] = 'multi' # noqa: E501 if 'page_size' in local_var_params and local_var_params['page_size'] is not None: # noqa: E501 query_params.append(('pageSize', local_var_params['page_size'])) # noqa: E501 if 'skip' in local_var_params and local_var_params['skip'] is not None: # noqa: E501 @@ -1927,7 +1927,7 @@ def get_loyalty_card_transactions_with_http_info(self, loyalty_program_id, loyal query_params = [] if 'subledger_id' in local_var_params and local_var_params['subledger_id'] is not None: # noqa: E501 query_params.append(('subledgerId', local_var_params['subledger_id'])) # noqa: E501 - collection_formats['subledgerId'] = 'csv' # noqa: E501 + collection_formats['subledgerId'] = 'multi' # noqa: E501 if 'loyalty_transaction_type' in local_var_params and local_var_params['loyalty_transaction_type'] is not None: # noqa: E501 query_params.append(('loyaltyTransactionType', local_var_params['loyalty_transaction_type'])) # noqa: E501 if 'start_date' in local_var_params and local_var_params['start_date'] is not None: # noqa: E501 @@ -3670,7 +3670,7 @@ def update_customer_session_v2(self, customer_session_id, body, **kwargs): # no :param async_req bool: execute request asynchronously :param str customer_session_id: 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. (required) :param IntegrationRequest body: body (required) - :param bool dry: Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). + :param bool dry: Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). :param datetime now: A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response @@ -3698,7 +3698,7 @@ def update_customer_session_v2_with_http_info(self, customer_session_id, body, * :param async_req bool: execute request asynchronously :param str customer_session_id: 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. (required) :param IntegrationRequest body: body (required) - :param bool dry: Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). + :param bool dry: Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). :param datetime now: A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`. :param _return_http_data_only: response data without head status code and headers diff --git a/talon_one/api/management_api.py b/talon_one/api/management_api.py index a79c092..2dbd286 100644 --- a/talon_one/api/management_api.py +++ b/talon_one/api/management_api.py @@ -46,7 +46,7 @@ def activate_user_by_email(self, body, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param ActivateUserRequest body: body (required) + :param DeactivateUserRequest body: body (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -71,7 +71,7 @@ def activate_user_by_email_with_http_info(self, body, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param ActivateUserRequest body: body (required) + :param DeactivateUserRequest body: body (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -1051,6 +1051,133 @@ def create_attribute_with_http_info(self, body, **kwargs): # noqa: E501 _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) + def create_batch_loyalty_cards(self, loyalty_program_id, body, **kwargs): # noqa: E501 + """Create loyalty cards # noqa: E501 + + Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. **Important:** - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_batch_loyalty_cards(loyalty_program_id, body, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int loyalty_program_id: 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. (required) + :param LoyaltyCardBatch body: body (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: LoyaltyCardBatchResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.create_batch_loyalty_cards_with_http_info(loyalty_program_id, body, **kwargs) # noqa: E501 + + def create_batch_loyalty_cards_with_http_info(self, loyalty_program_id, body, **kwargs): # noqa: E501 + """Create loyalty cards # noqa: E501 + + Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). Customers can use loyalty cards to collect and spend loyalty points. **Important:** - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_batch_loyalty_cards_with_http_info(loyalty_program_id, body, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int loyalty_program_id: 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. (required) + :param LoyaltyCardBatch body: body (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(LoyaltyCardBatchResponse, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'loyalty_program_id', + 'body' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method create_batch_loyalty_cards" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'loyalty_program_id' is set + if self.api_client.client_side_validation and ('loyalty_program_id' not in local_var_params or # noqa: E501 + local_var_params['loyalty_program_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `loyalty_program_id` when calling `create_batch_loyalty_cards`") # noqa: E501 + # verify the required parameter 'body' is set + if self.api_client.client_side_validation and ('body' not in local_var_params or # noqa: E501 + local_var_params['body'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `body` when calling `create_batch_loyalty_cards`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'loyalty_program_id' in local_var_params: + path_params['loyaltyProgramId'] = local_var_params['loyalty_program_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in local_var_params: + body_params = local_var_params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['management_key', 'manager_auth'] # noqa: E501 + + return self.api_client.call_api( + '/v1/loyalty_programs/{loyaltyProgramId}/cards/batch', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='LoyaltyCardBatchResponse', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + def create_campaign_from_template(self, application_id, body, **kwargs): # noqa: E501 """Create campaign from campaign template # noqa: E501 @@ -3368,7 +3495,7 @@ def delete_coupons(self, application_id, campaign_id, **kwargs): # noqa: E501 :param str batch_id: Filter results by batches of coupons :param str usable: - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. :param int referral_id: Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - :param str recipient_integration_id: Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. + :param str recipient_integration_id: Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field. :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response @@ -3407,7 +3534,7 @@ def delete_coupons_with_http_info(self, application_id, campaign_id, **kwargs): :param str batch_id: Filter results by batches of coupons :param str usable: - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. :param int referral_id: Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - :param str recipient_integration_id: Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. + :param str recipient_integration_id: Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field. :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code :param _return_http_data_only: response data without head status code and headers @@ -4026,7 +4153,7 @@ def delete_user_by_email(self, body, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param DeleteUserRequest body: body (required) + :param DeactivateUserRequest body: body (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -4051,7 +4178,7 @@ def delete_user_by_email_with_http_info(self, body, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param DeleteUserRequest body: body (required) + :param DeactivateUserRequest body: body (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -4972,7 +5099,7 @@ def export_collection_items_with_http_info(self, application_id, campaign_id, co def export_coupons(self, application_id, **kwargs): # noqa: E501 """Export coupons # noqa: E501 - 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 can contain 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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. # noqa: E501 + 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 can contain 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 in RFC3339 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.export_coupons(application_id, async_req=True) @@ -4980,7 +5107,7 @@ def export_coupons(self, application_id, **kwargs): # noqa: E501 :param async_req bool: execute request asynchronously :param int application_id: The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - :param float campaign_id: Filter results by campaign. + :param float campaign_id: Filter results by campaign ID. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. :param str value: 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. :param datetime created_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. @@ -5011,7 +5138,7 @@ def export_coupons(self, application_id, **kwargs): # noqa: E501 def export_coupons_with_http_info(self, application_id, **kwargs): # noqa: E501 """Export coupons # noqa: E501 - 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 can contain 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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. # noqa: E501 + 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 can contain 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 in RFC3339 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 recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.export_coupons_with_http_info(application_id, async_req=True) @@ -5019,7 +5146,7 @@ def export_coupons_with_http_info(self, application_id, **kwargs): # noqa: E501 :param async_req bool: execute request asynchronously :param int application_id: The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - :param float campaign_id: Filter results by campaign. + :param float campaign_id: Filter results by campaign ID. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. :param str value: 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. :param datetime created_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. @@ -5429,9 +5556,9 @@ def export_effects(self, application_id, **kwargs): # noqa: E501 :param async_req bool: execute request asynchronously :param int application_id: The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - :param float campaign_id: Filter results by campaign. - :param datetime created_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. - :param datetime created_after: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. + :param float campaign_id: Filter results by campaign ID. + :param datetime created_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. + :param datetime created_after: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. :param str date_format: Determines the format of dates in the export document. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response @@ -5458,9 +5585,9 @@ def export_effects_with_http_info(self, application_id, **kwargs): # noqa: E501 :param async_req bool: execute request asynchronously :param int application_id: The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - :param float campaign_id: Filter results by campaign. - :param datetime created_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. - :param datetime created_after: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. + :param float campaign_id: Filter results by campaign ID. + :param datetime created_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. + :param datetime created_after: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. :param str date_format: Determines the format of dates in the export document. :param _return_http_data_only: response data without head status code and headers @@ -6058,10 +6185,134 @@ def export_loyalty_card_ledger_with_http_info(self, loyalty_program_id, loyalty_ _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) + def export_loyalty_cards(self, loyalty_program_id, **kwargs): # noqa: E501 + """Export loyalty cards # noqa: E501 + + Download a CSV file containing the loyalty cards from a specified 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: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.export_loyalty_cards(loyalty_program_id, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int loyalty_program_id: 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. (required) + :param str batch_id: Filter results by loyalty card batch ID. + :param str date_format: Determines the format of dates in the export document. + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: str + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.export_loyalty_cards_with_http_info(loyalty_program_id, **kwargs) # noqa: E501 + + def export_loyalty_cards_with_http_info(self, loyalty_program_id, **kwargs): # noqa: E501 + """Export loyalty cards # noqa: E501 + + Download a CSV file containing the loyalty cards from a specified 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: - `identifier`: The unique identifier of the loyalty card. - `created`: The date and time the loyalty card was created. - `status`: The status of the loyalty card. - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. - `customerprofileids`: Integration IDs of the customer profiles linked to the card. - `blockreason`: The reason for transferring and blocking the loyalty card. - `generated`: An indicator of whether the loyalty card was generated. - `batchid`: The ID of the batch the loyalty card is in. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.export_loyalty_cards_with_http_info(loyalty_program_id, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param int loyalty_program_id: 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. (required) + :param str batch_id: Filter results by loyalty card batch ID. + :param str date_format: Determines the format of dates in the export document. + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(str, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'loyalty_program_id', + 'batch_id', + 'date_format' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method export_loyalty_cards" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'loyalty_program_id' is set + if self.api_client.client_side_validation and ('loyalty_program_id' not in local_var_params or # noqa: E501 + local_var_params['loyalty_program_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `loyalty_program_id` when calling `export_loyalty_cards`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'loyalty_program_id' in local_var_params: + path_params['loyaltyProgramId'] = local_var_params['loyalty_program_id'] # noqa: E501 + + query_params = [] + if 'batch_id' in local_var_params and local_var_params['batch_id'] is not None: # noqa: E501 + query_params.append(('batchId', local_var_params['batch_id'])) # noqa: E501 + if 'date_format' in local_var_params and local_var_params['date_format'] is not None: # noqa: E501 + query_params.append(('dateFormat', local_var_params['date_format'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/csv']) # noqa: E501 + + # Authentication setting + auth_settings = ['management_key', 'manager_auth'] # noqa: E501 + + return self.api_client.call_api( + '/v1/loyalty_programs/{loyaltyProgramId}/cards/export', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='str', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + def export_loyalty_ledger(self, range_start, range_end, loyalty_program_id, integration_id, **kwargs): # noqa: E501 """Export customer's transaction logs # noqa: E501 - 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. - `campaignid`: The ID of the campaign. # noqa: E501 + Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.export_loyalty_ledger(range_start, range_end, loyalty_program_id, integration_id, async_req=True) @@ -6090,7 +6341,7 @@ def export_loyalty_ledger(self, range_start, range_end, loyalty_program_id, inte def export_loyalty_ledger_with_http_info(self, range_start, range_end, loyalty_program_id, integration_id, **kwargs): # noqa: E501 """Export customer's transaction logs # noqa: E501 - 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. - `campaignid`: The ID of the campaign. # noqa: E501 + Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.export_loyalty_ledger_with_http_info(range_start, range_end, loyalty_program_id, integration_id, async_req=True) @@ -6339,7 +6590,7 @@ def export_referrals(self, application_id, **kwargs): # noqa: E501 :param async_req bool: execute request asynchronously :param int application_id: The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - :param float campaign_id: Filter results by campaign. + :param float campaign_id: Filter results by campaign ID. :param datetime created_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param datetime created_after: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param str valid: - `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. @@ -6371,7 +6622,7 @@ def export_referrals_with_http_info(self, application_id, **kwargs): # noqa: E5 :param async_req bool: execute request asynchronously :param int application_id: The ID of the Application. It is displayed in your Talon.One deployment URL. (required) - :param float campaign_id: Filter results by campaign. + :param float campaign_id: Filter results by campaign ID. :param datetime created_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param datetime created_after: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param str valid: - `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. @@ -7191,140 +7442,16 @@ def get_additional_cost_with_http_info(self, additional_cost_id, **kwargs): # n del local_var_params['kwargs'] # verify the required parameter 'additional_cost_id' is set if self.api_client.client_side_validation and ('additional_cost_id' not in local_var_params or # noqa: E501 - local_var_params['additional_cost_id'] is None): # noqa: E501 - raise ApiValueError("Missing the required parameter `additional_cost_id` when calling `get_additional_cost`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'additional_cost_id' in local_var_params: - path_params['additionalCostId'] = local_var_params['additional_cost_id'] # noqa: E501 - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['management_key', 'manager_auth'] # noqa: E501 - - return self.api_client.call_api( - '/v1/additional_costs/{additionalCostId}', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccountAdditionalCost', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) - - def get_additional_costs(self, **kwargs): # noqa: E501 - """List additional costs # noqa: E501 - - Returns all the defined additional costs for the account. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_additional_costs(async_req=True) - >>> result = thread.get() - - :param async_req bool: execute request asynchronously - :param int page_size: The number of items in the response. - :param int skip: The number of items to skip when paging through large result sets. - :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: InlineResponse20036 - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - return self.get_additional_costs_with_http_info(**kwargs) # noqa: E501 - - def get_additional_costs_with_http_info(self, **kwargs): # noqa: E501 - """List additional costs # noqa: E501 - - Returns all the defined additional costs for the account. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_additional_costs_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool: execute request asynchronously - :param int page_size: The number of items in the response. - :param int skip: The number of items to skip when paging through large result sets. - :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. - :param _return_http_data_only: response data without head status code - and headers - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: tuple(InlineResponse20036, status_code(int), headers(HTTPHeaderDict)) - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = [ - 'page_size', - 'skip', - 'sort' - ] - all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout' - ] - ) - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method get_additional_costs" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] + local_var_params['additional_cost_id'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `additional_cost_id` when calling `get_additional_cost`") # noqa: E501 - if self.api_client.client_side_validation and 'page_size' in local_var_params and local_var_params['page_size'] > 1000: # noqa: E501 - raise ApiValueError("Invalid value for parameter `page_size` when calling `get_additional_costs`, must be a value less than or equal to `1000`") # noqa: E501 - if self.api_client.client_side_validation and 'page_size' in local_var_params and local_var_params['page_size'] < 1: # noqa: E501 - raise ApiValueError("Invalid value for parameter `page_size` when calling `get_additional_costs`, must be a value greater than or equal to `1`") # noqa: E501 collection_formats = {} path_params = {} + if 'additional_cost_id' in local_var_params: + path_params['additionalCostId'] = local_var_params['additional_cost_id'] # noqa: E501 query_params = [] - if 'page_size' in local_var_params and local_var_params['page_size'] is not None: # noqa: E501 - query_params.append(('pageSize', local_var_params['page_size'])) # noqa: E501 - if 'skip' in local_var_params and local_var_params['skip'] is not None: # noqa: E501 - query_params.append(('skip', local_var_params['skip'])) # noqa: E501 - if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 - query_params.append(('sort', local_var_params['sort'])) # noqa: E501 header_params = {} @@ -7340,14 +7467,14 @@ def get_additional_costs_with_http_info(self, **kwargs): # noqa: E501 auth_settings = ['management_key', 'manager_auth'] # noqa: E501 return self.api_client.call_api( - '/v1/additional_costs', 'GET', + '/v1/additional_costs/{additionalCostId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20036', # noqa: E501 + response_type='AccountAdditionalCost', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -7355,21 +7482,16 @@ def get_additional_costs_with_http_info(self, **kwargs): # noqa: E501 _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) - def get_all_access_logs(self, **kwargs): # noqa: E501 - """List access logs # noqa: E501 + def get_additional_costs(self, **kwargs): # noqa: E501 + """List additional costs # noqa: E501 - Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs. # noqa: E501 + Returns all the defined additional costs for the account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_access_logs(async_req=True) + >>> thread = api.get_additional_costs(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously - :param datetime range_start: Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. - :param datetime range_end: Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. - :param str path: Only return results where the request path matches the given regular expression. - :param str method: Only return results where the request method matches the given regular expression. - :param str status: Filter results by HTTP status codes. :param int page_size: The number of items in the response. :param int skip: The number of items to skip when paging through large result sets. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. @@ -7380,28 +7502,23 @@ def get_all_access_logs(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20020 + :return: InlineResponse20035 If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True - return self.get_all_access_logs_with_http_info(**kwargs) # noqa: E501 + return self.get_additional_costs_with_http_info(**kwargs) # noqa: E501 - def get_all_access_logs_with_http_info(self, **kwargs): # noqa: E501 - """List access logs # noqa: E501 + def get_additional_costs_with_http_info(self, **kwargs): # noqa: E501 + """List additional costs # noqa: E501 - Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs. # noqa: E501 + Returns all the defined additional costs for the account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_access_logs_with_http_info(async_req=True) + >>> thread = api.get_additional_costs_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously - :param datetime range_start: Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. - :param datetime range_end: Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. - :param str path: Only return results where the request path matches the given regular expression. - :param str method: Only return results where the request method matches the given regular expression. - :param str status: Filter results by HTTP status codes. :param int page_size: The number of items in the response. :param int skip: The number of items to skip when paging through large result sets. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. @@ -7414,7 +7531,7 @@ def get_all_access_logs_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20020, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20035, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -7422,11 +7539,6 @@ def get_all_access_logs_with_http_info(self, **kwargs): # noqa: E501 local_var_params = locals() all_params = [ - 'range_start', - 'range_end', - 'path', - 'method', - 'status', 'page_size', 'skip', 'sort' @@ -7444,30 +7556,20 @@ def get_all_access_logs_with_http_info(self, **kwargs): # noqa: E501 if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" - " to method get_all_access_logs" % key + " to method get_additional_costs" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'page_size' in local_var_params and local_var_params['page_size'] > 1000: # noqa: E501 - raise ApiValueError("Invalid value for parameter `page_size` when calling `get_all_access_logs`, must be a value less than or equal to `1000`") # noqa: E501 + raise ApiValueError("Invalid value for parameter `page_size` when calling `get_additional_costs`, must be a value less than or equal to `1000`") # noqa: E501 if self.api_client.client_side_validation and 'page_size' in local_var_params and local_var_params['page_size'] < 1: # noqa: E501 - raise ApiValueError("Invalid value for parameter `page_size` when calling `get_all_access_logs`, must be a value greater than or equal to `1`") # noqa: E501 + raise ApiValueError("Invalid value for parameter `page_size` when calling `get_additional_costs`, must be a value greater than or equal to `1`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] - if 'range_start' in local_var_params and local_var_params['range_start'] is not None: # noqa: E501 - query_params.append(('rangeStart', local_var_params['range_start'])) # noqa: E501 - if 'range_end' in local_var_params and local_var_params['range_end'] is not None: # noqa: E501 - query_params.append(('rangeEnd', local_var_params['range_end'])) # noqa: E501 - if 'path' in local_var_params and local_var_params['path'] is not None: # noqa: E501 - query_params.append(('path', local_var_params['path'])) # noqa: E501 - if 'method' in local_var_params and local_var_params['method'] is not None: # noqa: E501 - query_params.append(('method', local_var_params['method'])) # noqa: E501 - if 'status' in local_var_params and local_var_params['status'] is not None: # noqa: E501 - query_params.append(('status', local_var_params['status'])) # noqa: E501 if 'page_size' in local_var_params and local_var_params['page_size'] is not None: # noqa: E501 query_params.append(('pageSize', local_var_params['page_size'])) # noqa: E501 if 'skip' in local_var_params and local_var_params['skip'] is not None: # noqa: E501 @@ -7489,14 +7591,14 @@ def get_all_access_logs_with_http_info(self, **kwargs): # noqa: E501 auth_settings = ['management_key', 'manager_auth'] # noqa: E501 return self.api_client.call_api( - '/v1/access_logs', 'GET', + '/v1/additional_costs', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20020', # noqa: E501 + response_type='InlineResponse20035', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -7621,7 +7723,7 @@ def get_application_with_http_info(self, application_id, **kwargs): # noqa: E50 def get_application_api_health(self, application_id, **kwargs): # noqa: E501 """Get Application health # noqa: E501 - 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). # noqa: E501 + Display the health of the Application and show the last time the Application was used. You can also find this information in the Campaign Manager. In your Application, click **Settings** > **Integration API Keys**. See the [docs](https://docs.talon.one/docs/dev/tutorials/monitoring-integration-status). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_application_api_health(application_id, async_req=True) @@ -7646,7 +7748,7 @@ def get_application_api_health(self, application_id, **kwargs): # noqa: E501 def get_application_api_health_with_http_info(self, application_id, **kwargs): # noqa: E501 """Get Application health # noqa: E501 - 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). # noqa: E501 + Display the health of the Application and show the last time the Application was used. You can also find this information in the Campaign Manager. In your Application, click **Settings** > **Integration API Keys**. See the [docs](https://docs.talon.one/docs/dev/tutorials/monitoring-integration-status). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_application_api_health_with_http_info(application_id, async_req=True) @@ -7878,7 +7980,7 @@ def get_application_customer_friends(self, application_id, integration_id, **kwa number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20033 + :return: InlineResponse20032 If the method is called asynchronously, returns the request thread. """ @@ -7910,7 +8012,7 @@ def get_application_customer_friends_with_http_info(self, application_id, integr number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20033, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20032, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -7994,7 +8096,7 @@ def get_application_customer_friends_with_http_info(self, application_id, integr body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20033', # noqa: E501 + response_type='InlineResponse20032', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -8024,7 +8126,7 @@ def get_application_customers(self, application_id, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20022 + :return: InlineResponse20021 If the method is called asynchronously, returns the request thread. """ @@ -8055,7 +8157,7 @@ def get_application_customers_with_http_info(self, application_id, **kwargs): # number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20022, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20021, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -8132,7 +8234,7 @@ def get_application_customers_with_http_info(self, application_id, **kwargs): # body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20022', # noqa: E501 + response_type='InlineResponse20021', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -8162,7 +8264,7 @@ def get_application_customers_by_attributes(self, application_id, body, **kwargs number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20023 + :return: InlineResponse20022 If the method is called asynchronously, returns the request thread. """ @@ -8193,7 +8295,7 @@ def get_application_customers_by_attributes_with_http_info(self, application_id, number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20023, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20022, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -8278,7 +8380,7 @@ def get_application_customers_by_attributes_with_http_info(self, application_id, body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20023', # noqa: E501 + response_type='InlineResponse20022', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -8307,7 +8409,7 @@ def get_application_event_types(self, application_id, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20029 + :return: InlineResponse20028 If the method is called asynchronously, returns the request thread. """ @@ -8337,7 +8439,7 @@ def get_application_event_types_with_http_info(self, application_id, **kwargs): number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20029, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20028, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -8411,7 +8513,7 @@ def get_application_event_types_with_http_info(self, application_id, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20029', # noqa: E501 + response_type='InlineResponse20028', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -8451,7 +8553,7 @@ def get_application_events_without_total_count(self, application_id, **kwargs): number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20028 + :return: InlineResponse20027 If the method is called asynchronously, returns the request thread. """ @@ -8492,7 +8594,7 @@ def get_application_events_without_total_count_with_http_info(self, application_ number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20028, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20027, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -8605,7 +8707,7 @@ def get_application_events_without_total_count_with_http_info(self, application_ body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20028', # noqa: E501 + response_type='InlineResponse20027', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -8756,7 +8858,7 @@ def get_application_sessions(self, application_id, **kwargs): # noqa: E501 :param datetime created_after: Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. :param str coupon: Filter by sessions with this coupon. Must be exact match. :param str referral: Filter by sessions with this referral. Must be exact match. - :param str integration_id: Filter by sessions with this integrationId. Must be exact match. + :param str integration_id: Filter by sessions with this integration ID. Must be exact match. :param str store_integration_id: The integration ID of the store. You choose this ID when you create a store. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response @@ -8765,7 +8867,7 @@ def get_application_sessions(self, application_id, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20027 + :return: InlineResponse20026 If the method is called asynchronously, returns the request thread. """ @@ -8792,7 +8894,7 @@ def get_application_sessions_with_http_info(self, application_id, **kwargs): # :param datetime created_after: Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. :param str coupon: Filter by sessions with this coupon. Must be exact match. :param str referral: Filter by sessions with this referral. Must be exact match. - :param str integration_id: Filter by sessions with this integrationId. Must be exact match. + :param str integration_id: Filter by sessions with this integration ID. Must be exact match. :param str store_integration_id: The integration ID of the store. You choose this ID when you create a store. :param _return_http_data_only: response data without head status code and headers @@ -8803,7 +8905,7 @@ def get_application_sessions_with_http_info(self, application_id, **kwargs): # number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20027, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20026, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -8901,7 +9003,7 @@ def get_application_sessions_with_http_info(self, application_id, **kwargs): # body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20027', # noqa: E501 + response_type='InlineResponse20026', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -9168,7 +9270,7 @@ def get_attributes(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20034 + :return: InlineResponse20033 If the method is called asynchronously, returns the request thread. """ @@ -9198,7 +9300,7 @@ def get_attributes_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20034, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20033, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -9268,7 +9370,7 @@ def get_attributes_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20034', # noqa: E501 + response_type='InlineResponse20033', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -9298,7 +9400,7 @@ def get_audience_memberships(self, audience_id, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20032 + :return: InlineResponse20031 If the method is called asynchronously, returns the request thread. """ @@ -9329,7 +9431,7 @@ def get_audience_memberships_with_http_info(self, audience_id, **kwargs): # noq number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20032, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20031, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -9406,7 +9508,7 @@ def get_audience_memberships_with_http_info(self, audience_id, **kwargs): # noq body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20032', # noqa: E501 + response_type='InlineResponse20031', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -9435,7 +9537,7 @@ def get_audiences(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20030 + :return: InlineResponse20029 If the method is called asynchronously, returns the request thread. """ @@ -9465,7 +9567,7 @@ def get_audiences_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20030, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20029, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -9535,7 +9637,7 @@ def get_audiences_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20030', # noqa: E501 + response_type='InlineResponse20029', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -9562,7 +9664,7 @@ def get_audiences_analytics(self, audience_ids, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20031 + :return: InlineResponse20030 If the method is called asynchronously, returns the request thread. """ @@ -9590,7 +9692,7 @@ def get_audiences_analytics_with_http_info(self, audience_ids, **kwargs): # noq number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20031, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20030, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -9654,7 +9756,7 @@ def get_audiences_analytics_with_http_info(self, audience_ids, **kwargs): # noq body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20031', # noqa: E501 + response_type='InlineResponse20030', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -9807,7 +9909,7 @@ def get_campaign_analytics(self, application_id, campaign_id, range_start, range number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20021 + :return: InlineResponse20020 If the method is called asynchronously, returns the request thread. """ @@ -9838,7 +9940,7 @@ def get_campaign_analytics_with_http_info(self, application_id, campaign_id, ran number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20021, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20020, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -9923,7 +10025,7 @@ def get_campaign_analytics_with_http_info(self, application_id, campaign_id, ran body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20021', # noqa: E501 + response_type='InlineResponse20020', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -10484,7 +10586,7 @@ def get_campaigns(self, application_id, **kwargs): # noqa: E501 :param datetime created_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param datetime created_after: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param int campaign_group_id: Filter results to campaigns owned by the specified campaign access group ID. - :param int template_id: The ID of the Campaign Template this Campaign was created from. + :param int template_id: The ID of the campaign template this campaign was created from. :param int store_id: Filter results to campaigns linked to the specified store ID. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response @@ -10520,7 +10622,7 @@ def get_campaigns_with_http_info(self, application_id, **kwargs): # noqa: E501 :param datetime created_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param datetime created_after: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param int campaign_group_id: Filter results to campaigns owned by the specified campaign access group ID. - :param int template_id: The ID of the Campaign Template this Campaign was created from. + :param int template_id: The ID of the campaign template this campaign was created from. :param int store_id: Filter results to campaigns linked to the specified store ID. :param _return_http_data_only: response data without head status code and headers @@ -10665,7 +10767,7 @@ def get_changes(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20042 + :return: InlineResponse20041 If the method is called asynchronously, returns the request thread. """ @@ -10702,7 +10804,7 @@ def get_changes_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20042, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20041, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -10793,7 +10895,7 @@ def get_changes_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20042', # noqa: E501 + response_type='InlineResponse20041', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -11083,9 +11185,9 @@ def get_coupons_without_total_count(self, application_id, campaign_id, **kwargs) :param str usable: Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. :param str redeemed: - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. :param int referral_id: Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - :param str recipient_integration_id: Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field + :param str recipient_integration_id: Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. :param str batch_id: Filter results by batches of coupons - :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code + :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code. :param datetime expires_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param datetime expires_after: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param datetime starts_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. @@ -11127,9 +11229,9 @@ def get_coupons_without_total_count_with_http_info(self, application_id, campaig :param str usable: Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. :param str redeemed: - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. :param int referral_id: Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - :param str recipient_integration_id: Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field + :param str recipient_integration_id: Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. :param str batch_id: Filter results by batches of coupons - :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code + :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code. :param datetime expires_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param datetime expires_after: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param datetime starts_before: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. @@ -11449,10 +11551,10 @@ def get_customer_activity_reports_without_total_count(self, range_start, range_e :param int page_size: The number of items in the response. :param int skip: The number of items to skip when paging through large result sets. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. - :param str name: Only return reports matching the customer name + :param str name: Only return reports matching the customer name. :param str integration_id: Filter results performing an exact matching against the profile integration identifier. - :param str campaign_name: Only return reports matching the campaignName - :param str advocate_name: Only return reports matching the current customer referrer name + :param str campaign_name: Only return reports matching the campaign name. + :param str advocate_name: Only return reports matching the current customer referrer name. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -11460,7 +11562,7 @@ def get_customer_activity_reports_without_total_count(self, range_start, range_e number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20026 + :return: InlineResponse20025 If the method is called asynchronously, returns the request thread. """ @@ -11483,10 +11585,10 @@ def get_customer_activity_reports_without_total_count_with_http_info(self, range :param int page_size: The number of items in the response. :param int skip: The number of items to skip when paging through large result sets. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. - :param str name: Only return reports matching the customer name + :param str name: Only return reports matching the customer name. :param str integration_id: Filter results performing an exact matching against the profile integration identifier. - :param str campaign_name: Only return reports matching the campaignName - :param str advocate_name: Only return reports matching the current customer referrer name + :param str campaign_name: Only return reports matching the campaign name. + :param str advocate_name: Only return reports matching the current customer referrer name. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -11496,7 +11598,7 @@ def get_customer_activity_reports_without_total_count_with_http_info(self, range number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20026, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20025, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -11596,7 +11698,7 @@ def get_customer_activity_reports_without_total_count_with_http_info(self, range body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20026', # noqa: E501 + response_type='InlineResponse20025', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -11883,7 +11985,7 @@ def get_customer_profile_achievement_progress(self, application_id, integration_ number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20047 + :return: InlineResponse20046 If the method is called asynchronously, returns the request thread. """ @@ -11915,7 +12017,7 @@ def get_customer_profile_achievement_progress_with_http_info(self, application_i number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20047, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20046, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -11999,7 +12101,7 @@ def get_customer_profile_achievement_progress_with_http_info(self, application_i body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20047', # noqa: E501 + response_type='InlineResponse20046', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -12019,7 +12121,7 @@ def get_customer_profiles(self, **kwargs): # noqa: E501 :param async_req bool: execute request asynchronously :param int page_size: The number of items in the response. :param int skip: The number of items to skip when paging through large result sets. - :param bool sandbox: Indicates whether you are pointing to a sandbox or Live customer. + :param bool sandbox: Indicates whether you are pointing to a sandbox or live customer. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -12027,7 +12129,7 @@ def get_customer_profiles(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20025 + :return: InlineResponse20024 If the method is called asynchronously, returns the request thread. """ @@ -12046,7 +12148,7 @@ def get_customer_profiles_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool: execute request asynchronously :param int page_size: The number of items in the response. :param int skip: The number of items to skip when paging through large result sets. - :param bool sandbox: Indicates whether you are pointing to a sandbox or Live customer. + :param bool sandbox: Indicates whether you are pointing to a sandbox or live customer. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -12056,7 +12158,7 @@ def get_customer_profiles_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20025, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20024, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -12123,7 +12225,7 @@ def get_customer_profiles_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20025', # noqa: E501 + response_type='InlineResponse20024', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -12144,7 +12246,7 @@ def get_customers_by_attributes(self, body, **kwargs): # noqa: E501 :param CustomerProfileSearchQuery body: body (required) :param int page_size: The number of items in the response. :param int skip: The number of items to skip when paging through large result sets. - :param bool sandbox: Indicates whether you are pointing to a sandbox or Live customer. + :param bool sandbox: Indicates whether you are pointing to a sandbox or live customer. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -12152,7 +12254,7 @@ def get_customers_by_attributes(self, body, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20024 + :return: InlineResponse20023 If the method is called asynchronously, returns the request thread. """ @@ -12172,7 +12274,7 @@ def get_customers_by_attributes_with_http_info(self, body, **kwargs): # noqa: E :param CustomerProfileSearchQuery body: body (required) :param int page_size: The number of items in the response. :param int skip: The number of items to skip when paging through large result sets. - :param bool sandbox: Indicates whether you are pointing to a sandbox or Live customer. + :param bool sandbox: Indicates whether you are pointing to a sandbox or live customer. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -12182,7 +12284,7 @@ def get_customers_by_attributes_with_http_info(self, body, **kwargs): # noqa: E number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20024, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20023, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -12260,7 +12362,7 @@ def get_customers_by_attributes_with_http_info(self, body, **kwargs): # noqa: E body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20024', # noqa: E501 + response_type='InlineResponse20023', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -12290,7 +12392,7 @@ def get_event_types(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20040 + :return: InlineResponse20039 If the method is called asynchronously, returns the request thread. """ @@ -12321,7 +12423,7 @@ def get_event_types_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20040, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20039, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -12394,7 +12496,7 @@ def get_event_types_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20040', # noqa: E501 + response_type='InlineResponse20039', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -12424,7 +12526,7 @@ def get_exports(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20043 + :return: InlineResponse20042 If the method is called asynchronously, returns the request thread. """ @@ -12455,7 +12557,7 @@ def get_exports_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20043, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20042, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -12528,7 +12630,7 @@ def get_exports_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20043', # noqa: E501 + response_type='InlineResponse20042', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -12831,8 +12933,9 @@ def get_loyalty_cards(self, loyalty_program_id, **kwargs): # noqa: E501 :param int page_size: The number of items in the response. :param int skip: The number of items to skip when paging through large result sets. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. - :param str identifier: Optional query parameter to search cards by identifier. - :param int profile_id: Filter by the profile ID. + :param str identifier: The card code by which to filter loyalty cards in the response. + :param int profile_id: Filter results by customer profile ID. + :param str batch_id: Filter results by loyalty card batch ID. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -12861,8 +12964,9 @@ def get_loyalty_cards_with_http_info(self, loyalty_program_id, **kwargs): # noq :param int page_size: The number of items in the response. :param int skip: The number of items to skip when paging through large result sets. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. - :param str identifier: Optional query parameter to search cards by identifier. - :param int profile_id: Filter by the profile ID. + :param str identifier: The card code by which to filter loyalty cards in the response. + :param int profile_id: Filter results by customer profile ID. + :param str batch_id: Filter results by loyalty card batch ID. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -12885,7 +12989,8 @@ def get_loyalty_cards_with_http_info(self, loyalty_program_id, **kwargs): # noq 'skip', 'sort', 'identifier', - 'profile_id' + 'profile_id', + 'batch_id' ] all_params.extend( [ @@ -12935,6 +13040,8 @@ def get_loyalty_cards_with_http_info(self, loyalty_program_id, **kwargs): # noq query_params.append(('identifier', local_var_params['identifier'])) # noqa: E501 if 'profile_id' in local_var_params and local_var_params['profile_id'] is not None: # noqa: E501 query_params.append(('profileId', local_var_params['profile_id'])) # noqa: E501 + if 'batch_id' in local_var_params and local_var_params['batch_id'] is not None: # noqa: E501 + query_params.append(('batchId', local_var_params['batch_id'])) # noqa: E501 header_params = {} @@ -13589,7 +13696,7 @@ def get_referrals_without_total_count(self, application_id, campaign_id, **kwarg :param datetime created_after: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param str valid: Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future. :param str usable: Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. - :param str advocate: Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field + :param str advocate: Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -13624,7 +13731,7 @@ def get_referrals_without_total_count_with_http_info(self, application_id, campa :param datetime created_after: Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. :param str valid: Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future. :param str usable: Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`. - :param str advocate: Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field + :param str advocate: Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -14386,7 +14493,7 @@ def get_users(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20041 + :return: InlineResponse20040 If the method is called asynchronously, returns the request thread. """ @@ -14415,7 +14522,7 @@ def get_users_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20041, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20040, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -14482,7 +14589,7 @@ def get_users_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20041', # noqa: E501 + response_type='InlineResponse20040', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -14618,9 +14725,9 @@ def get_webhook_activation_logs(self, **kwargs): # noqa: E501 :param int skip: The number of items to skip when paging through large result sets. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. :param str integration_request_uuid: Filter results by integration request UUID. - :param float webhook_id: Filter results by Webhook. + :param float webhook_id: Filter results by webhook id. :param float application_id: Filter results by Application ID. - :param float campaign_id: Filter results by campaign. + :param float campaign_id: Filter results by campaign ID. :param datetime created_before: Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. :param datetime created_after: Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -14630,7 +14737,7 @@ def get_webhook_activation_logs(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20038 + :return: InlineResponse20037 If the method is called asynchronously, returns the request thread. """ @@ -14651,9 +14758,9 @@ def get_webhook_activation_logs_with_http_info(self, **kwargs): # noqa: E501 :param int skip: The number of items to skip when paging through large result sets. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. :param str integration_request_uuid: Filter results by integration request UUID. - :param float webhook_id: Filter results by Webhook. + :param float webhook_id: Filter results by webhook id. :param float application_id: Filter results by Application ID. - :param float campaign_id: Filter results by campaign. + :param float campaign_id: Filter results by campaign ID. :param datetime created_before: Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. :param datetime created_after: Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. :param _return_http_data_only: response data without head status code @@ -14665,7 +14772,7 @@ def get_webhook_activation_logs_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20038, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20037, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -14750,7 +14857,7 @@ def get_webhook_activation_logs_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20038', # noqa: E501 + response_type='InlineResponse20037', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -14772,9 +14879,9 @@ def get_webhook_logs(self, **kwargs): # noqa: E501 :param int skip: The number of items to skip when paging through large result sets. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. :param str status: Filter results by HTTP status codes. - :param float webhook_id: Filter results by Webhook. + :param float webhook_id: Filter results by webhook id. :param float application_id: Filter results by Application ID. - :param float campaign_id: Filter results by campaign. + :param float campaign_id: Filter results by campaign ID. :param str request_uuid: Filter results by request UUID. :param datetime created_before: Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. :param datetime created_after: Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. @@ -14785,7 +14892,7 @@ def get_webhook_logs(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20039 + :return: InlineResponse20038 If the method is called asynchronously, returns the request thread. """ @@ -14806,9 +14913,9 @@ def get_webhook_logs_with_http_info(self, **kwargs): # noqa: E501 :param int skip: The number of items to skip when paging through large result sets. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. :param str status: Filter results by HTTP status codes. - :param float webhook_id: Filter results by Webhook. + :param float webhook_id: Filter results by webhook id. :param float application_id: Filter results by Application ID. - :param float campaign_id: Filter results by campaign. + :param float campaign_id: Filter results by campaign ID. :param str request_uuid: Filter results by request UUID. :param datetime created_before: Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. :param datetime created_after: Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. @@ -14821,7 +14928,7 @@ def get_webhook_logs_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20039, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20038, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -14909,7 +15016,7 @@ def get_webhook_logs_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20039', # noqa: E501 + response_type='InlineResponse20038', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -14942,7 +15049,7 @@ def get_webhooks(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20037 + :return: InlineResponse20036 If the method is called asynchronously, returns the request thread. """ @@ -14976,7 +15083,7 @@ def get_webhooks_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20037, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20036, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -15058,7 +15165,7 @@ def get_webhooks_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20037', # noqa: E501 + response_type='InlineResponse20036', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -15848,7 +15955,7 @@ def import_coupons_with_http_info(self, application_id, campaign_id, **kwargs): def import_loyalty_cards(self, loyalty_program_id, **kwargs): # noqa: E501 """Import loyalty cards # noqa: E501 - 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 ``` # noqa: E501 + 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. The identifiers should be separated with a semicolon (;). **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ``` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.import_loyalty_cards(loyalty_program_id, async_req=True) @@ -15874,7 +15981,7 @@ def import_loyalty_cards(self, loyalty_program_id, **kwargs): # noqa: E501 def import_loyalty_cards_with_http_info(self, loyalty_program_id, **kwargs): # noqa: E501 """Import loyalty cards # noqa: E501 - 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 ``` # noqa: E501 + 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. The identifiers should be separated with a semicolon (;). **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ``` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.import_loyalty_cards_with_http_info(loyalty_program_id, async_req=True) @@ -16094,7 +16201,7 @@ def import_loyalty_customers_tiers_with_http_info(self, loyalty_program_id, **kw def import_loyalty_points(self, loyalty_program_id, **kwargs): # noqa: E501 """Import loyalty points # noqa: E501 - Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` # noqa: E501 + Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.import_loyalty_points(loyalty_program_id, async_req=True) @@ -16120,7 +16227,7 @@ def import_loyalty_points(self, loyalty_program_id, **kwargs): # noqa: E501 def import_loyalty_points_with_http_info(self, loyalty_program_id, **kwargs): # noqa: E501 """Import loyalty points # noqa: E501 - Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` # noqa: E501 + Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.import_loyalty_points_with_http_info(loyalty_program_id, async_req=True) @@ -16739,7 +16846,7 @@ def list_achievements(self, application_id, campaign_id, **kwargs): # noqa: E50 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20046 + :return: InlineResponse20045 If the method is called asynchronously, returns the request thread. """ @@ -16770,7 +16877,7 @@ def list_achievements_with_http_info(self, application_id, campaign_id, **kwargs number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20046, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20045, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -16851,7 +16958,7 @@ def list_achievements_with_http_info(self, application_id, campaign_id, **kwargs body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20046', # noqa: E501 + response_type='InlineResponse20045', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -16876,7 +16983,7 @@ def list_all_roles_v2(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20044 + :return: InlineResponse20043 If the method is called asynchronously, returns the request thread. """ @@ -16902,7 +17009,7 @@ def list_all_roles_v2_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20044, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20043, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -16956,7 +17063,7 @@ def list_all_roles_v2_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20044', # noqa: E501 + response_type='InlineResponse20043', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -16987,7 +17094,7 @@ def list_catalog_items(self, catalog_id, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20035 + :return: InlineResponse20034 If the method is called asynchronously, returns the request thread. """ @@ -17019,7 +17126,7 @@ def list_catalog_items_with_http_info(self, catalog_id, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20035, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20034, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -17101,7 +17208,7 @@ def list_catalog_items_with_http_info(self, catalog_id, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20035', # noqa: E501 + response_type='InlineResponse20034', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -17419,7 +17526,7 @@ def list_stores(self, application_id, **kwargs): # noqa: E501 :param int skip: The number of items to skip when paging through large result sets. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. :param bool with_total_result_size: When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. - :param float campaign_id: Filter results by campaign. + :param float campaign_id: Filter results by campaign ID. :param str name: The name of the store. :param str integration_id: The integration ID of the store. :param str query: Filter results by `name` or `integrationId`. @@ -17430,7 +17537,7 @@ def list_stores(self, application_id, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: InlineResponse20045 + :return: InlineResponse20044 If the method is called asynchronously, returns the request thread. """ @@ -17452,7 +17559,7 @@ def list_stores_with_http_info(self, application_id, **kwargs): # noqa: E501 :param int skip: The number of items to skip when paging through large result sets. :param str sort: The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. :param bool with_total_result_size: When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. - :param float campaign_id: Filter results by campaign. + :param float campaign_id: Filter results by campaign ID. :param str name: The name of the store. :param str integration_id: The integration ID of the store. :param str query: Filter results by `name` or `integrationId`. @@ -17465,7 +17572,7 @@ def list_stores_with_http_info(self, application_id, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: tuple(InlineResponse20045, status_code(int), headers(HTTPHeaderDict)) + :return: tuple(InlineResponse20044, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -17554,7 +17661,7 @@ def list_stores_with_http_info(self, application_id, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse20045', # noqa: E501 + response_type='InlineResponse20044', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -18431,7 +18538,7 @@ def scim_create_user(self, body, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param object body: body (required) + :param ScimNewUser body: body (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -18456,7 +18563,7 @@ def scim_create_user_with_http_info(self, body, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool: execute request asynchronously - :param object body: body (required) + :param ScimNewUser body: body (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -18771,7 +18878,7 @@ def scim_get_schemas(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: None + :return: ScimSchemasListResponse If the method is called asynchronously, returns the request thread. """ @@ -18797,7 +18904,7 @@ def scim_get_schemas_with_http_info(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: None + :return: tuple(ScimSchemasListResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -18836,6 +18943,10 @@ def scim_get_schemas_with_http_info(self, **kwargs): # noqa: E501 local_var_files = {} body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + # Authentication setting auth_settings = ['management_key', 'manager_auth'] # noqa: E501 @@ -18847,7 +18958,7 @@ def scim_get_schemas_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type=None, # noqa: E501 + response_type='ScimSchemasListResponse', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -18856,9 +18967,9 @@ def scim_get_schemas_with_http_info(self, **kwargs): # noqa: E501 collection_formats=collection_formats) def scim_get_service_provider_config(self, **kwargs): # noqa: E501 - """Service config endpoint for SCIM provisioning protocol # noqa: E501 + """Get SCIM service provider configuration # noqa: E501 - Service config endpoint for SCIM provisioning protocol # noqa: E501 + Retrieve the configuration settings of the SCIM service provider. It provides details about the features and capabilities supported by the SCIM API, such as the different operation settings. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.scim_get_service_provider_config(async_req=True) @@ -18872,7 +18983,7 @@ def scim_get_service_provider_config(self, **kwargs): # noqa: E501 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: None + :return: ScimServiceProviderConfigResponse If the method is called asynchronously, returns the request thread. """ @@ -18880,9 +18991,9 @@ def scim_get_service_provider_config(self, **kwargs): # noqa: E501 return self.scim_get_service_provider_config_with_http_info(**kwargs) # noqa: E501 def scim_get_service_provider_config_with_http_info(self, **kwargs): # noqa: E501 - """Service config endpoint for SCIM provisioning protocol # noqa: E501 + """Get SCIM service provider configuration # noqa: E501 - Service config endpoint for SCIM provisioning protocol # noqa: E501 + Retrieve the configuration settings of the SCIM service provider. It provides details about the features and capabilities supported by the SCIM API, such as the different operation settings. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.scim_get_service_provider_config_with_http_info(async_req=True) @@ -18898,7 +19009,7 @@ def scim_get_service_provider_config_with_http_info(self, **kwargs): # noqa: E5 number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. - :return: None + :return: tuple(ScimServiceProviderConfigResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ @@ -18937,6 +19048,10 @@ def scim_get_service_provider_config_with_http_info(self, **kwargs): # noqa: E5 local_var_files = {} body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + # Authentication setting auth_settings = ['management_key', 'manager_auth'] # noqa: E501 @@ -18948,7 +19063,7 @@ def scim_get_service_provider_config_with_http_info(self, **kwargs): # noqa: E5 body=body_params, post_params=form_params, files=local_var_files, - response_type=None, # noqa: E501 + response_type='ScimServiceProviderConfigResponse', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 @@ -19175,17 +19290,18 @@ def scim_get_users_with_http_info(self, **kwargs): # noqa: E501 _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) - def scim_patch_user(self, user_id, **kwargs): # noqa: E501 + def scim_patch_user(self, user_id, body, **kwargs): # noqa: E501 """Update SCIM user attributes # noqa: E501 Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.scim_patch_user(user_id, async_req=True) + >>> thread = api.scim_patch_user(user_id, body, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int user_id: The ID of the user. (required) + :param ScimPatchRequest body: body (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -19198,19 +19314,20 @@ def scim_patch_user(self, user_id, **kwargs): # noqa: E501 returns the request thread. """ kwargs['_return_http_data_only'] = True - return self.scim_patch_user_with_http_info(user_id, **kwargs) # noqa: E501 + return self.scim_patch_user_with_http_info(user_id, body, **kwargs) # noqa: E501 - def scim_patch_user_with_http_info(self, user_id, **kwargs): # noqa: E501 + def scim_patch_user_with_http_info(self, user_id, body, **kwargs): # noqa: E501 """Update SCIM user attributes # noqa: E501 Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.scim_patch_user_with_http_info(user_id, async_req=True) + >>> thread = api.scim_patch_user_with_http_info(user_id, body, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int user_id: The ID of the user. (required) + :param ScimPatchRequest body: body (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -19228,7 +19345,8 @@ def scim_patch_user_with_http_info(self, user_id, **kwargs): # noqa: E501 local_var_params = locals() all_params = [ - 'user_id' + 'user_id', + 'body' ] all_params.extend( [ @@ -19251,6 +19369,10 @@ def scim_patch_user_with_http_info(self, user_id, **kwargs): # noqa: E501 if self.api_client.client_side_validation and ('user_id' not in local_var_params or # noqa: E501 local_var_params['user_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `user_id` when calling `scim_patch_user`") # noqa: E501 + # verify the required parameter 'body' is set + if self.api_client.client_side_validation and ('body' not in local_var_params or # noqa: E501 + local_var_params['body'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `body` when calling `scim_patch_user`") # noqa: E501 collection_formats = {} @@ -19266,10 +19388,16 @@ def scim_patch_user_with_http_info(self, user_id, **kwargs): # noqa: E501 local_var_files = {} body_params = None + if 'body' in local_var_params: + body_params = local_var_params['body'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json']) # noqa: E501 + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + # Authentication setting auth_settings = ['management_key', 'manager_auth'] # noqa: E501 @@ -19300,7 +19428,7 @@ def scim_replace_user_attributes(self, user_id, body, **kwargs): # noqa: E501 :param async_req bool: execute request asynchronously :param int user_id: The ID of the user. (required) - :param object body: body (required) + :param ScimNewUser body: body (required) :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. @@ -19326,7 +19454,7 @@ def scim_replace_user_attributes_with_http_info(self, user_id, body, **kwargs): :param async_req bool: execute request asynchronously :param int user_id: The ID of the user. (required) - :param object body: body (required) + :param ScimNewUser body: body (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will @@ -19437,9 +19565,9 @@ def search_coupons_advanced_application_wide_without_total_count(self, applicati :param str valid: 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. :param str usable: Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. :param int referral_id: Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - :param str recipient_integration_id: Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field + :param str recipient_integration_id: Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. :param str batch_id: Filter results by batches of coupons - :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code + :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code. :param str campaign_state: Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response @@ -19476,9 +19604,9 @@ def search_coupons_advanced_application_wide_without_total_count_with_http_info( :param str valid: 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. :param str usable: Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. :param int referral_id: Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - :param str recipient_integration_id: Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field + :param str recipient_integration_id: Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. :param str batch_id: Filter results by batches of coupons - :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code + :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code. :param str campaign_state: Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. :param _return_http_data_only: response data without head status code and headers @@ -19634,8 +19762,8 @@ def search_coupons_advanced_without_total_count(self, application_id, campaign_i :param str valid: 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. :param str usable: Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. :param int referral_id: Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - :param str recipient_integration_id: Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field - :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code + :param str recipient_integration_id: Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. + :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code. :param str batch_id: Filter results by batches of coupons :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response @@ -19673,8 +19801,8 @@ def search_coupons_advanced_without_total_count_with_http_info(self, application :param str valid: 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. :param str usable: Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. :param int referral_id: Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. - :param str recipient_integration_id: Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field - :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code + :param str recipient_integration_id: Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. + :param bool exact_match: Filter results to an exact case-insensitive matching against the coupon code. :param str batch_id: Filter results by batches of coupons :param _return_http_data_only: response data without head status code and headers @@ -20480,7 +20608,7 @@ def update_attribute_with_http_info(self, attribute_id, body, **kwargs): # noqa def update_campaign(self, application_id, campaign_id, body, **kwargs): # noqa: E501 """Update campaign # noqa: E501 - Update the given campaign. # noqa: E501 + Update the given campaign. **Important:** You cannot use this endpoint to update campaigns if [campaign staging and revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) is enabled for your Application. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_campaign(application_id, campaign_id, body, async_req=True) @@ -20507,7 +20635,7 @@ def update_campaign(self, application_id, campaign_id, body, **kwargs): # noqa: def update_campaign_with_http_info(self, application_id, campaign_id, body, **kwargs): # noqa: E501 """Update campaign # noqa: E501 - Update the given campaign. # noqa: E501 + Update the given campaign. **Important:** You cannot use this endpoint to update campaigns if [campaign staging and revisions](https://docs.talon.one/docs/product/applications/managing-general-settings#campaign-staging-and-revisions) is enabled for your Application. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_campaign_with_http_info(application_id, campaign_id, body, async_req=True) @@ -20761,7 +20889,7 @@ def update_collection_with_http_info(self, application_id, campaign_id, collecti def update_coupon(self, application_id, campaign_id, coupon_id, body, **kwargs): # noqa: E501 """Update coupon # noqa: E501 - Update the specified coupon.

Important

With this PUT endpoint alone, if you do not explicitly set a value for the startDate, expiryDate, and recipientIntegrationId properties in your request, it is automatically set to null.

# noqa: E501 + Update the specified coupon.

Important

With this PUT endpoint, if you do not explicitly set a value for the startDate, expiryDate, and recipientIntegrationId properties in your request, it is automatically set to null.

# noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_coupon(application_id, campaign_id, coupon_id, body, async_req=True) @@ -20789,7 +20917,7 @@ def update_coupon(self, application_id, campaign_id, coupon_id, body, **kwargs): def update_coupon_with_http_info(self, application_id, campaign_id, coupon_id, body, **kwargs): # noqa: E501 """Update coupon # noqa: E501 - Update the specified coupon.

Important

With this PUT endpoint alone, if you do not explicitly set a value for the startDate, expiryDate, and recipientIntegrationId properties in your request, it is automatically set to null.

# noqa: E501 + Update the specified coupon.

Important

With this PUT endpoint, if you do not explicitly set a value for the startDate, expiryDate, and recipientIntegrationId properties in your request, it is automatically set to null.

# noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_coupon_with_http_info(application_id, campaign_id, coupon_id, body, async_req=True) @@ -20906,7 +21034,7 @@ def update_coupon_with_http_info(self, application_id, campaign_id, coupon_id, b def update_coupon_batch(self, application_id, campaign_id, body, **kwargs): # noqa: E501 """Update coupons # noqa: E501 - Update all coupons, or a specific batch of coupons in the given campaign. You can find the `batchId` in the **Coupons** view of your Application in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount).

Important

To update a specific coupon, use [Update coupon](#operation/updateCoupon). # noqa: E501 + Update all coupons or a specific batch of coupons in the given campaign. You can find the `batchId` on the **Coupons** page of your campaign in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount).

Important

To update a specific coupon, use [Update coupon](#operation/updateCoupon). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_coupon_batch(application_id, campaign_id, body, async_req=True) @@ -20933,7 +21061,7 @@ def update_coupon_batch(self, application_id, campaign_id, body, **kwargs): # n def update_coupon_batch_with_http_info(self, application_id, campaign_id, body, **kwargs): # noqa: E501 """Update coupons # noqa: E501 - Update all coupons, or a specific batch of coupons in the given campaign. You can find the `batchId` in the **Coupons** view of your Application in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount).

Important

To update a specific coupon, use [Update coupon](#operation/updateCoupon). # noqa: E501 + Update all coupons or a specific batch of coupons in the given campaign. You can find the `batchId` on the **Coupons** page of your campaign in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount).

Important

To update a specific coupon, use [Update coupon](#operation/updateCoupon). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_coupon_batch_with_http_info(application_id, campaign_id, body, async_req=True) diff --git a/talon_one/api_client.py b/talon_one/api_client.py index e9273e5..fc6614d 100644 --- a/talon_one/api_client.py +++ b/talon_one/api_client.py @@ -78,7 +78,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/6.1.1/python' + self.user_agent = 'OpenAPI-Generator/7.0.0/python' self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/talon_one/configuration.py b/talon_one/configuration.py index ac8e9c1..6da32de 100644 --- a/talon_one/configuration.py +++ b/talon_one/configuration.py @@ -366,7 +366,7 @@ def to_debug_report(self): "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: \n"\ - "SDK Package Version: 6.1.1".\ + "SDK Package Version: 7.0.0".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self): diff --git a/talon_one/models/__init__.py b/talon_one/models/__init__.py index 50b836f..a665dae 100644 --- a/talon_one/models/__init__.py +++ b/talon_one/models/__init__.py @@ -32,7 +32,6 @@ from talon_one.models.achievement import Achievement from talon_one.models.achievement_additional_properties import AchievementAdditionalProperties from talon_one.models.achievement_progress import AchievementProgress -from talon_one.models.activate_user_request import ActivateUserRequest from talon_one.models.add_free_item_effect_props import AddFreeItemEffectProps from talon_one.models.add_item_catalog_action import AddItemCatalogAction from talon_one.models.add_loyalty_points import AddLoyaltyPoints @@ -45,10 +44,14 @@ from talon_one.models.analytics_data_point_with_trend import AnalyticsDataPointWithTrend from talon_one.models.analytics_data_point_with_trend_and_influenced_rate import AnalyticsDataPointWithTrendAndInfluencedRate from talon_one.models.analytics_data_point_with_trend_and_uplift import AnalyticsDataPointWithTrendAndUplift +from talon_one.models.analytics_product import AnalyticsProduct +from talon_one.models.analytics_product_sku import AnalyticsProductSKU from talon_one.models.application import Application from talon_one.models.application_api_key import ApplicationAPIKey from talon_one.models.application_analytics_data_point import ApplicationAnalyticsDataPoint from talon_one.models.application_api_health import ApplicationApiHealth +from talon_one.models.application_cif import ApplicationCIF +from talon_one.models.application_cif_expression import ApplicationCIFExpression from talon_one.models.application_campaign_analytics import ApplicationCampaignAnalytics from talon_one.models.application_campaign_stats import ApplicationCampaignStats from talon_one.models.application_customer import ApplicationCustomer @@ -108,9 +111,12 @@ from talon_one.models.campaign_set_leaf_node import CampaignSetLeafNode from talon_one.models.campaign_set_node import CampaignSetNode from talon_one.models.campaign_state_changed_notification import CampaignStateChangedNotification +from talon_one.models.campaign_store_budget import CampaignStoreBudget from talon_one.models.campaign_template import CampaignTemplate from talon_one.models.campaign_template_collection import CampaignTemplateCollection +from talon_one.models.campaign_template_coupon_reservation_settings import CampaignTemplateCouponReservationSettings from talon_one.models.campaign_template_params import CampaignTemplateParams +from talon_one.models.campaign_versions import CampaignVersions from talon_one.models.card_added_deducted_points_notification_policy import CardAddedDeductedPointsNotificationPolicy from talon_one.models.card_expiring_points_notification_policy import CardExpiringPointsNotificationPolicy from talon_one.models.card_expiring_points_notification_trigger import CardExpiringPointsNotificationTrigger @@ -165,7 +171,6 @@ from talon_one.models.deactivate_user_request import DeactivateUserRequest from talon_one.models.deduct_loyalty_points import DeductLoyaltyPoints from talon_one.models.deduct_loyalty_points_effect_props import DeductLoyaltyPointsEffectProps -from talon_one.models.delete_user_request import DeleteUserRequest from talon_one.models.effect import Effect from talon_one.models.effect_entity import EffectEntity from talon_one.models.email_entity import EmailEntity @@ -244,7 +249,6 @@ from talon_one.models.inline_response20044 import InlineResponse20044 from talon_one.models.inline_response20045 import InlineResponse20045 from talon_one.models.inline_response20046 import InlineResponse20046 -from talon_one.models.inline_response20047 import InlineResponse20047 from talon_one.models.inline_response2005 import InlineResponse2005 from talon_one.models.inline_response2006 import InlineResponse2006 from talon_one.models.inline_response2007 import InlineResponse2007 @@ -271,6 +275,8 @@ from talon_one.models.library_attribute import LibraryAttribute from talon_one.models.limit_config import LimitConfig from talon_one.models.limit_counter import LimitCounter +from talon_one.models.list_campaign_store_budgets import ListCampaignStoreBudgets +from talon_one.models.list_campaign_store_budgets_store import ListCampaignStoreBudgetsStore from talon_one.models.login_params import LoginParams from talon_one.models.loyalty import Loyalty from talon_one.models.loyalty_balance import LoyaltyBalance @@ -279,6 +285,8 @@ from talon_one.models.loyalty_balances_with_tiers import LoyaltyBalancesWithTiers from talon_one.models.loyalty_card import LoyaltyCard from talon_one.models.loyalty_card_balances import LoyaltyCardBalances +from talon_one.models.loyalty_card_batch import LoyaltyCardBatch +from talon_one.models.loyalty_card_batch_response import LoyaltyCardBatchResponse from talon_one.models.loyalty_card_profile_registration import LoyaltyCardProfileRegistration from talon_one.models.loyalty_card_registration import LoyaltyCardRegistration from talon_one.models.loyalty_dashboard_data import LoyaltyDashboardData @@ -291,7 +299,6 @@ from talon_one.models.loyalty_program_balance import LoyaltyProgramBalance from talon_one.models.loyalty_program_entity import LoyaltyProgramEntity from talon_one.models.loyalty_program_ledgers import LoyaltyProgramLedgers -from talon_one.models.loyalty_program_subledgers import LoyaltyProgramSubledgers from talon_one.models.loyalty_program_transaction import LoyaltyProgramTransaction from talon_one.models.loyalty_sub_ledger import LoyaltySubLedger from talon_one.models.loyalty_tier import LoyaltyTier @@ -320,6 +327,8 @@ from talon_one.models.new_app_wide_coupon_deletion_job import NewAppWideCouponDeletionJob from talon_one.models.new_application import NewApplication from talon_one.models.new_application_api_key import NewApplicationAPIKey +from talon_one.models.new_application_cif import NewApplicationCIF +from talon_one.models.new_application_cif_expression import NewApplicationCIFExpression from talon_one.models.new_attribute import NewAttribute from talon_one.models.new_audience import NewAudience from talon_one.models.new_base_notification import NewBaseNotification @@ -328,6 +337,8 @@ from talon_one.models.new_campaign_evaluation_group import NewCampaignEvaluationGroup from talon_one.models.new_campaign_group import NewCampaignGroup from talon_one.models.new_campaign_set import NewCampaignSet +from talon_one.models.new_campaign_store_budget import NewCampaignStoreBudget +from talon_one.models.new_campaign_store_budget_store_limit import NewCampaignStoreBudgetStoreLimit from talon_one.models.new_campaign_template import NewCampaignTemplate from talon_one.models.new_catalog import NewCatalog from talon_one.models.new_collection import NewCollection @@ -359,6 +370,7 @@ from talon_one.models.new_referral import NewReferral from talon_one.models.new_referrals_for_multiple_advocates import NewReferralsForMultipleAdvocates from talon_one.models.new_return import NewReturn +from talon_one.models.new_revision_version import NewRevisionVersion from talon_one.models.new_role import NewRole from talon_one.models.new_role_v2 import NewRoleV2 from talon_one.models.new_ruleset import NewRuleset @@ -391,6 +403,9 @@ from talon_one.models.pending_points_notification_policy import PendingPointsNotificationPolicy from talon_one.models.picklist import Picklist from talon_one.models.product import Product +from talon_one.models.product_search_match import ProductSearchMatch +from talon_one.models.product_sku_unit_analytics import ProductSkuUnitAnalytics +from talon_one.models.product_unit_analytics import ProductUnitAnalytics from talon_one.models.profile_audiences_changes import ProfileAudiencesChanges from talon_one.models.projected_tier import ProjectedTier from talon_one.models.redeem_referral_effect_props import RedeemReferralEffectProps @@ -407,6 +422,9 @@ from talon_one.models.reserve_coupon_effect_props import ReserveCouponEffectProps from talon_one.models.return_integration_request import ReturnIntegrationRequest from talon_one.models.returned_cart_item import ReturnedCartItem +from talon_one.models.revision import Revision +from talon_one.models.revision_activation import RevisionActivation +from talon_one.models.revision_version import RevisionVersion from talon_one.models.role import Role from talon_one.models.role_assign import RoleAssign from talon_one.models.role_membership import RoleMembership @@ -430,9 +448,21 @@ from talon_one.models.saml_connection_internal import SamlConnectionInternal from talon_one.models.saml_connection_metadata import SamlConnectionMetadata from talon_one.models.saml_login_endpoint import SamlLoginEndpoint +from talon_one.models.scim_base_user import ScimBaseUser +from talon_one.models.scim_base_user_name import ScimBaseUserName from talon_one.models.scim_new_user import ScimNewUser +from talon_one.models.scim_patch_operation import ScimPatchOperation +from talon_one.models.scim_patch_request import ScimPatchRequest from talon_one.models.scim_resource import ScimResource from talon_one.models.scim_resource_types_list_response import ScimResourceTypesListResponse +from talon_one.models.scim_schema_resource import ScimSchemaResource +from talon_one.models.scim_schemas_list_response import ScimSchemasListResponse +from talon_one.models.scim_service_provider_config_response import ScimServiceProviderConfigResponse +from talon_one.models.scim_service_provider_config_response_bulk import ScimServiceProviderConfigResponseBulk +from talon_one.models.scim_service_provider_config_response_change_password import ScimServiceProviderConfigResponseChangePassword +from talon_one.models.scim_service_provider_config_response_filter import ScimServiceProviderConfigResponseFilter +from talon_one.models.scim_service_provider_config_response_patch import ScimServiceProviderConfigResponsePatch +from talon_one.models.scim_service_provider_config_response_sort import ScimServiceProviderConfigResponseSort from talon_one.models.scim_user import ScimUser from talon_one.models.scim_users_list_response import ScimUsersListResponse from talon_one.models.session import Session @@ -446,10 +476,12 @@ from talon_one.models.store import Store from talon_one.models.strikethrough_changed_item import StrikethroughChangedItem from talon_one.models.strikethrough_custom_effect_per_item_props import StrikethroughCustomEffectPerItemProps +from talon_one.models.strikethrough_debug_response import StrikethroughDebugResponse from talon_one.models.strikethrough_effect import StrikethroughEffect from talon_one.models.strikethrough_labeling_notification import StrikethroughLabelingNotification from talon_one.models.strikethrough_set_discount_per_item_effect_props import StrikethroughSetDiscountPerItemEffectProps from talon_one.models.strikethrough_trigger import StrikethroughTrigger +from talon_one.models.summary_campaign_store_budget import SummaryCampaignStoreBudget from talon_one.models.talang_attribute import TalangAttribute from talon_one.models.talang_attribute_visibility import TalangAttributeVisibility from talon_one.models.template_arg_def import TemplateArgDef @@ -469,6 +501,7 @@ from talon_one.models.update_achievement import UpdateAchievement from talon_one.models.update_application import UpdateApplication from talon_one.models.update_application_api_key import UpdateApplicationAPIKey +from talon_one.models.update_application_cif import UpdateApplicationCIF from talon_one.models.update_attribute_effect_props import UpdateAttributeEffectProps from talon_one.models.update_audience import UpdateAudience from talon_one.models.update_campaign import UpdateCampaign @@ -480,9 +513,9 @@ from talon_one.models.update_collection import UpdateCollection from talon_one.models.update_coupon import UpdateCoupon from talon_one.models.update_coupon_batch import UpdateCouponBatch -from talon_one.models.update_custom_effect import UpdateCustomEffect from talon_one.models.update_loyalty_card import UpdateLoyaltyCard from talon_one.models.update_loyalty_program import UpdateLoyaltyProgram +from talon_one.models.update_loyalty_program_tier import UpdateLoyaltyProgramTier from talon_one.models.update_picklist import UpdatePicklist from talon_one.models.update_referral import UpdateReferral from talon_one.models.update_referral_batch import UpdateReferralBatch @@ -491,6 +524,7 @@ from talon_one.models.update_user import UpdateUser from talon_one.models.user import User from talon_one.models.user_entity import UserEntity +from talon_one.models.value_map import ValueMap from talon_one.models.webhook import Webhook from talon_one.models.webhook_activation_log_entry import WebhookActivationLogEntry from talon_one.models.webhook_log_entry import WebhookLogEntry diff --git a/talon_one/models/achievement.py b/talon_one/models/achievement.py index 79343dd..6144663 100644 --- a/talon_one/models/achievement.py +++ b/talon_one/models/achievement.py @@ -41,6 +41,10 @@ class Achievement(object): 'target': 'float', 'period': 'str', 'period_end_override': 'TimePoint', + 'recurrence_policy': 'str', + 'activation_policy': 'str', + 'fixed_start_date': 'datetime', + 'end_date': 'datetime', 'campaign_id': 'int', 'user_id': 'int', 'created_by': 'str', @@ -56,13 +60,17 @@ class Achievement(object): 'target': 'target', 'period': 'period', 'period_end_override': 'periodEndOverride', + 'recurrence_policy': 'recurrencePolicy', + 'activation_policy': 'activationPolicy', + 'fixed_start_date': 'fixedStartDate', + 'end_date': 'endDate', 'campaign_id': 'campaignId', 'user_id': 'userId', 'created_by': 'createdBy', 'has_progress': 'hasProgress' } - def __init__(self, id=None, created=None, name=None, title=None, description=None, target=None, period=None, period_end_override=None, campaign_id=None, user_id=None, created_by=None, has_progress=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, id=None, created=None, name=None, title=None, description=None, target=None, period=None, period_end_override=None, recurrence_policy=None, activation_policy=None, fixed_start_date=None, end_date=None, campaign_id=None, user_id=None, created_by=None, has_progress=None, local_vars_configuration=None): # noqa: E501 """Achievement - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -76,6 +84,10 @@ def __init__(self, id=None, created=None, name=None, title=None, description=Non self._target = None self._period = None self._period_end_override = None + self._recurrence_policy = None + self._activation_policy = None + self._fixed_start_date = None + self._end_date = None self._campaign_id = None self._user_id = None self._created_by = None @@ -91,6 +103,14 @@ def __init__(self, id=None, created=None, name=None, title=None, description=Non self.period = period if period_end_override is not None: self.period_end_override = period_end_override + if recurrence_policy is not None: + self.recurrence_policy = recurrence_policy + if activation_policy is not None: + self.activation_policy = activation_policy + if fixed_start_date is not None: + self.fixed_start_date = fixed_start_date + if end_date is not None: + self.end_date = end_date self.campaign_id = campaign_id self.user_id = user_id self.created_by = created_by @@ -302,6 +322,110 @@ def period_end_override(self, period_end_override): self._period_end_override = period_end_override + @property + def recurrence_policy(self): + """Gets the recurrence_policy of this Achievement. # noqa: E501 + + The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. # noqa: E501 + + :return: The recurrence_policy of this Achievement. # noqa: E501 + :rtype: str + """ + return self._recurrence_policy + + @recurrence_policy.setter + def recurrence_policy(self, recurrence_policy): + """Sets the recurrence_policy of this Achievement. + + The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. # noqa: E501 + + :param recurrence_policy: The recurrence_policy of this Achievement. # noqa: E501 + :type: str + """ + allowed_values = ["no_recurrence", "on_expiration"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and recurrence_policy not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `recurrence_policy` ({0}), must be one of {1}" # noqa: E501 + .format(recurrence_policy, allowed_values) + ) + + self._recurrence_policy = recurrence_policy + + @property + def activation_policy(self): + """Gets the activation_policy of this Achievement. # noqa: E501 + + The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. # noqa: E501 + + :return: The activation_policy of this Achievement. # noqa: E501 + :rtype: str + """ + return self._activation_policy + + @activation_policy.setter + def activation_policy(self, activation_policy): + """Sets the activation_policy of this Achievement. + + The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. # noqa: E501 + + :param activation_policy: The activation_policy of this Achievement. # noqa: E501 + :type: str + """ + allowed_values = ["user_action", "fixed_schedule"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and activation_policy not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `activation_policy` ({0}), must be one of {1}" # noqa: E501 + .format(activation_policy, allowed_values) + ) + + self._activation_policy = activation_policy + + @property + def fixed_start_date(self): + """Gets the fixed_start_date of this Achievement. # noqa: E501 + + The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :return: The fixed_start_date of this Achievement. # noqa: E501 + :rtype: datetime + """ + return self._fixed_start_date + + @fixed_start_date.setter + def fixed_start_date(self, fixed_start_date): + """Sets the fixed_start_date of this Achievement. + + The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :param fixed_start_date: The fixed_start_date of this Achievement. # noqa: E501 + :type: datetime + """ + + self._fixed_start_date = fixed_start_date + + @property + def end_date(self): + """Gets the end_date of this Achievement. # noqa: E501 + + The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :return: The end_date of this Achievement. # noqa: E501 + :rtype: datetime + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this Achievement. + + The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :param end_date: The end_date of this Achievement. # noqa: E501 + :type: datetime + """ + + self._end_date = end_date + @property def campaign_id(self): """Gets the campaign_id of this Achievement. # noqa: E501 diff --git a/talon_one/models/achievement_progress.py b/talon_one/models/achievement_progress.py index f8e3509..6dff3a9 100644 --- a/talon_one/models/achievement_progress.py +++ b/talon_one/models/achievement_progress.py @@ -36,6 +36,7 @@ class AchievementProgress(object): 'achievement_id': 'int', 'name': 'str', 'title': 'str', + 'description': 'str', 'campaign_id': 'int', 'status': 'str', 'target': 'float', @@ -49,6 +50,7 @@ class AchievementProgress(object): 'achievement_id': 'achievementId', 'name': 'name', 'title': 'title', + 'description': 'description', 'campaign_id': 'campaignId', 'status': 'status', 'target': 'target', @@ -58,7 +60,7 @@ class AchievementProgress(object): 'end_date': 'endDate' } - def __init__(self, achievement_id=None, name=None, title=None, campaign_id=None, status=None, target=None, progress=None, start_date=None, completion_date=None, end_date=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, achievement_id=None, name=None, title=None, description=None, campaign_id=None, status=None, target=None, progress=None, start_date=None, completion_date=None, end_date=None, local_vars_configuration=None): # noqa: E501 """AchievementProgress - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -67,6 +69,7 @@ def __init__(self, achievement_id=None, name=None, title=None, campaign_id=None, self._achievement_id = None self._name = None self._title = None + self._description = None self._campaign_id = None self._status = None self._target = None @@ -79,6 +82,7 @@ def __init__(self, achievement_id=None, name=None, title=None, campaign_id=None, self.achievement_id = achievement_id self.name = name self.title = title + self.description = description self.campaign_id = campaign_id self.status = status if target is not None: @@ -173,6 +177,31 @@ def title(self, title): self._title = title + @property + def description(self): + """Gets the description of this AchievementProgress. # noqa: E501 + + The description of the achievement in the Campaign Manager. # noqa: E501 + + :return: The description of this AchievementProgress. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this AchievementProgress. + + The description of the achievement in the Campaign Manager. # noqa: E501 + + :param description: The description of this AchievementProgress. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and description is None: # noqa: E501 + raise ValueError("Invalid value for `description`, must not be `None`") # noqa: E501 + + self._description = description + @property def campaign_id(self): """Gets the campaign_id of this AchievementProgress. # noqa: E501 diff --git a/talon_one/models/add_loyalty_points_effect_props.py b/talon_one/models/add_loyalty_points_effect_props.py index b9e69a7..dfe71e2 100644 --- a/talon_one/models/add_loyalty_points_effect_props.py +++ b/talon_one/models/add_loyalty_points_effect_props.py @@ -402,6 +402,9 @@ def card_identifier(self, card_identifier): if (self.local_vars_configuration.client_side_validation and card_identifier is not None and len(card_identifier) > 108): raise ValueError("Invalid value for `card_identifier`, length must be less than or equal to `108`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + card_identifier is not None and not re.search(r'^[A-Za-z0-9_-]*$', card_identifier)): # noqa: E501 + raise ValueError(r"Invalid value for `card_identifier`, must be a follow pattern or equal to `/^[A-Za-z0-9_-]*$/`") # noqa: E501 self._card_identifier = card_identifier diff --git a/talon_one/models/additional_campaign_properties.py b/talon_one/models/additional_campaign_properties.py index 85ed7c2..69b8183 100644 --- a/talon_one/models/additional_campaign_properties.py +++ b/talon_one/models/additional_campaign_properties.py @@ -648,7 +648,7 @@ def template_id(self, template_id): def frontend_state(self): """Gets the frontend_state of this AdditionalCampaignProperties. # noqa: E501 - A campaign state described exactly as in the Campaign Manager. # noqa: E501 + The campaign state displayed in the Campaign Manager. # noqa: E501 :return: The frontend_state of this AdditionalCampaignProperties. # noqa: E501 :rtype: str @@ -659,14 +659,14 @@ def frontend_state(self): def frontend_state(self, frontend_state): """Sets the frontend_state of this AdditionalCampaignProperties. - A campaign state described exactly as in the Campaign Manager. # noqa: E501 + The campaign state displayed in the Campaign Manager. # noqa: E501 :param frontend_state: The frontend_state of this AdditionalCampaignProperties. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and frontend_state is None: # noqa: E501 raise ValueError("Invalid value for `frontend_state`, must not be `None`") # noqa: E501 - allowed_values = ["expired", "scheduled", "running", "disabled", "archived"] # noqa: E501 + allowed_values = ["expired", "scheduled", "running", "disabled", "archived", "staged"] # noqa: E501 if self.local_vars_configuration.client_side_validation and frontend_state not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `frontend_state` ({0}), must be one of {1}" # noqa: E501 diff --git a/talon_one/models/analytics_product.py b/talon_one/models/analytics_product.py new file mode 100644 index 0000000..cbecdb8 --- /dev/null +++ b/talon_one/models/analytics_product.py @@ -0,0 +1,209 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class AnalyticsProduct(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'id': 'int', + 'is_preliminary': 'bool', + 'name': 'str', + 'catalog_id': 'int' + } + + attribute_map = { + 'id': 'id', + 'is_preliminary': 'isPreliminary', + 'name': 'name', + 'catalog_id': 'catalogId' + } + + def __init__(self, id=None, is_preliminary=None, name=None, catalog_id=None, local_vars_configuration=None): # noqa: E501 + """AnalyticsProduct - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._id = None + self._is_preliminary = None + self._name = None + self._catalog_id = None + self.discriminator = None + + self.id = id + self.is_preliminary = is_preliminary + self.name = name + if catalog_id is not None: + self.catalog_id = catalog_id + + @property + def id(self): + """Gets the id of this AnalyticsProduct. # noqa: E501 + + The ID of the analytics-level product. # noqa: E501 + + :return: The id of this AnalyticsProduct. # noqa: E501 + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this AnalyticsProduct. + + The ID of the analytics-level product. # noqa: E501 + + :param id: The id of this AnalyticsProduct. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501 + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + @property + def is_preliminary(self): + """Gets the is_preliminary of this AnalyticsProduct. # noqa: E501 + + Indicates whether the analytics-level product is connected to a catalog and also has a product name. # noqa: E501 + + :return: The is_preliminary of this AnalyticsProduct. # noqa: E501 + :rtype: bool + """ + return self._is_preliminary + + @is_preliminary.setter + def is_preliminary(self, is_preliminary): + """Sets the is_preliminary of this AnalyticsProduct. + + Indicates whether the analytics-level product is connected to a catalog and also has a product name. # noqa: E501 + + :param is_preliminary: The is_preliminary of this AnalyticsProduct. # noqa: E501 + :type: bool + """ + if self.local_vars_configuration.client_side_validation and is_preliminary is None: # noqa: E501 + raise ValueError("Invalid value for `is_preliminary`, must not be `None`") # noqa: E501 + + self._is_preliminary = is_preliminary + + @property + def name(self): + """Gets the name of this AnalyticsProduct. # noqa: E501 + + The name of the analytics-level product. # noqa: E501 + + :return: The name of this AnalyticsProduct. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this AnalyticsProduct. + + The name of the analytics-level product. # noqa: E501 + + :param name: The name of this AnalyticsProduct. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and name is None: # noqa: E501 + raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501 + + self._name = name + + @property + def catalog_id(self): + """Gets the catalog_id of this AnalyticsProduct. # noqa: E501 + + The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. # noqa: E501 + + :return: The catalog_id of this AnalyticsProduct. # noqa: E501 + :rtype: int + """ + return self._catalog_id + + @catalog_id.setter + def catalog_id(self, catalog_id): + """Sets the catalog_id of this AnalyticsProduct. + + The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. # noqa: E501 + + :param catalog_id: The catalog_id of this AnalyticsProduct. # noqa: E501 + :type: int + """ + + self._catalog_id = catalog_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AnalyticsProduct): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, AnalyticsProduct): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/analytics_product_sku.py b/talon_one/models/analytics_product_sku.py new file mode 100644 index 0000000..1ab6384 --- /dev/null +++ b/talon_one/models/analytics_product_sku.py @@ -0,0 +1,181 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class AnalyticsProductSKU(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'id': 'int', + 'sku': 'str', + 'last_updated': 'datetime' + } + + attribute_map = { + 'id': 'id', + 'sku': 'sku', + 'last_updated': 'lastUpdated' + } + + def __init__(self, id=None, sku=None, last_updated=None, local_vars_configuration=None): # noqa: E501 + """AnalyticsProductSKU - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._id = None + self._sku = None + self._last_updated = None + self.discriminator = None + + self.id = id + self.sku = sku + self.last_updated = last_updated + + @property + def id(self): + """Gets the id of this AnalyticsProductSKU. # noqa: E501 + + The ID of the SKU linked to the analytics-level product. # noqa: E501 + + :return: The id of this AnalyticsProductSKU. # noqa: E501 + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this AnalyticsProductSKU. + + The ID of the SKU linked to the analytics-level product. # noqa: E501 + + :param id: The id of this AnalyticsProductSKU. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501 + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + @property + def sku(self): + """Gets the sku of this AnalyticsProductSKU. # noqa: E501 + + The SKU linked to the analytics-level product. # noqa: E501 + + :return: The sku of this AnalyticsProductSKU. # noqa: E501 + :rtype: str + """ + return self._sku + + @sku.setter + def sku(self, sku): + """Sets the sku of this AnalyticsProductSKU. + + The SKU linked to the analytics-level product. # noqa: E501 + + :param sku: The sku of this AnalyticsProductSKU. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and sku is None: # noqa: E501 + raise ValueError("Invalid value for `sku`, must not be `None`") # noqa: E501 + + self._sku = sku + + @property + def last_updated(self): + """Gets the last_updated of this AnalyticsProductSKU. # noqa: E501 + + Values in UTC for the date the SKU linked to the analytics-level product was last updated. # noqa: E501 + + :return: The last_updated of this AnalyticsProductSKU. # noqa: E501 + :rtype: datetime + """ + return self._last_updated + + @last_updated.setter + def last_updated(self, last_updated): + """Sets the last_updated of this AnalyticsProductSKU. + + Values in UTC for the date the SKU linked to the analytics-level product was last updated. # noqa: E501 + + :param last_updated: The last_updated of this AnalyticsProductSKU. # noqa: E501 + :type: datetime + """ + if self.local_vars_configuration.client_side_validation and last_updated is None: # noqa: E501 + raise ValueError("Invalid value for `last_updated`, must not be `None`") # noqa: E501 + + self._last_updated = last_updated + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AnalyticsProductSKU): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, AnalyticsProductSKU): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/application.py b/talon_one/models/application.py index 4a254cc..c9f8aad 100644 --- a/talon_one/models/application.py +++ b/talon_one/models/application.py @@ -52,6 +52,7 @@ class Application(object): 'enable_partial_discounts': 'bool', 'default_discount_additional_cost_per_item_scope': 'str', 'default_evaluation_group_id': 'int', + 'default_cart_item_filter_id': 'int', 'enable_campaign_state_management': 'bool', 'loyalty_programs': 'list[LoyaltyProgram]' } @@ -76,11 +77,12 @@ class Application(object): 'enable_partial_discounts': 'enablePartialDiscounts', 'default_discount_additional_cost_per_item_scope': 'defaultDiscountAdditionalCostPerItemScope', 'default_evaluation_group_id': 'defaultEvaluationGroupId', + 'default_cart_item_filter_id': 'defaultCartItemFilterId', 'enable_campaign_state_management': 'enableCampaignStateManagement', 'loyalty_programs': 'loyaltyPrograms' } - def __init__(self, id=None, created=None, modified=None, account_id=None, name=None, description=None, timezone=None, currency=None, case_sensitivity=None, attributes=None, limits=None, default_discount_scope=None, enable_cascading_discounts=None, enable_flattened_cart_items=None, attributes_settings=None, sandbox=None, enable_partial_discounts=None, default_discount_additional_cost_per_item_scope=None, default_evaluation_group_id=None, enable_campaign_state_management=None, loyalty_programs=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, id=None, created=None, modified=None, account_id=None, name=None, description=None, timezone=None, currency=None, case_sensitivity=None, attributes=None, limits=None, default_discount_scope=None, enable_cascading_discounts=None, enable_flattened_cart_items=None, attributes_settings=None, sandbox=None, enable_partial_discounts=None, default_discount_additional_cost_per_item_scope=None, default_evaluation_group_id=None, default_cart_item_filter_id=None, enable_campaign_state_management=None, loyalty_programs=None, local_vars_configuration=None): # noqa: E501 """Application - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -105,6 +107,7 @@ def __init__(self, id=None, created=None, modified=None, account_id=None, name=N self._enable_partial_discounts = None self._default_discount_additional_cost_per_item_scope = None self._default_evaluation_group_id = None + self._default_cart_item_filter_id = None self._enable_campaign_state_management = None self._loyalty_programs = None self.discriminator = None @@ -140,6 +143,8 @@ def __init__(self, id=None, created=None, modified=None, account_id=None, name=N self.default_discount_additional_cost_per_item_scope = default_discount_additional_cost_per_item_scope if default_evaluation_group_id is not None: self.default_evaluation_group_id = default_evaluation_group_id + if default_cart_item_filter_id is not None: + self.default_cart_item_filter_id = default_cart_item_filter_id if enable_campaign_state_management is not None: self.enable_campaign_state_management = enable_campaign_state_management self.loyalty_programs = loyalty_programs @@ -620,6 +625,29 @@ def default_evaluation_group_id(self, default_evaluation_group_id): self._default_evaluation_group_id = default_evaluation_group_id + @property + def default_cart_item_filter_id(self): + """Gets the default_cart_item_filter_id of this Application. # noqa: E501 + + The ID of the default Cart-Item-Filter for this application. # noqa: E501 + + :return: The default_cart_item_filter_id of this Application. # noqa: E501 + :rtype: int + """ + return self._default_cart_item_filter_id + + @default_cart_item_filter_id.setter + def default_cart_item_filter_id(self, default_cart_item_filter_id): + """Sets the default_cart_item_filter_id of this Application. + + The ID of the default Cart-Item-Filter for this application. # noqa: E501 + + :param default_cart_item_filter_id: The default_cart_item_filter_id of this Application. # noqa: E501 + :type: int + """ + + self._default_cart_item_filter_id = default_cart_item_filter_id + @property def enable_campaign_state_management(self): """Gets the enable_campaign_state_management of this Application. # noqa: E501 diff --git a/talon_one/models/application_campaign_analytics.py b/talon_one/models/application_campaign_analytics.py index 2aef825..006a02d 100644 --- a/talon_one/models/application_campaign_analytics.py +++ b/talon_one/models/application_campaign_analytics.py @@ -248,7 +248,7 @@ def campaign_state(self, campaign_state): """ if self.local_vars_configuration.client_side_validation and campaign_state is None: # noqa: E501 raise ValueError("Invalid value for `campaign_state`, must not be `None`") # noqa: E501 - allowed_values = ["expired", "scheduled", "running", "disabled", "archived"] # noqa: E501 + allowed_values = ["expired", "scheduled", "running", "disabled", "archived", "staged"] # noqa: E501 if self.local_vars_configuration.client_side_validation and campaign_state not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `campaign_state` ({0}), must be one of {1}" # noqa: E501 diff --git a/talon_one/models/application_campaign_stats.py b/talon_one/models/application_campaign_stats.py index 7088501..0774d14 100644 --- a/talon_one/models/application_campaign_stats.py +++ b/talon_one/models/application_campaign_stats.py @@ -34,6 +34,7 @@ class ApplicationCampaignStats(object): """ openapi_types = { 'disabled': 'int', + 'staged': 'int', 'scheduled': 'int', 'running': 'int', 'expired': 'int', @@ -42,19 +43,21 @@ class ApplicationCampaignStats(object): attribute_map = { 'disabled': 'disabled', + 'staged': 'staged', 'scheduled': 'scheduled', 'running': 'running', 'expired': 'expired', 'archived': 'archived' } - def __init__(self, disabled=None, scheduled=None, running=None, expired=None, archived=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, disabled=None, staged=None, scheduled=None, running=None, expired=None, archived=None, local_vars_configuration=None): # noqa: E501 """ApplicationCampaignStats - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration self._disabled = None + self._staged = None self._scheduled = None self._running = None self._expired = None @@ -62,6 +65,7 @@ def __init__(self, disabled=None, scheduled=None, running=None, expired=None, ar self.discriminator = None self.disabled = disabled + self.staged = staged self.scheduled = scheduled self.running = running self.expired = expired @@ -92,6 +96,31 @@ def disabled(self, disabled): self._disabled = disabled + @property + def staged(self): + """Gets the staged of this ApplicationCampaignStats. # noqa: E501 + + Number of staged campaigns. # noqa: E501 + + :return: The staged of this ApplicationCampaignStats. # noqa: E501 + :rtype: int + """ + return self._staged + + @staged.setter + def staged(self, staged): + """Sets the staged of this ApplicationCampaignStats. + + Number of staged campaigns. # noqa: E501 + + :param staged: The staged of this ApplicationCampaignStats. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and staged is None: # noqa: E501 + raise ValueError("Invalid value for `staged`, must not be `None`") # noqa: E501 + + self._staged = staged + @property def scheduled(self): """Gets the scheduled of this ApplicationCampaignStats. # noqa: E501 diff --git a/talon_one/models/application_cif.py b/talon_one/models/application_cif.py new file mode 100644 index 0000000..c4961f1 --- /dev/null +++ b/talon_one/models/application_cif.py @@ -0,0 +1,350 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ApplicationCIF(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'id': 'int', + 'created': 'datetime', + 'name': 'str', + 'description': 'str', + 'active_expression_id': 'int', + 'modified_by': 'int', + 'created_by': 'int', + 'modified': 'datetime', + 'application_id': 'int' + } + + attribute_map = { + 'id': 'id', + 'created': 'created', + 'name': 'name', + 'description': 'description', + 'active_expression_id': 'activeExpressionId', + 'modified_by': 'modifiedBy', + 'created_by': 'createdBy', + 'modified': 'modified', + 'application_id': 'applicationId' + } + + def __init__(self, id=None, created=None, name=None, description=None, active_expression_id=None, modified_by=None, created_by=None, modified=None, application_id=None, local_vars_configuration=None): # noqa: E501 + """ApplicationCIF - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._id = None + self._created = None + self._name = None + self._description = None + self._active_expression_id = None + self._modified_by = None + self._created_by = None + self._modified = None + self._application_id = None + self.discriminator = None + + self.id = id + self.created = created + self.name = name + if description is not None: + self.description = description + if active_expression_id is not None: + self.active_expression_id = active_expression_id + if modified_by is not None: + self.modified_by = modified_by + if created_by is not None: + self.created_by = created_by + if modified is not None: + self.modified = modified + self.application_id = application_id + + @property + def id(self): + """Gets the id of this ApplicationCIF. # noqa: E501 + + Internal ID of this entity. # noqa: E501 + + :return: The id of this ApplicationCIF. # noqa: E501 + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this ApplicationCIF. + + Internal ID of this entity. # noqa: E501 + + :param id: The id of this ApplicationCIF. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501 + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + @property + def created(self): + """Gets the created of this ApplicationCIF. # noqa: E501 + + The time this entity was created. # noqa: E501 + + :return: The created of this ApplicationCIF. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this ApplicationCIF. + + The time this entity was created. # noqa: E501 + + :param created: The created of this ApplicationCIF. # noqa: E501 + :type: datetime + """ + if self.local_vars_configuration.client_side_validation and created is None: # noqa: E501 + raise ValueError("Invalid value for `created`, must not be `None`") # noqa: E501 + + self._created = created + + @property + def name(self): + """Gets the name of this ApplicationCIF. # noqa: E501 + + The name of the Application cart item filter used in API requests. # noqa: E501 + + :return: The name of this ApplicationCIF. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this ApplicationCIF. + + The name of the Application cart item filter used in API requests. # noqa: E501 + + :param name: The name of this ApplicationCIF. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and name is None: # noqa: E501 + raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501 + + self._name = name + + @property + def description(self): + """Gets the description of this ApplicationCIF. # noqa: E501 + + A short description of the Application cart item filter. # noqa: E501 + + :return: The description of this ApplicationCIF. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this ApplicationCIF. + + A short description of the Application cart item filter. # noqa: E501 + + :param description: The description of this ApplicationCIF. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def active_expression_id(self): + """Gets the active_expression_id of this ApplicationCIF. # noqa: E501 + + The ID of the expression that the Application cart item filter uses. # noqa: E501 + + :return: The active_expression_id of this ApplicationCIF. # noqa: E501 + :rtype: int + """ + return self._active_expression_id + + @active_expression_id.setter + def active_expression_id(self, active_expression_id): + """Sets the active_expression_id of this ApplicationCIF. + + The ID of the expression that the Application cart item filter uses. # noqa: E501 + + :param active_expression_id: The active_expression_id of this ApplicationCIF. # noqa: E501 + :type: int + """ + + self._active_expression_id = active_expression_id + + @property + def modified_by(self): + """Gets the modified_by of this ApplicationCIF. # noqa: E501 + + The ID of the user who last updated the Application cart item filter. # noqa: E501 + + :return: The modified_by of this ApplicationCIF. # noqa: E501 + :rtype: int + """ + return self._modified_by + + @modified_by.setter + def modified_by(self, modified_by): + """Sets the modified_by of this ApplicationCIF. + + The ID of the user who last updated the Application cart item filter. # noqa: E501 + + :param modified_by: The modified_by of this ApplicationCIF. # noqa: E501 + :type: int + """ + + self._modified_by = modified_by + + @property + def created_by(self): + """Gets the created_by of this ApplicationCIF. # noqa: E501 + + The ID of the user who created the Application cart item filter. # noqa: E501 + + :return: The created_by of this ApplicationCIF. # noqa: E501 + :rtype: int + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """Sets the created_by of this ApplicationCIF. + + The ID of the user who created the Application cart item filter. # noqa: E501 + + :param created_by: The created_by of this ApplicationCIF. # noqa: E501 + :type: int + """ + + self._created_by = created_by + + @property + def modified(self): + """Gets the modified of this ApplicationCIF. # noqa: E501 + + Timestamp of the most recent update to the Application cart item filter. # noqa: E501 + + :return: The modified of this ApplicationCIF. # noqa: E501 + :rtype: datetime + """ + return self._modified + + @modified.setter + def modified(self, modified): + """Sets the modified of this ApplicationCIF. + + Timestamp of the most recent update to the Application cart item filter. # noqa: E501 + + :param modified: The modified of this ApplicationCIF. # noqa: E501 + :type: datetime + """ + + self._modified = modified + + @property + def application_id(self): + """Gets the application_id of this ApplicationCIF. # noqa: E501 + + The ID of the application that owns this entity. # noqa: E501 + + :return: The application_id of this ApplicationCIF. # noqa: E501 + :rtype: int + """ + return self._application_id + + @application_id.setter + def application_id(self, application_id): + """Sets the application_id of this ApplicationCIF. + + The ID of the application that owns this entity. # noqa: E501 + + :param application_id: The application_id of this ApplicationCIF. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and application_id is None: # noqa: E501 + raise ValueError("Invalid value for `application_id`, must not be `None`") # noqa: E501 + + self._application_id = application_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ApplicationCIF): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ApplicationCIF): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/application_cif_expression.py b/talon_one/models/application_cif_expression.py new file mode 100644 index 0000000..2b4b8d8 --- /dev/null +++ b/talon_one/models/application_cif_expression.py @@ -0,0 +1,265 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ApplicationCIFExpression(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'id': 'int', + 'created': 'datetime', + 'cart_item_filter_id': 'int', + 'created_by': 'int', + 'expression': 'list[object]', + 'application_id': 'int' + } + + attribute_map = { + 'id': 'id', + 'created': 'created', + 'cart_item_filter_id': 'cartItemFilterId', + 'created_by': 'createdBy', + 'expression': 'expression', + 'application_id': 'applicationId' + } + + def __init__(self, id=None, created=None, cart_item_filter_id=None, created_by=None, expression=None, application_id=None, local_vars_configuration=None): # noqa: E501 + """ApplicationCIFExpression - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._id = None + self._created = None + self._cart_item_filter_id = None + self._created_by = None + self._expression = None + self._application_id = None + self.discriminator = None + + self.id = id + self.created = created + if cart_item_filter_id is not None: + self.cart_item_filter_id = cart_item_filter_id + if created_by is not None: + self.created_by = created_by + if expression is not None: + self.expression = expression + self.application_id = application_id + + @property + def id(self): + """Gets the id of this ApplicationCIFExpression. # noqa: E501 + + Internal ID of this entity. # noqa: E501 + + :return: The id of this ApplicationCIFExpression. # noqa: E501 + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this ApplicationCIFExpression. + + Internal ID of this entity. # noqa: E501 + + :param id: The id of this ApplicationCIFExpression. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501 + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + @property + def created(self): + """Gets the created of this ApplicationCIFExpression. # noqa: E501 + + The time this entity was created. # noqa: E501 + + :return: The created of this ApplicationCIFExpression. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this ApplicationCIFExpression. + + The time this entity was created. # noqa: E501 + + :param created: The created of this ApplicationCIFExpression. # noqa: E501 + :type: datetime + """ + if self.local_vars_configuration.client_side_validation and created is None: # noqa: E501 + raise ValueError("Invalid value for `created`, must not be `None`") # noqa: E501 + + self._created = created + + @property + def cart_item_filter_id(self): + """Gets the cart_item_filter_id of this ApplicationCIFExpression. # noqa: E501 + + The ID of the Application cart item filter. # noqa: E501 + + :return: The cart_item_filter_id of this ApplicationCIFExpression. # noqa: E501 + :rtype: int + """ + return self._cart_item_filter_id + + @cart_item_filter_id.setter + def cart_item_filter_id(self, cart_item_filter_id): + """Sets the cart_item_filter_id of this ApplicationCIFExpression. + + The ID of the Application cart item filter. # noqa: E501 + + :param cart_item_filter_id: The cart_item_filter_id of this ApplicationCIFExpression. # noqa: E501 + :type: int + """ + + self._cart_item_filter_id = cart_item_filter_id + + @property + def created_by(self): + """Gets the created_by of this ApplicationCIFExpression. # noqa: E501 + + The ID of the user who created the Application cart item filter. # noqa: E501 + + :return: The created_by of this ApplicationCIFExpression. # noqa: E501 + :rtype: int + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """Sets the created_by of this ApplicationCIFExpression. + + The ID of the user who created the Application cart item filter. # noqa: E501 + + :param created_by: The created_by of this ApplicationCIFExpression. # noqa: E501 + :type: int + """ + + self._created_by = created_by + + @property + def expression(self): + """Gets the expression of this ApplicationCIFExpression. # noqa: E501 + + Arbitrary additional JSON data associated with the Application cart item filter. # noqa: E501 + + :return: The expression of this ApplicationCIFExpression. # noqa: E501 + :rtype: list[object] + """ + return self._expression + + @expression.setter + def expression(self, expression): + """Sets the expression of this ApplicationCIFExpression. + + Arbitrary additional JSON data associated with the Application cart item filter. # noqa: E501 + + :param expression: The expression of this ApplicationCIFExpression. # noqa: E501 + :type: list[object] + """ + + self._expression = expression + + @property + def application_id(self): + """Gets the application_id of this ApplicationCIFExpression. # noqa: E501 + + The ID of the application that owns this entity. # noqa: E501 + + :return: The application_id of this ApplicationCIFExpression. # noqa: E501 + :rtype: int + """ + return self._application_id + + @application_id.setter + def application_id(self, application_id): + """Sets the application_id of this ApplicationCIFExpression. + + The ID of the application that owns this entity. # noqa: E501 + + :param application_id: The application_id of this ApplicationCIFExpression. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and application_id is None: # noqa: E501 + raise ValueError("Invalid value for `application_id`, must not be `None`") # noqa: E501 + + self._application_id = application_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ApplicationCIFExpression): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ApplicationCIFExpression): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/application_customer.py b/talon_one/models/application_customer.py index 0966e80..d916950 100644 --- a/talon_one/models/application_customer.py +++ b/talon_one/models/application_customer.py @@ -103,7 +103,7 @@ def __init__(self, id=None, created=None, integration_id=None, attributes=None, def id(self): """Gets the id of this ApplicationCustomer. # noqa: E501 - Internal ID of this entity. Internal ID of this entity. # noqa: E501 + Internal ID of this entity. # noqa: E501 :return: The id of this ApplicationCustomer. # noqa: E501 :rtype: int @@ -114,7 +114,7 @@ def id(self): def id(self, id): """Sets the id of this ApplicationCustomer. - Internal ID of this entity. Internal ID of this entity. # noqa: E501 + Internal ID of this entity. # noqa: E501 :param id: The id of this ApplicationCustomer. # noqa: E501 :type: int @@ -128,7 +128,7 @@ def id(self, id): def created(self): """Gets the created of this ApplicationCustomer. # noqa: E501 - The time this entity was created. The time this entity was created. The time this entity was created. The time this entity was created. # noqa: E501 + The time this entity was created. # noqa: E501 :return: The created of this ApplicationCustomer. # noqa: E501 :rtype: datetime @@ -139,7 +139,7 @@ def created(self): def created(self, created): """Sets the created of this ApplicationCustomer. - The time this entity was created. The time this entity was created. The time this entity was created. The time this entity was created. # noqa: E501 + The time this entity was created. # noqa: E501 :param created: The created of this ApplicationCustomer. # noqa: E501 :type: datetime @@ -153,7 +153,7 @@ def created(self, created): def integration_id(self): """Gets the integration_id of this ApplicationCustomer. # noqa: E501 - The integration ID set by your integration layer. The integration ID set by your integration layer. # noqa: E501 + The integration ID set by your integration layer. # noqa: E501 :return: The integration_id of this ApplicationCustomer. # noqa: E501 :rtype: str @@ -164,7 +164,7 @@ def integration_id(self): def integration_id(self, integration_id): """Sets the integration_id of this ApplicationCustomer. - The integration ID set by your integration layer. The integration ID set by your integration layer. # noqa: E501 + The integration ID set by your integration layer. # noqa: E501 :param integration_id: The integration_id of this ApplicationCustomer. # noqa: E501 :type: str @@ -206,7 +206,7 @@ def attributes(self, attributes): def account_id(self): """Gets the account_id of this ApplicationCustomer. # noqa: E501 - The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. # noqa: E501 + The ID of the Talon.One account that owns this profile. # noqa: E501 :return: The account_id of this ApplicationCustomer. # noqa: E501 :rtype: int @@ -217,7 +217,7 @@ def account_id(self): def account_id(self, account_id): """Sets the account_id of this ApplicationCustomer. - The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. # noqa: E501 + The ID of the Talon.One account that owns this profile. # noqa: E501 :param account_id: The account_id of this ApplicationCustomer. # noqa: E501 :type: int diff --git a/talon_one/models/application_session.py b/talon_one/models/application_session.py index 7719a03..84a5eb7 100644 --- a/talon_one/models/application_session.py +++ b/talon_one/models/application_session.py @@ -140,7 +140,7 @@ def id(self, id): def created(self): """Gets the created of this ApplicationSession. # noqa: E501 - The time this entity was created. The time this entity was created. # noqa: E501 + The time this entity was created. # noqa: E501 :return: The created of this ApplicationSession. # noqa: E501 :rtype: datetime @@ -151,7 +151,7 @@ def created(self): def created(self, created): """Sets the created of this ApplicationSession. - The time this entity was created. The time this entity was created. # noqa: E501 + The time this entity was created. # noqa: E501 :param created: The created of this ApplicationSession. # noqa: E501 :type: datetime diff --git a/talon_one/models/audience_customer.py b/talon_one/models/audience_customer.py index c9f34f8..d5ac93c 100644 --- a/talon_one/models/audience_customer.py +++ b/talon_one/models/audience_customer.py @@ -133,7 +133,7 @@ def id(self, id): def created(self): """Gets the created of this AudienceCustomer. # noqa: E501 - The time this entity was created. The time this entity was created. # noqa: E501 + The time this entity was created. # noqa: E501 :return: The created of this AudienceCustomer. # noqa: E501 :rtype: datetime @@ -144,7 +144,7 @@ def created(self): def created(self, created): """Sets the created of this AudienceCustomer. - The time this entity was created. The time this entity was created. # noqa: E501 + The time this entity was created. # noqa: E501 :param created: The created of this AudienceCustomer. # noqa: E501 :type: datetime diff --git a/talon_one/models/base_loyalty_program.py b/talon_one/models/base_loyalty_program.py index 777e640..619572c 100644 --- a/talon_one/models/base_loyalty_program.py +++ b/talon_one/models/base_loyalty_program.py @@ -46,7 +46,8 @@ class BaseLoyaltyProgram(object): 'tier_cycle_start_date': 'datetime', 'tiers_expire_in': 'str', 'tiers_downgrade_policy': 'str', - 'card_code_settings': 'CodeGeneratorSettings' + 'card_code_settings': 'CodeGeneratorSettings', + 'return_policy': 'str' } attribute_map = { @@ -63,10 +64,11 @@ class BaseLoyaltyProgram(object): 'tier_cycle_start_date': 'tierCycleStartDate', 'tiers_expire_in': 'tiersExpireIn', 'tiers_downgrade_policy': 'tiersDowngradePolicy', - 'card_code_settings': 'cardCodeSettings' + 'card_code_settings': 'cardCodeSettings', + 'return_policy': 'returnPolicy' } - def __init__(self, title=None, description=None, subscribed_applications=None, default_validity=None, default_pending=None, allow_subledger=None, users_per_card_limit=None, sandbox=None, program_join_policy=None, tiers_expiration_policy=None, tier_cycle_start_date=None, tiers_expire_in=None, tiers_downgrade_policy=None, card_code_settings=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, title=None, description=None, subscribed_applications=None, default_validity=None, default_pending=None, allow_subledger=None, users_per_card_limit=None, sandbox=None, program_join_policy=None, tiers_expiration_policy=None, tier_cycle_start_date=None, tiers_expire_in=None, tiers_downgrade_policy=None, card_code_settings=None, return_policy=None, local_vars_configuration=None): # noqa: E501 """BaseLoyaltyProgram - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -86,6 +88,7 @@ def __init__(self, title=None, description=None, subscribed_applications=None, d self._tiers_expire_in = None self._tiers_downgrade_policy = None self._card_code_settings = None + self._return_policy = None self.discriminator = None if title is not None: @@ -116,6 +119,8 @@ def __init__(self, title=None, description=None, subscribed_applications=None, d self.tiers_downgrade_policy = tiers_downgrade_policy if card_code_settings is not None: self.card_code_settings = card_code_settings + if return_policy is not None: + self.return_policy = return_policy @property def title(self): @@ -458,6 +463,35 @@ def card_code_settings(self, card_code_settings): self._card_code_settings = card_code_settings + @property + def return_policy(self): + """Gets the return_policy of this BaseLoyaltyProgram. # noqa: E501 + + The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. # noqa: E501 + + :return: The return_policy of this BaseLoyaltyProgram. # noqa: E501 + :rtype: str + """ + return self._return_policy + + @return_policy.setter + def return_policy(self, return_policy): + """Sets the return_policy of this BaseLoyaltyProgram. + + The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. # noqa: E501 + + :param return_policy: The return_policy of this BaseLoyaltyProgram. # noqa: E501 + :type: str + """ + allowed_values = ["only_pending", "within_balance"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and return_policy not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `return_policy` ({0}), must be one of {1}" # noqa: E501 + .format(return_policy, allowed_values) + ) + + self._return_policy = return_policy + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/bulk_operation_on_campaigns.py b/talon_one/models/bulk_operation_on_campaigns.py index 3995451..8275b55 100644 --- a/talon_one/models/bulk_operation_on_campaigns.py +++ b/talon_one/models/bulk_operation_on_campaigns.py @@ -34,15 +34,17 @@ class BulkOperationOnCampaigns(object): """ openapi_types = { 'operation': 'str', - 'campaign_ids': 'list[int]' + 'campaign_ids': 'list[int]', + 'activate_at': 'datetime' } attribute_map = { 'operation': 'operation', - 'campaign_ids': 'campaignIds' + 'campaign_ids': 'campaignIds', + 'activate_at': 'activateAt' } - def __init__(self, operation=None, campaign_ids=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, operation=None, campaign_ids=None, activate_at=None, local_vars_configuration=None): # noqa: E501 """BulkOperationOnCampaigns - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -50,10 +52,13 @@ def __init__(self, operation=None, campaign_ids=None, local_vars_configuration=N self._operation = None self._campaign_ids = None + self._activate_at = None self.discriminator = None self.operation = operation self.campaign_ids = campaign_ids + if activate_at is not None: + self.activate_at = activate_at @property def operation(self): @@ -77,7 +82,7 @@ def operation(self, operation): """ if self.local_vars_configuration.client_side_validation and operation is None: # noqa: E501 raise ValueError("Invalid value for `operation`, must not be `None`") # noqa: E501 - allowed_values = ["disable", "delete"] # noqa: E501 + allowed_values = ["disable", "delete", "activate_revision"] # noqa: E501 if self.local_vars_configuration.client_side_validation and operation not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `operation` ({0}), must be one of {1}" # noqa: E501 @@ -111,6 +116,29 @@ def campaign_ids(self, campaign_ids): self._campaign_ids = campaign_ids + @property + def activate_at(self): + """Gets the activate_at of this BulkOperationOnCampaigns. # noqa: E501 + + Timestamp when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :return: The activate_at of this BulkOperationOnCampaigns. # noqa: E501 + :rtype: datetime + """ + return self._activate_at + + @activate_at.setter + def activate_at(self, activate_at): + """Sets the activate_at of this BulkOperationOnCampaigns. + + Timestamp when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :param activate_at: The activate_at of this BulkOperationOnCampaigns. # noqa: E501 + :type: datetime + """ + + self._activate_at = activate_at + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/campaign.py b/talon_one/models/campaign.py index 40a61ec..c477eab 100644 --- a/talon_one/models/campaign.py +++ b/talon_one/models/campaign.py @@ -74,7 +74,14 @@ class Campaign(object): 'updated_by': 'str', 'template_id': 'int', 'frontend_state': 'str', - 'stores_imported': 'bool' + 'stores_imported': 'bool', + 'revision_frontend_state': 'str', + 'active_revision_id': 'int', + 'active_revision_version_id': 'int', + 'version': 'int', + 'current_revision_id': 'int', + 'current_revision_version_id': 'int', + 'stage_revision': 'bool' } attribute_map = { @@ -119,10 +126,17 @@ class Campaign(object): 'updated_by': 'updatedBy', 'template_id': 'templateId', 'frontend_state': 'frontendState', - 'stores_imported': 'storesImported' + 'stores_imported': 'storesImported', + 'revision_frontend_state': 'revisionFrontendState', + 'active_revision_id': 'activeRevisionId', + 'active_revision_version_id': 'activeRevisionVersionId', + 'version': 'version', + 'current_revision_id': 'currentRevisionId', + 'current_revision_version_id': 'currentRevisionVersionId', + 'stage_revision': 'stageRevision' } - def __init__(self, id=None, created=None, application_id=None, user_id=None, name=None, description=None, start_time=None, end_time=None, attributes=None, state='enabled', active_ruleset_id=None, tags=None, features=None, coupon_settings=None, referral_settings=None, limits=None, campaign_groups=None, type='advanced', linked_store_ids=None, budgets=None, coupon_redemption_count=None, referral_redemption_count=None, discount_count=None, discount_effect_count=None, coupon_creation_count=None, custom_effect_count=None, referral_creation_count=None, add_free_item_effect_count=None, awarded_giveaways_count=None, created_loyalty_points_count=None, created_loyalty_points_effect_count=None, redeemed_loyalty_points_count=None, redeemed_loyalty_points_effect_count=None, call_api_effect_count=None, reservecoupon_effect_count=None, last_activity=None, updated=None, created_by=None, updated_by=None, template_id=None, frontend_state=None, stores_imported=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, id=None, created=None, application_id=None, user_id=None, name=None, description=None, start_time=None, end_time=None, attributes=None, state='enabled', active_ruleset_id=None, tags=None, features=None, coupon_settings=None, referral_settings=None, limits=None, campaign_groups=None, type='advanced', linked_store_ids=None, budgets=None, coupon_redemption_count=None, referral_redemption_count=None, discount_count=None, discount_effect_count=None, coupon_creation_count=None, custom_effect_count=None, referral_creation_count=None, add_free_item_effect_count=None, awarded_giveaways_count=None, created_loyalty_points_count=None, created_loyalty_points_effect_count=None, redeemed_loyalty_points_count=None, redeemed_loyalty_points_effect_count=None, call_api_effect_count=None, reservecoupon_effect_count=None, last_activity=None, updated=None, created_by=None, updated_by=None, template_id=None, frontend_state=None, stores_imported=None, revision_frontend_state=None, active_revision_id=None, active_revision_version_id=None, version=None, current_revision_id=None, current_revision_version_id=None, stage_revision=False, local_vars_configuration=None): # noqa: E501 """Campaign - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -170,6 +184,13 @@ def __init__(self, id=None, created=None, application_id=None, user_id=None, nam self._template_id = None self._frontend_state = None self._stores_imported = None + self._revision_frontend_state = None + self._active_revision_id = None + self._active_revision_version_id = None + self._version = None + self._current_revision_id = None + self._current_revision_version_id = None + self._stage_revision = None self.discriminator = None self.id = id @@ -242,6 +263,20 @@ def __init__(self, id=None, created=None, application_id=None, user_id=None, nam self.template_id = template_id self.frontend_state = frontend_state self.stores_imported = stores_imported + if revision_frontend_state is not None: + self.revision_frontend_state = revision_frontend_state + if active_revision_id is not None: + self.active_revision_id = active_revision_id + if active_revision_version_id is not None: + self.active_revision_version_id = active_revision_version_id + if version is not None: + self.version = version + if current_revision_id is not None: + self.current_revision_id = current_revision_id + if current_revision_version_id is not None: + self.current_revision_version_id = current_revision_version_id + if stage_revision is not None: + self.stage_revision = stage_revision @property def id(self): @@ -1210,7 +1245,7 @@ def template_id(self, template_id): def frontend_state(self): """Gets the frontend_state of this Campaign. # noqa: E501 - A campaign state described exactly as in the Campaign Manager. # noqa: E501 + The campaign state displayed in the Campaign Manager. # noqa: E501 :return: The frontend_state of this Campaign. # noqa: E501 :rtype: str @@ -1221,14 +1256,14 @@ def frontend_state(self): def frontend_state(self, frontend_state): """Sets the frontend_state of this Campaign. - A campaign state described exactly as in the Campaign Manager. # noqa: E501 + The campaign state displayed in the Campaign Manager. # noqa: E501 :param frontend_state: The frontend_state of this Campaign. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and frontend_state is None: # noqa: E501 raise ValueError("Invalid value for `frontend_state`, must not be `None`") # noqa: E501 - allowed_values = ["expired", "scheduled", "running", "disabled", "archived"] # noqa: E501 + allowed_values = ["expired", "scheduled", "running", "disabled", "archived", "staged"] # noqa: E501 if self.local_vars_configuration.client_side_validation and frontend_state not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `frontend_state` ({0}), must be one of {1}" # noqa: E501 @@ -1262,6 +1297,173 @@ def stores_imported(self, stores_imported): self._stores_imported = stores_imported + @property + def revision_frontend_state(self): + """Gets the revision_frontend_state of this Campaign. # noqa: E501 + + The campaign revision state displayed in the Campaign Manager. # noqa: E501 + + :return: The revision_frontend_state of this Campaign. # noqa: E501 + :rtype: str + """ + return self._revision_frontend_state + + @revision_frontend_state.setter + def revision_frontend_state(self, revision_frontend_state): + """Sets the revision_frontend_state of this Campaign. + + The campaign revision state displayed in the Campaign Manager. # noqa: E501 + + :param revision_frontend_state: The revision_frontend_state of this Campaign. # noqa: E501 + :type: str + """ + allowed_values = ["revised", "pending"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and revision_frontend_state not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `revision_frontend_state` ({0}), must be one of {1}" # noqa: E501 + .format(revision_frontend_state, allowed_values) + ) + + self._revision_frontend_state = revision_frontend_state + + @property + def active_revision_id(self): + """Gets the active_revision_id of this Campaign. # noqa: E501 + + ID of the revision that was last activated on this campaign. # noqa: E501 + + :return: The active_revision_id of this Campaign. # noqa: E501 + :rtype: int + """ + return self._active_revision_id + + @active_revision_id.setter + def active_revision_id(self, active_revision_id): + """Sets the active_revision_id of this Campaign. + + ID of the revision that was last activated on this campaign. # noqa: E501 + + :param active_revision_id: The active_revision_id of this Campaign. # noqa: E501 + :type: int + """ + + self._active_revision_id = active_revision_id + + @property + def active_revision_version_id(self): + """Gets the active_revision_version_id of this Campaign. # noqa: E501 + + ID of the revision version that is active on the campaign. # noqa: E501 + + :return: The active_revision_version_id of this Campaign. # noqa: E501 + :rtype: int + """ + return self._active_revision_version_id + + @active_revision_version_id.setter + def active_revision_version_id(self, active_revision_version_id): + """Sets the active_revision_version_id of this Campaign. + + ID of the revision version that is active on the campaign. # noqa: E501 + + :param active_revision_version_id: The active_revision_version_id of this Campaign. # noqa: E501 + :type: int + """ + + self._active_revision_version_id = active_revision_version_id + + @property + def version(self): + """Gets the version of this Campaign. # noqa: E501 + + Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. # noqa: E501 + + :return: The version of this Campaign. # noqa: E501 + :rtype: int + """ + return self._version + + @version.setter + def version(self, version): + """Sets the version of this Campaign. + + Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. # noqa: E501 + + :param version: The version of this Campaign. # noqa: E501 + :type: int + """ + + self._version = version + + @property + def current_revision_id(self): + """Gets the current_revision_id of this Campaign. # noqa: E501 + + ID of the revision currently being modified for the campaign. # noqa: E501 + + :return: The current_revision_id of this Campaign. # noqa: E501 + :rtype: int + """ + return self._current_revision_id + + @current_revision_id.setter + def current_revision_id(self, current_revision_id): + """Sets the current_revision_id of this Campaign. + + ID of the revision currently being modified for the campaign. # noqa: E501 + + :param current_revision_id: The current_revision_id of this Campaign. # noqa: E501 + :type: int + """ + + self._current_revision_id = current_revision_id + + @property + def current_revision_version_id(self): + """Gets the current_revision_version_id of this Campaign. # noqa: E501 + + ID of the latest version applied on the current revision. # noqa: E501 + + :return: The current_revision_version_id of this Campaign. # noqa: E501 + :rtype: int + """ + return self._current_revision_version_id + + @current_revision_version_id.setter + def current_revision_version_id(self, current_revision_version_id): + """Sets the current_revision_version_id of this Campaign. + + ID of the latest version applied on the current revision. # noqa: E501 + + :param current_revision_version_id: The current_revision_version_id of this Campaign. # noqa: E501 + :type: int + """ + + self._current_revision_version_id = current_revision_version_id + + @property + def stage_revision(self): + """Gets the stage_revision of this Campaign. # noqa: E501 + + Flag for determining whether we use current revision when sending requests with staging API key. # noqa: E501 + + :return: The stage_revision of this Campaign. # noqa: E501 + :rtype: bool + """ + return self._stage_revision + + @stage_revision.setter + def stage_revision(self, stage_revision): + """Sets the stage_revision of this Campaign. + + Flag for determining whether we use current revision when sending requests with staging API key. # noqa: E501 + + :param stage_revision: The stage_revision of this Campaign. # noqa: E501 + :type: bool + """ + + self._stage_revision = stage_revision + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/campaign_store_budget.py b/talon_one/models/campaign_store_budget.py new file mode 100644 index 0000000..0639d56 --- /dev/null +++ b/talon_one/models/campaign_store_budget.py @@ -0,0 +1,239 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class CampaignStoreBudget(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'id': 'int', + 'created': 'datetime', + 'campaign_id': 'int', + 'store_id': 'int', + 'limits': 'list[LimitConfig]' + } + + attribute_map = { + 'id': 'id', + 'created': 'created', + 'campaign_id': 'campaignId', + 'store_id': 'storeId', + 'limits': 'limits' + } + + def __init__(self, id=None, created=None, campaign_id=None, store_id=None, limits=None, local_vars_configuration=None): # noqa: E501 + """CampaignStoreBudget - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._id = None + self._created = None + self._campaign_id = None + self._store_id = None + self._limits = None + self.discriminator = None + + self.id = id + self.created = created + self.campaign_id = campaign_id + self.store_id = store_id + self.limits = limits + + @property + def id(self): + """Gets the id of this CampaignStoreBudget. # noqa: E501 + + Internal ID of this entity. # noqa: E501 + + :return: The id of this CampaignStoreBudget. # noqa: E501 + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this CampaignStoreBudget. + + Internal ID of this entity. # noqa: E501 + + :param id: The id of this CampaignStoreBudget. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501 + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + @property + def created(self): + """Gets the created of this CampaignStoreBudget. # noqa: E501 + + The time this entity was created. # noqa: E501 + + :return: The created of this CampaignStoreBudget. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this CampaignStoreBudget. + + The time this entity was created. # noqa: E501 + + :param created: The created of this CampaignStoreBudget. # noqa: E501 + :type: datetime + """ + if self.local_vars_configuration.client_side_validation and created is None: # noqa: E501 + raise ValueError("Invalid value for `created`, must not be `None`") # noqa: E501 + + self._created = created + + @property + def campaign_id(self): + """Gets the campaign_id of this CampaignStoreBudget. # noqa: E501 + + The ID of the campaign that owns this entity. # noqa: E501 + + :return: The campaign_id of this CampaignStoreBudget. # noqa: E501 + :rtype: int + """ + return self._campaign_id + + @campaign_id.setter + def campaign_id(self, campaign_id): + """Sets the campaign_id of this CampaignStoreBudget. + + The ID of the campaign that owns this entity. # noqa: E501 + + :param campaign_id: The campaign_id of this CampaignStoreBudget. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and campaign_id is None: # noqa: E501 + raise ValueError("Invalid value for `campaign_id`, must not be `None`") # noqa: E501 + + self._campaign_id = campaign_id + + @property + def store_id(self): + """Gets the store_id of this CampaignStoreBudget. # noqa: E501 + + The ID of the store. # noqa: E501 + + :return: The store_id of this CampaignStoreBudget. # noqa: E501 + :rtype: int + """ + return self._store_id + + @store_id.setter + def store_id(self, store_id): + """Sets the store_id of this CampaignStoreBudget. + + The ID of the store. # noqa: E501 + + :param store_id: The store_id of this CampaignStoreBudget. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and store_id is None: # noqa: E501 + raise ValueError("Invalid value for `store_id`, must not be `None`") # noqa: E501 + + self._store_id = store_id + + @property + def limits(self): + """Gets the limits of this CampaignStoreBudget. # noqa: E501 + + The set of budget limits for stores linked to the campaign. # noqa: E501 + + :return: The limits of this CampaignStoreBudget. # noqa: E501 + :rtype: list[LimitConfig] + """ + return self._limits + + @limits.setter + def limits(self, limits): + """Sets the limits of this CampaignStoreBudget. + + The set of budget limits for stores linked to the campaign. # noqa: E501 + + :param limits: The limits of this CampaignStoreBudget. # noqa: E501 + :type: list[LimitConfig] + """ + if self.local_vars_configuration.client_side_validation and limits is None: # noqa: E501 + raise ValueError("Invalid value for `limits`, must not be `None`") # noqa: E501 + + self._limits = limits + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CampaignStoreBudget): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, CampaignStoreBudget): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/campaign_template.py b/talon_one/models/campaign_template.py index a8b211b..9b3c69e 100644 --- a/talon_one/models/campaign_template.py +++ b/talon_one/models/campaign_template.py @@ -47,6 +47,7 @@ class CampaignTemplate(object): 'tags': 'list[str]', 'features': 'list[str]', 'coupon_settings': 'CodeGeneratorSettings', + 'coupon_reservation_settings': 'CampaignTemplateCouponReservationSettings', 'referral_settings': 'CodeGeneratorSettings', 'limits': 'list[TemplateLimitConfig]', 'template_params': 'list[CampaignTemplateParams]', @@ -74,6 +75,7 @@ class CampaignTemplate(object): 'tags': 'tags', 'features': 'features', 'coupon_settings': 'couponSettings', + 'coupon_reservation_settings': 'couponReservationSettings', 'referral_settings': 'referralSettings', 'limits': 'limits', 'template_params': 'templateParams', @@ -86,7 +88,7 @@ class CampaignTemplate(object): 'valid_application_ids': 'validApplicationIds' } - def __init__(self, id=None, created=None, account_id=None, user_id=None, name=None, description=None, instructions=None, campaign_attributes=None, coupon_attributes=None, state=None, active_ruleset_id=None, tags=None, features=None, coupon_settings=None, referral_settings=None, limits=None, template_params=None, applications_ids=None, campaign_collections=None, default_campaign_group_id=None, campaign_type='advanced', updated=None, updated_by=None, valid_application_ids=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, id=None, created=None, account_id=None, user_id=None, name=None, description=None, instructions=None, campaign_attributes=None, coupon_attributes=None, state=None, active_ruleset_id=None, tags=None, features=None, coupon_settings=None, coupon_reservation_settings=None, referral_settings=None, limits=None, template_params=None, applications_ids=None, campaign_collections=None, default_campaign_group_id=None, campaign_type='advanced', updated=None, updated_by=None, valid_application_ids=None, local_vars_configuration=None): # noqa: E501 """CampaignTemplate - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -106,6 +108,7 @@ def __init__(self, id=None, created=None, account_id=None, user_id=None, name=No self._tags = None self._features = None self._coupon_settings = None + self._coupon_reservation_settings = None self._referral_settings = None self._limits = None self._template_params = None @@ -138,6 +141,8 @@ def __init__(self, id=None, created=None, account_id=None, user_id=None, name=No self.features = features if coupon_settings is not None: self.coupon_settings = coupon_settings + if coupon_reservation_settings is not None: + self.coupon_reservation_settings = coupon_reservation_settings if referral_settings is not None: self.referral_settings = referral_settings if limits is not None: @@ -509,6 +514,27 @@ def coupon_settings(self, coupon_settings): self._coupon_settings = coupon_settings + @property + def coupon_reservation_settings(self): + """Gets the coupon_reservation_settings of this CampaignTemplate. # noqa: E501 + + + :return: The coupon_reservation_settings of this CampaignTemplate. # noqa: E501 + :rtype: CampaignTemplateCouponReservationSettings + """ + return self._coupon_reservation_settings + + @coupon_reservation_settings.setter + def coupon_reservation_settings(self, coupon_reservation_settings): + """Sets the coupon_reservation_settings of this CampaignTemplate. + + + :param coupon_reservation_settings: The coupon_reservation_settings of this CampaignTemplate. # noqa: E501 + :type: CampaignTemplateCouponReservationSettings + """ + + self._coupon_reservation_settings = coupon_reservation_settings + @property def referral_settings(self): """Gets the referral_settings of this CampaignTemplate. # noqa: E501 diff --git a/talon_one/models/campaign_template_coupon_reservation_settings.py b/talon_one/models/campaign_template_coupon_reservation_settings.py new file mode 100644 index 0000000..7489b28 --- /dev/null +++ b/talon_one/models/campaign_template_coupon_reservation_settings.py @@ -0,0 +1,156 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class CampaignTemplateCouponReservationSettings(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'reservation_limit': 'int', + 'is_reservation_mandatory': 'bool' + } + + attribute_map = { + 'reservation_limit': 'reservationLimit', + 'is_reservation_mandatory': 'isReservationMandatory' + } + + def __init__(self, reservation_limit=None, is_reservation_mandatory=False, local_vars_configuration=None): # noqa: E501 + """CampaignTemplateCouponReservationSettings - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._reservation_limit = None + self._is_reservation_mandatory = None + self.discriminator = None + + if reservation_limit is not None: + self.reservation_limit = reservation_limit + if is_reservation_mandatory is not None: + self.is_reservation_mandatory = is_reservation_mandatory + + @property + def reservation_limit(self): + """Gets the reservation_limit of this CampaignTemplateCouponReservationSettings. # noqa: E501 + + The number of reservations that can be made with this coupon code. # noqa: E501 + + :return: The reservation_limit of this CampaignTemplateCouponReservationSettings. # noqa: E501 + :rtype: int + """ + return self._reservation_limit + + @reservation_limit.setter + def reservation_limit(self, reservation_limit): + """Sets the reservation_limit of this CampaignTemplateCouponReservationSettings. + + The number of reservations that can be made with this coupon code. # noqa: E501 + + :param reservation_limit: The reservation_limit of this CampaignTemplateCouponReservationSettings. # noqa: E501 + :type: int + """ + if (self.local_vars_configuration.client_side_validation and + reservation_limit is not None and reservation_limit > 999999): # noqa: E501 + raise ValueError("Invalid value for `reservation_limit`, must be a value less than or equal to `999999`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + reservation_limit is not None and reservation_limit < 0): # noqa: E501 + raise ValueError("Invalid value for `reservation_limit`, must be a value greater than or equal to `0`") # noqa: E501 + + self._reservation_limit = reservation_limit + + @property + def is_reservation_mandatory(self): + """Gets the is_reservation_mandatory of this CampaignTemplateCouponReservationSettings. # noqa: E501 + + An indication of whether the code can be redeemed only if it has been reserved first. # noqa: E501 + + :return: The is_reservation_mandatory of this CampaignTemplateCouponReservationSettings. # noqa: E501 + :rtype: bool + """ + return self._is_reservation_mandatory + + @is_reservation_mandatory.setter + def is_reservation_mandatory(self, is_reservation_mandatory): + """Sets the is_reservation_mandatory of this CampaignTemplateCouponReservationSettings. + + An indication of whether the code can be redeemed only if it has been reserved first. # noqa: E501 + + :param is_reservation_mandatory: The is_reservation_mandatory of this CampaignTemplateCouponReservationSettings. # noqa: E501 + :type: bool + """ + + self._is_reservation_mandatory = is_reservation_mandatory + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CampaignTemplateCouponReservationSettings): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, CampaignTemplateCouponReservationSettings): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/campaign_versions.py b/talon_one/models/campaign_versions.py new file mode 100644 index 0000000..dabe118 --- /dev/null +++ b/talon_one/models/campaign_versions.py @@ -0,0 +1,296 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class CampaignVersions(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'revision_frontend_state': 'str', + 'active_revision_id': 'int', + 'active_revision_version_id': 'int', + 'version': 'int', + 'current_revision_id': 'int', + 'current_revision_version_id': 'int', + 'stage_revision': 'bool' + } + + attribute_map = { + 'revision_frontend_state': 'revisionFrontendState', + 'active_revision_id': 'activeRevisionId', + 'active_revision_version_id': 'activeRevisionVersionId', + 'version': 'version', + 'current_revision_id': 'currentRevisionId', + 'current_revision_version_id': 'currentRevisionVersionId', + 'stage_revision': 'stageRevision' + } + + def __init__(self, revision_frontend_state=None, active_revision_id=None, active_revision_version_id=None, version=None, current_revision_id=None, current_revision_version_id=None, stage_revision=False, local_vars_configuration=None): # noqa: E501 + """CampaignVersions - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._revision_frontend_state = None + self._active_revision_id = None + self._active_revision_version_id = None + self._version = None + self._current_revision_id = None + self._current_revision_version_id = None + self._stage_revision = None + self.discriminator = None + + if revision_frontend_state is not None: + self.revision_frontend_state = revision_frontend_state + if active_revision_id is not None: + self.active_revision_id = active_revision_id + if active_revision_version_id is not None: + self.active_revision_version_id = active_revision_version_id + if version is not None: + self.version = version + if current_revision_id is not None: + self.current_revision_id = current_revision_id + if current_revision_version_id is not None: + self.current_revision_version_id = current_revision_version_id + if stage_revision is not None: + self.stage_revision = stage_revision + + @property + def revision_frontend_state(self): + """Gets the revision_frontend_state of this CampaignVersions. # noqa: E501 + + The campaign revision state displayed in the Campaign Manager. # noqa: E501 + + :return: The revision_frontend_state of this CampaignVersions. # noqa: E501 + :rtype: str + """ + return self._revision_frontend_state + + @revision_frontend_state.setter + def revision_frontend_state(self, revision_frontend_state): + """Sets the revision_frontend_state of this CampaignVersions. + + The campaign revision state displayed in the Campaign Manager. # noqa: E501 + + :param revision_frontend_state: The revision_frontend_state of this CampaignVersions. # noqa: E501 + :type: str + """ + allowed_values = ["revised", "pending"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and revision_frontend_state not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `revision_frontend_state` ({0}), must be one of {1}" # noqa: E501 + .format(revision_frontend_state, allowed_values) + ) + + self._revision_frontend_state = revision_frontend_state + + @property + def active_revision_id(self): + """Gets the active_revision_id of this CampaignVersions. # noqa: E501 + + ID of the revision that was last activated on this campaign. # noqa: E501 + + :return: The active_revision_id of this CampaignVersions. # noqa: E501 + :rtype: int + """ + return self._active_revision_id + + @active_revision_id.setter + def active_revision_id(self, active_revision_id): + """Sets the active_revision_id of this CampaignVersions. + + ID of the revision that was last activated on this campaign. # noqa: E501 + + :param active_revision_id: The active_revision_id of this CampaignVersions. # noqa: E501 + :type: int + """ + + self._active_revision_id = active_revision_id + + @property + def active_revision_version_id(self): + """Gets the active_revision_version_id of this CampaignVersions. # noqa: E501 + + ID of the revision version that is active on the campaign. # noqa: E501 + + :return: The active_revision_version_id of this CampaignVersions. # noqa: E501 + :rtype: int + """ + return self._active_revision_version_id + + @active_revision_version_id.setter + def active_revision_version_id(self, active_revision_version_id): + """Sets the active_revision_version_id of this CampaignVersions. + + ID of the revision version that is active on the campaign. # noqa: E501 + + :param active_revision_version_id: The active_revision_version_id of this CampaignVersions. # noqa: E501 + :type: int + """ + + self._active_revision_version_id = active_revision_version_id + + @property + def version(self): + """Gets the version of this CampaignVersions. # noqa: E501 + + Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. # noqa: E501 + + :return: The version of this CampaignVersions. # noqa: E501 + :rtype: int + """ + return self._version + + @version.setter + def version(self, version): + """Sets the version of this CampaignVersions. + + Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. # noqa: E501 + + :param version: The version of this CampaignVersions. # noqa: E501 + :type: int + """ + + self._version = version + + @property + def current_revision_id(self): + """Gets the current_revision_id of this CampaignVersions. # noqa: E501 + + ID of the revision currently being modified for the campaign. # noqa: E501 + + :return: The current_revision_id of this CampaignVersions. # noqa: E501 + :rtype: int + """ + return self._current_revision_id + + @current_revision_id.setter + def current_revision_id(self, current_revision_id): + """Sets the current_revision_id of this CampaignVersions. + + ID of the revision currently being modified for the campaign. # noqa: E501 + + :param current_revision_id: The current_revision_id of this CampaignVersions. # noqa: E501 + :type: int + """ + + self._current_revision_id = current_revision_id + + @property + def current_revision_version_id(self): + """Gets the current_revision_version_id of this CampaignVersions. # noqa: E501 + + ID of the latest version applied on the current revision. # noqa: E501 + + :return: The current_revision_version_id of this CampaignVersions. # noqa: E501 + :rtype: int + """ + return self._current_revision_version_id + + @current_revision_version_id.setter + def current_revision_version_id(self, current_revision_version_id): + """Sets the current_revision_version_id of this CampaignVersions. + + ID of the latest version applied on the current revision. # noqa: E501 + + :param current_revision_version_id: The current_revision_version_id of this CampaignVersions. # noqa: E501 + :type: int + """ + + self._current_revision_version_id = current_revision_version_id + + @property + def stage_revision(self): + """Gets the stage_revision of this CampaignVersions. # noqa: E501 + + Flag for determining whether we use current revision when sending requests with staging API key. # noqa: E501 + + :return: The stage_revision of this CampaignVersions. # noqa: E501 + :rtype: bool + """ + return self._stage_revision + + @stage_revision.setter + def stage_revision(self, stage_revision): + """Sets the stage_revision of this CampaignVersions. + + Flag for determining whether we use current revision when sending requests with staging API key. # noqa: E501 + + :param stage_revision: The stage_revision of this CampaignVersions. # noqa: E501 + :type: bool + """ + + self._stage_revision = stage_revision + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CampaignVersions): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, CampaignVersions): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/card_ledger_transaction_log_entry.py b/talon_one/models/card_ledger_transaction_log_entry.py index ce20b2a..eeb89c7 100644 --- a/talon_one/models/card_ledger_transaction_log_entry.py +++ b/talon_one/models/card_ledger_transaction_log_entry.py @@ -177,6 +177,9 @@ def card_identifier(self, card_identifier): if (self.local_vars_configuration.client_side_validation and card_identifier is not None and len(card_identifier) > 108): raise ValueError("Invalid value for `card_identifier`, length must be less than or equal to `108`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + card_identifier is not None and not re.search(r'^[A-Za-z0-9_-]*$', card_identifier)): # noqa: E501 + raise ValueError(r"Invalid value for `card_identifier`, must be a follow pattern or equal to `/^[A-Za-z0-9_-]*$/`") # noqa: E501 self._card_identifier = card_identifier diff --git a/talon_one/models/card_ledger_transaction_log_entry_integration_api.py b/talon_one/models/card_ledger_transaction_log_entry_integration_api.py index 5d7a02e..c7e37b9 100644 --- a/talon_one/models/card_ledger_transaction_log_entry_integration_api.py +++ b/talon_one/models/card_ledger_transaction_log_entry_integration_api.py @@ -177,6 +177,9 @@ def card_identifier(self, card_identifier): if (self.local_vars_configuration.client_side_validation and card_identifier is not None and len(card_identifier) > 108): raise ValueError("Invalid value for `card_identifier`, length must be less than or equal to `108`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + card_identifier is not None and not re.search(r'^[A-Za-z0-9_-]*$', card_identifier)): # noqa: E501 + raise ValueError(r"Invalid value for `card_identifier`, must be a follow pattern or equal to `/^[A-Za-z0-9_-]*$/`") # noqa: E501 self._card_identifier = card_identifier diff --git a/talon_one/models/code_generator_settings.py b/talon_one/models/code_generator_settings.py index a6a9a63..1f1350a 100644 --- a/talon_one/models/code_generator_settings.py +++ b/talon_one/models/code_generator_settings.py @@ -108,6 +108,9 @@ def coupon_pattern(self, coupon_pattern): if (self.local_vars_configuration.client_side_validation and coupon_pattern is not None and len(coupon_pattern) < 3): raise ValueError("Invalid value for `coupon_pattern`, length must be greater than or equal to `3`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + coupon_pattern is not None and not re.search(r'^[A-Za-z0-9_#-]*$', coupon_pattern)): # noqa: E501 + raise ValueError(r"Invalid value for `coupon_pattern`, must be a follow pattern or equal to `/^[A-Za-z0-9_#-]*$/`") # noqa: E501 self._coupon_pattern = coupon_pattern diff --git a/talon_one/models/coupon_deletion_filters.py b/talon_one/models/coupon_deletion_filters.py index ed1dba4..a3f00ff 100644 --- a/talon_one/models/coupon_deletion_filters.py +++ b/talon_one/models/coupon_deletion_filters.py @@ -66,7 +66,7 @@ class CouponDeletionFilters(object): 'expires_before': 'expiresBefore' } - def __init__(self, created_before=None, created_after=None, starts_after=None, starts_before=None, valid=None, usable=None, redeemed=None, recipient_integration_id=None, exact_match=False, value='false', batch_id=None, referral_id=None, expires_after=None, expires_before=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, created_before=None, created_after=None, starts_after=None, starts_before=None, valid=None, usable=None, redeemed=None, recipient_integration_id=None, exact_match=False, value=None, batch_id=None, referral_id=None, expires_after=None, expires_before=None, local_vars_configuration=None): # noqa: E501 """CouponDeletionFilters - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() diff --git a/talon_one/models/create_achievement.py b/talon_one/models/create_achievement.py index e557412..84f28be 100644 --- a/talon_one/models/create_achievement.py +++ b/talon_one/models/create_achievement.py @@ -38,7 +38,11 @@ class CreateAchievement(object): 'description': 'str', 'target': 'float', 'period': 'str', - 'period_end_override': 'TimePoint' + 'period_end_override': 'TimePoint', + 'recurrence_policy': 'str', + 'activation_policy': 'str', + 'fixed_start_date': 'datetime', + 'end_date': 'datetime' } attribute_map = { @@ -47,10 +51,14 @@ class CreateAchievement(object): 'description': 'description', 'target': 'target', 'period': 'period', - 'period_end_override': 'periodEndOverride' + 'period_end_override': 'periodEndOverride', + 'recurrence_policy': 'recurrencePolicy', + 'activation_policy': 'activationPolicy', + 'fixed_start_date': 'fixedStartDate', + 'end_date': 'endDate' } - def __init__(self, name=None, title=None, description=None, target=None, period=None, period_end_override=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, name=None, title=None, description=None, target=None, period=None, period_end_override=None, recurrence_policy=None, activation_policy=None, fixed_start_date=None, end_date=None, local_vars_configuration=None): # noqa: E501 """CreateAchievement - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -62,6 +70,10 @@ def __init__(self, name=None, title=None, description=None, target=None, period= self._target = None self._period = None self._period_end_override = None + self._recurrence_policy = None + self._activation_policy = None + self._fixed_start_date = None + self._end_date = None self.discriminator = None self.name = name @@ -71,6 +83,14 @@ def __init__(self, name=None, title=None, description=None, target=None, period= self.period = period if period_end_override is not None: self.period_end_override = period_end_override + if recurrence_policy is not None: + self.recurrence_policy = recurrence_policy + if activation_policy is not None: + self.activation_policy = activation_policy + if fixed_start_date is not None: + self.fixed_start_date = fixed_start_date + if end_date is not None: + self.end_date = end_date @property def name(self): @@ -227,6 +247,110 @@ def period_end_override(self, period_end_override): self._period_end_override = period_end_override + @property + def recurrence_policy(self): + """Gets the recurrence_policy of this CreateAchievement. # noqa: E501 + + The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. # noqa: E501 + + :return: The recurrence_policy of this CreateAchievement. # noqa: E501 + :rtype: str + """ + return self._recurrence_policy + + @recurrence_policy.setter + def recurrence_policy(self, recurrence_policy): + """Sets the recurrence_policy of this CreateAchievement. + + The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. # noqa: E501 + + :param recurrence_policy: The recurrence_policy of this CreateAchievement. # noqa: E501 + :type: str + """ + allowed_values = ["no_recurrence", "on_expiration"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and recurrence_policy not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `recurrence_policy` ({0}), must be one of {1}" # noqa: E501 + .format(recurrence_policy, allowed_values) + ) + + self._recurrence_policy = recurrence_policy + + @property + def activation_policy(self): + """Gets the activation_policy of this CreateAchievement. # noqa: E501 + + The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. # noqa: E501 + + :return: The activation_policy of this CreateAchievement. # noqa: E501 + :rtype: str + """ + return self._activation_policy + + @activation_policy.setter + def activation_policy(self, activation_policy): + """Sets the activation_policy of this CreateAchievement. + + The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. # noqa: E501 + + :param activation_policy: The activation_policy of this CreateAchievement. # noqa: E501 + :type: str + """ + allowed_values = ["user_action", "fixed_schedule"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and activation_policy not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `activation_policy` ({0}), must be one of {1}" # noqa: E501 + .format(activation_policy, allowed_values) + ) + + self._activation_policy = activation_policy + + @property + def fixed_start_date(self): + """Gets the fixed_start_date of this CreateAchievement. # noqa: E501 + + The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :return: The fixed_start_date of this CreateAchievement. # noqa: E501 + :rtype: datetime + """ + return self._fixed_start_date + + @fixed_start_date.setter + def fixed_start_date(self, fixed_start_date): + """Sets the fixed_start_date of this CreateAchievement. + + The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :param fixed_start_date: The fixed_start_date of this CreateAchievement. # noqa: E501 + :type: datetime + """ + + self._fixed_start_date = fixed_start_date + + @property + def end_date(self): + """Gets the end_date of this CreateAchievement. # noqa: E501 + + The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :return: The end_date of this CreateAchievement. # noqa: E501 + :rtype: datetime + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this CreateAchievement. + + The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :param end_date: The end_date of this CreateAchievement. # noqa: E501 + :type: datetime + """ + + self._end_date = end_date + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/customer_profile.py b/talon_one/models/customer_profile.py index f17cece..bf4e48c 100644 --- a/talon_one/models/customer_profile.py +++ b/talon_one/models/customer_profile.py @@ -123,7 +123,7 @@ def id(self, id): def created(self): """Gets the created of this CustomerProfile. # noqa: E501 - The time this entity was created. The time this entity was created. # noqa: E501 + The time this entity was created. # noqa: E501 :return: The created of this CustomerProfile. # noqa: E501 :rtype: datetime @@ -134,7 +134,7 @@ def created(self): def created(self, created): """Sets the created of this CustomerProfile. - The time this entity was created. The time this entity was created. # noqa: E501 + The time this entity was created. # noqa: E501 :param created: The created of this CustomerProfile. # noqa: E501 :type: datetime diff --git a/talon_one/models/customer_profile_audience_request_item.py b/talon_one/models/customer_profile_audience_request_item.py index c20f022..b31bab9 100644 --- a/talon_one/models/customer_profile_audience_request_item.py +++ b/talon_one/models/customer_profile_audience_request_item.py @@ -63,7 +63,7 @@ def __init__(self, action=None, profile_integration_id=None, audience_id=None, l def action(self): """Gets the action of this CustomerProfileAudienceRequestItem. # noqa: E501 - Defines the action to perform: - `add`: Adds the customer profile to the audience. If the customer profile does not exist, it will be created. - `delete`: Removes the customer profile from the audience. # noqa: E501 + Defines the action to perform: - `add`: Adds the customer profile to the audience. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `delete`: Removes the customer profile from the audience. # noqa: E501 :return: The action of this CustomerProfileAudienceRequestItem. # noqa: E501 :rtype: str @@ -74,7 +74,7 @@ def action(self): def action(self, action): """Sets the action of this CustomerProfileAudienceRequestItem. - Defines the action to perform: - `add`: Adds the customer profile to the audience. If the customer profile does not exist, it will be created. - `delete`: Removes the customer profile from the audience. # noqa: E501 + Defines the action to perform: - `add`: Adds the customer profile to the audience. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `delete`: Removes the customer profile from the audience. # noqa: E501 :param action: The action of this CustomerProfileAudienceRequestItem. # noqa: E501 :type: str diff --git a/talon_one/models/customer_session_v2.py b/talon_one/models/customer_session_v2.py index bd2ee25..b473b9a 100644 --- a/talon_one/models/customer_session_v2.py +++ b/talon_one/models/customer_session_v2.py @@ -52,7 +52,8 @@ class CustomerSessionV2(object): 'total': 'float', 'cart_item_total': 'float', 'additional_cost_total': 'float', - 'updated': 'datetime' + 'updated': 'datetime', + 'closure_prediction': 'float' } attribute_map = { @@ -75,10 +76,11 @@ class CustomerSessionV2(object): 'total': 'total', 'cart_item_total': 'cartItemTotal', 'additional_cost_total': 'additionalCostTotal', - 'updated': 'updated' + 'updated': 'updated', + 'closure_prediction': 'closurePrediction' } - def __init__(self, id=None, created=None, integration_id=None, application_id=None, profile_id=None, store_integration_id=None, evaluable_campaign_ids=None, coupon_codes=None, referral_code=None, loyalty_cards=None, state='open', cart_items=None, additional_costs=None, identifiers=None, attributes=None, first_session=None, total=None, cart_item_total=None, additional_cost_total=None, updated=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, id=None, created=None, integration_id=None, application_id=None, profile_id=None, store_integration_id=None, evaluable_campaign_ids=None, coupon_codes=None, referral_code=None, loyalty_cards=None, state='open', cart_items=None, additional_costs=None, identifiers=None, attributes=None, first_session=None, total=None, cart_item_total=None, additional_cost_total=None, updated=None, closure_prediction=None, local_vars_configuration=None): # noqa: E501 """CustomerSessionV2 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -104,6 +106,7 @@ def __init__(self, id=None, created=None, integration_id=None, application_id=No self._cart_item_total = None self._additional_cost_total = None self._updated = None + self._closure_prediction = None self.discriminator = None self.id = id @@ -133,6 +136,8 @@ def __init__(self, id=None, created=None, integration_id=None, application_id=No self.cart_item_total = cart_item_total self.additional_cost_total = additional_cost_total self.updated = updated + if closure_prediction is not None: + self.closure_prediction = closure_prediction @property def id(self): @@ -163,7 +168,7 @@ def id(self, id): def created(self): """Gets the created of this CustomerSessionV2. # noqa: E501 - The time this entity was created. The time this entity was created. # noqa: E501 + The time this entity was created. # noqa: E501 :return: The created of this CustomerSessionV2. # noqa: E501 :rtype: datetime @@ -174,7 +179,7 @@ def created(self): def created(self, created): """Sets the created of this CustomerSessionV2. - The time this entity was created. The time this entity was created. # noqa: E501 + The time this entity was created. # noqa: E501 :param created: The created of this CustomerSessionV2. # noqa: E501 :type: datetime @@ -318,7 +323,7 @@ def evaluable_campaign_ids(self, evaluable_campaign_ids): def coupon_codes(self): """Gets the coupon_codes of this CustomerSessionV2. # noqa: E501 - 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. # noqa: E501 + Any coupon codes entered. **Important - for requests only**: - 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. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, omit the parameter entirely. # noqa: E501 :return: The coupon_codes of this CustomerSessionV2. # noqa: E501 :rtype: list[str] @@ -329,7 +334,7 @@ def coupon_codes(self): def coupon_codes(self, coupon_codes): """Sets the coupon_codes of this CustomerSessionV2. - 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. # noqa: E501 + Any coupon codes entered. **Important - for requests only**: - 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. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, omit the parameter entirely. # noqa: E501 :param coupon_codes: The coupon_codes of this CustomerSessionV2. # noqa: E501 :type: list[str] @@ -341,7 +346,7 @@ def coupon_codes(self, coupon_codes): def referral_code(self): """Gets the referral_code of this CustomerSessionV2. # noqa: E501 - 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. # noqa: E501 + Any referral code entered. **Important - for requests only**: - 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. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, omit the parameter entirely. # noqa: E501 :return: The referral_code of this CustomerSessionV2. # noqa: E501 :rtype: str @@ -352,7 +357,7 @@ def referral_code(self): def referral_code(self, referral_code): """Sets the referral_code of this CustomerSessionV2. - 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. # noqa: E501 + Any referral code entered. **Important - for requests only**: - 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. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, omit the parameter entirely. # noqa: E501 :param referral_code: The referral_code of this CustomerSessionV2. # noqa: E501 :type: str @@ -469,7 +474,7 @@ def additional_costs(self, additional_costs): def identifiers(self): """Gets the identifiers of this CustomerSessionV2. # noqa: E501 - 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). # noqa: E501 + 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). - We recommend passing an anonymized (hashed) version of the identifier value. # noqa: E501 :return: The identifiers of this CustomerSessionV2. # noqa: E501 :rtype: list[str] @@ -480,7 +485,7 @@ def identifiers(self): def identifiers(self, identifiers): """Sets the identifiers of this CustomerSessionV2. - 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). # noqa: E501 + 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). - We recommend passing an anonymized (hashed) version of the identifier value. # noqa: E501 :param identifiers: The identifiers of this CustomerSessionV2. # noqa: E501 :type: list[str] @@ -517,7 +522,7 @@ def attributes(self, attributes): def first_session(self): """Gets the first_session of this CustomerSessionV2. # noqa: E501 - Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. # noqa: E501 + Indicates whether this is the first session for the customer's profile. It's always `true` for anonymous sessions. # noqa: E501 :return: The first_session of this CustomerSessionV2. # noqa: E501 :rtype: bool @@ -528,7 +533,7 @@ def first_session(self): def first_session(self, first_session): """Sets the first_session of this CustomerSessionV2. - Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. # noqa: E501 + Indicates whether this is the first session for the customer's profile. It's always `true` for anonymous sessions. # noqa: E501 :param first_session: The first_session of this CustomerSessionV2. # noqa: E501 :type: bool @@ -638,6 +643,29 @@ def updated(self, updated): self._updated = updated + @property + def closure_prediction(self): + """Gets the closure_prediction of this CustomerSessionV2. # noqa: E501 + + The likelihood of the customer session closing based on predictive modeling, expressed as a decimal between `0` and `1`. # noqa: E501 + + :return: The closure_prediction of this CustomerSessionV2. # noqa: E501 + :rtype: float + """ + return self._closure_prediction + + @closure_prediction.setter + def closure_prediction(self, closure_prediction): + """Sets the closure_prediction of this CustomerSessionV2. + + The likelihood of the customer session closing based on predictive modeling, expressed as a decimal between `0` and `1`. # noqa: E501 + + :param closure_prediction: The closure_prediction of this CustomerSessionV2. # noqa: E501 + :type: float + """ + + self._closure_prediction = closure_prediction + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/deduct_loyalty_points_effect_props.py b/talon_one/models/deduct_loyalty_points_effect_props.py index 0bf0767..99c8222 100644 --- a/talon_one/models/deduct_loyalty_points_effect_props.py +++ b/talon_one/models/deduct_loyalty_points_effect_props.py @@ -249,6 +249,9 @@ def card_identifier(self, card_identifier): if (self.local_vars_configuration.client_side_validation and card_identifier is not None and len(card_identifier) > 108): raise ValueError("Invalid value for `card_identifier`, length must be less than or equal to `108`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + card_identifier is not None and not re.search(r'^[A-Za-z0-9_-]*$', card_identifier)): # noqa: E501 + raise ValueError(r"Invalid value for `card_identifier`, must be a follow pattern or equal to `/^[A-Za-z0-9_-]*$/`") # noqa: E501 self._card_identifier = card_identifier diff --git a/talon_one/models/effect.py b/talon_one/models/effect.py index 6f6f211..7e53b24 100644 --- a/talon_one/models/effect.py +++ b/talon_one/models/effect.py @@ -43,6 +43,8 @@ class Effect(object): 'condition_index': 'int', 'evaluation_group_id': 'int', 'evaluation_group_mode': 'str', + 'campaign_revision_id': 'int', + 'campaign_revision_version_id': 'int', 'props': 'object' } @@ -57,10 +59,12 @@ class Effect(object): 'condition_index': 'conditionIndex', 'evaluation_group_id': 'evaluationGroupID', 'evaluation_group_mode': 'evaluationGroupMode', + 'campaign_revision_id': 'campaignRevisionId', + 'campaign_revision_version_id': 'campaignRevisionVersionId', 'props': 'props' } - def __init__(self, campaign_id=None, ruleset_id=None, rule_index=None, rule_name=None, effect_type=None, triggered_by_coupon=None, triggered_for_catalog_item=None, condition_index=None, evaluation_group_id=None, evaluation_group_mode=None, props=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, campaign_id=None, ruleset_id=None, rule_index=None, rule_name=None, effect_type=None, triggered_by_coupon=None, triggered_for_catalog_item=None, condition_index=None, evaluation_group_id=None, evaluation_group_mode=None, campaign_revision_id=None, campaign_revision_version_id=None, props=None, local_vars_configuration=None): # noqa: E501 """Effect - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -76,6 +80,8 @@ def __init__(self, campaign_id=None, ruleset_id=None, rule_index=None, rule_name self._condition_index = None self._evaluation_group_id = None self._evaluation_group_mode = None + self._campaign_revision_id = None + self._campaign_revision_version_id = None self._props = None self.discriminator = None @@ -94,6 +100,10 @@ def __init__(self, campaign_id=None, ruleset_id=None, rule_index=None, rule_name self.evaluation_group_id = evaluation_group_id if evaluation_group_mode is not None: self.evaluation_group_mode = evaluation_group_mode + if campaign_revision_id is not None: + self.campaign_revision_id = campaign_revision_id + if campaign_revision_version_id is not None: + self.campaign_revision_version_id = campaign_revision_version_id self.props = props @property @@ -336,6 +346,52 @@ def evaluation_group_mode(self, evaluation_group_mode): self._evaluation_group_mode = evaluation_group_mode + @property + def campaign_revision_id(self): + """Gets the campaign_revision_id of this Effect. # noqa: E501 + + The revision ID of the campaign that was used when triggering the effect. # noqa: E501 + + :return: The campaign_revision_id of this Effect. # noqa: E501 + :rtype: int + """ + return self._campaign_revision_id + + @campaign_revision_id.setter + def campaign_revision_id(self, campaign_revision_id): + """Sets the campaign_revision_id of this Effect. + + The revision ID of the campaign that was used when triggering the effect. # noqa: E501 + + :param campaign_revision_id: The campaign_revision_id of this Effect. # noqa: E501 + :type: int + """ + + self._campaign_revision_id = campaign_revision_id + + @property + def campaign_revision_version_id(self): + """Gets the campaign_revision_version_id of this Effect. # noqa: E501 + + The revision version ID of the campaign that was used when triggering the effect. # noqa: E501 + + :return: The campaign_revision_version_id of this Effect. # noqa: E501 + :rtype: int + """ + return self._campaign_revision_version_id + + @campaign_revision_version_id.setter + def campaign_revision_version_id(self, campaign_revision_version_id): + """Sets the campaign_revision_version_id of this Effect. + + The revision version ID of the campaign that was used when triggering the effect. # noqa: E501 + + :param campaign_revision_version_id: The campaign_revision_version_id of this Effect. # noqa: E501 + :type: int + """ + + self._campaign_revision_version_id = campaign_revision_version_id + @property def props(self): """Gets the props of this Effect. # noqa: E501 diff --git a/talon_one/models/effect_entity.py b/talon_one/models/effect_entity.py index 84c36c7..cf9ffa1 100644 --- a/talon_one/models/effect_entity.py +++ b/talon_one/models/effect_entity.py @@ -42,7 +42,9 @@ class EffectEntity(object): 'triggered_for_catalog_item': 'int', 'condition_index': 'int', 'evaluation_group_id': 'int', - 'evaluation_group_mode': 'str' + 'evaluation_group_mode': 'str', + 'campaign_revision_id': 'int', + 'campaign_revision_version_id': 'int' } attribute_map = { @@ -55,10 +57,12 @@ class EffectEntity(object): 'triggered_for_catalog_item': 'triggeredForCatalogItem', 'condition_index': 'conditionIndex', 'evaluation_group_id': 'evaluationGroupID', - 'evaluation_group_mode': 'evaluationGroupMode' + 'evaluation_group_mode': 'evaluationGroupMode', + 'campaign_revision_id': 'campaignRevisionId', + 'campaign_revision_version_id': 'campaignRevisionVersionId' } - def __init__(self, campaign_id=None, ruleset_id=None, rule_index=None, rule_name=None, effect_type=None, triggered_by_coupon=None, triggered_for_catalog_item=None, condition_index=None, evaluation_group_id=None, evaluation_group_mode=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, campaign_id=None, ruleset_id=None, rule_index=None, rule_name=None, effect_type=None, triggered_by_coupon=None, triggered_for_catalog_item=None, condition_index=None, evaluation_group_id=None, evaluation_group_mode=None, campaign_revision_id=None, campaign_revision_version_id=None, local_vars_configuration=None): # noqa: E501 """EffectEntity - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -74,6 +78,8 @@ def __init__(self, campaign_id=None, ruleset_id=None, rule_index=None, rule_name self._condition_index = None self._evaluation_group_id = None self._evaluation_group_mode = None + self._campaign_revision_id = None + self._campaign_revision_version_id = None self.discriminator = None self.campaign_id = campaign_id @@ -91,6 +97,10 @@ def __init__(self, campaign_id=None, ruleset_id=None, rule_index=None, rule_name self.evaluation_group_id = evaluation_group_id if evaluation_group_mode is not None: self.evaluation_group_mode = evaluation_group_mode + if campaign_revision_id is not None: + self.campaign_revision_id = campaign_revision_id + if campaign_revision_version_id is not None: + self.campaign_revision_version_id = campaign_revision_version_id @property def campaign_id(self): @@ -332,6 +342,52 @@ def evaluation_group_mode(self, evaluation_group_mode): self._evaluation_group_mode = evaluation_group_mode + @property + def campaign_revision_id(self): + """Gets the campaign_revision_id of this EffectEntity. # noqa: E501 + + The revision ID of the campaign that was used when triggering the effect. # noqa: E501 + + :return: The campaign_revision_id of this EffectEntity. # noqa: E501 + :rtype: int + """ + return self._campaign_revision_id + + @campaign_revision_id.setter + def campaign_revision_id(self, campaign_revision_id): + """Sets the campaign_revision_id of this EffectEntity. + + The revision ID of the campaign that was used when triggering the effect. # noqa: E501 + + :param campaign_revision_id: The campaign_revision_id of this EffectEntity. # noqa: E501 + :type: int + """ + + self._campaign_revision_id = campaign_revision_id + + @property + def campaign_revision_version_id(self): + """Gets the campaign_revision_version_id of this EffectEntity. # noqa: E501 + + The revision version ID of the campaign that was used when triggering the effect. # noqa: E501 + + :return: The campaign_revision_version_id of this EffectEntity. # noqa: E501 + :rtype: int + """ + return self._campaign_revision_version_id + + @campaign_revision_version_id.setter + def campaign_revision_version_id(self, campaign_revision_version_id): + """Sets the campaign_revision_version_id of this EffectEntity. + + The revision version ID of the campaign that was used when triggering the effect. # noqa: E501 + + :param campaign_revision_version_id: The campaign_revision_version_id of this EffectEntity. # noqa: E501 + :type: int + """ + + self._campaign_revision_version_id = campaign_revision_version_id + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/environment.py b/talon_one/models/environment.py index f31cead..bafe21d 100644 --- a/talon_one/models/environment.py +++ b/talon_one/models/environment.py @@ -46,7 +46,8 @@ class Environment(object): 'attributes': 'list[Attribute]', 'additional_costs': 'list[AccountAdditionalCost]', 'audiences': 'list[Audience]', - 'collections': 'list[Collection]' + 'collections': 'list[Collection]', + 'application_cart_item_filters': 'list[ApplicationCIF]' } attribute_map = { @@ -63,10 +64,11 @@ class Environment(object): 'attributes': 'attributes', 'additional_costs': 'additionalCosts', 'audiences': 'audiences', - 'collections': 'collections' + 'collections': 'collections', + 'application_cart_item_filters': 'applicationCartItemFilters' } - def __init__(self, id=None, created=None, application_id=None, slots=None, functions=None, templates=None, variables=None, giveaways_pools=None, loyalty_programs=None, achievements=None, attributes=None, additional_costs=None, audiences=None, collections=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, id=None, created=None, application_id=None, slots=None, functions=None, templates=None, variables=None, giveaways_pools=None, loyalty_programs=None, achievements=None, attributes=None, additional_costs=None, audiences=None, collections=None, application_cart_item_filters=None, local_vars_configuration=None): # noqa: E501 """Environment - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -86,6 +88,7 @@ def __init__(self, id=None, created=None, application_id=None, slots=None, funct self._additional_costs = None self._audiences = None self._collections = None + self._application_cart_item_filters = None self.discriminator = None self.id = id @@ -109,6 +112,8 @@ def __init__(self, id=None, created=None, application_id=None, slots=None, funct self.audiences = audiences if collections is not None: self.collections = collections + if application_cart_item_filters is not None: + self.application_cart_item_filters = application_cart_item_filters @property def id(self): @@ -446,6 +451,29 @@ def collections(self, collections): self._collections = collections + @property + def application_cart_item_filters(self): + """Gets the application_cart_item_filters of this Environment. # noqa: E501 + + The cart item filters belonging to the Application. # noqa: E501 + + :return: The application_cart_item_filters of this Environment. # noqa: E501 + :rtype: list[ApplicationCIF] + """ + return self._application_cart_item_filters + + @application_cart_item_filters.setter + def application_cart_item_filters(self, application_cart_item_filters): + """Sets the application_cart_item_filters of this Environment. + + The cart item filters belonging to the Application. # noqa: E501 + + :param application_cart_item_filters: The application_cart_item_filters of this Environment. # noqa: E501 + :type: list[ApplicationCIF] + """ + + self._application_cart_item_filters = application_cart_item_filters + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/generate_campaign_description.py b/talon_one/models/generate_campaign_description.py index 54c70fe..75cf71c 100644 --- a/talon_one/models/generate_campaign_description.py +++ b/talon_one/models/generate_campaign_description.py @@ -33,52 +33,52 @@ class GenerateCampaignDescription(object): and the value is json key in definition. """ openapi_types = { - 'campaign_id': 'int', + 'ruleset_id': 'int', 'currency': 'str' } attribute_map = { - 'campaign_id': 'campaignID', + 'ruleset_id': 'rulesetID', 'currency': 'currency' } - def __init__(self, campaign_id=None, currency=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, ruleset_id=None, currency=None, local_vars_configuration=None): # noqa: E501 """GenerateCampaignDescription - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration - self._campaign_id = None + self._ruleset_id = None self._currency = None self.discriminator = None - self.campaign_id = campaign_id + self.ruleset_id = ruleset_id self.currency = currency @property - def campaign_id(self): - """Gets the campaign_id of this GenerateCampaignDescription. # noqa: E501 + def ruleset_id(self): + """Gets the ruleset_id of this GenerateCampaignDescription. # noqa: E501 - ID of the campaign. # noqa: E501 + ID of a ruleset. # noqa: E501 - :return: The campaign_id of this GenerateCampaignDescription. # noqa: E501 + :return: The ruleset_id of this GenerateCampaignDescription. # noqa: E501 :rtype: int """ - return self._campaign_id + return self._ruleset_id - @campaign_id.setter - def campaign_id(self, campaign_id): - """Sets the campaign_id of this GenerateCampaignDescription. + @ruleset_id.setter + def ruleset_id(self, ruleset_id): + """Sets the ruleset_id of this GenerateCampaignDescription. - ID of the campaign. # noqa: E501 + ID of a ruleset. # noqa: E501 - :param campaign_id: The campaign_id of this GenerateCampaignDescription. # noqa: E501 + :param ruleset_id: The ruleset_id of this GenerateCampaignDescription. # noqa: E501 :type: int """ - if self.local_vars_configuration.client_side_validation and campaign_id is None: # noqa: E501 - raise ValueError("Invalid value for `campaign_id`, must not be `None`") # noqa: E501 + if self.local_vars_configuration.client_side_validation and ruleset_id is None: # noqa: E501 + raise ValueError("Invalid value for `ruleset_id`, must not be `None`") # noqa: E501 - self._campaign_id = campaign_id + self._ruleset_id = ruleset_id @property def currency(self): diff --git a/talon_one/models/generate_campaign_tags.py b/talon_one/models/generate_campaign_tags.py index c6fc885..31a72b2 100644 --- a/talon_one/models/generate_campaign_tags.py +++ b/talon_one/models/generate_campaign_tags.py @@ -33,48 +33,48 @@ class GenerateCampaignTags(object): and the value is json key in definition. """ openapi_types = { - 'campaign_id': 'int' + 'ruleset_id': 'int' } attribute_map = { - 'campaign_id': 'campaignID' + 'ruleset_id': 'rulesetID' } - def __init__(self, campaign_id=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, ruleset_id=None, local_vars_configuration=None): # noqa: E501 """GenerateCampaignTags - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration - self._campaign_id = None + self._ruleset_id = None self.discriminator = None - self.campaign_id = campaign_id + self.ruleset_id = ruleset_id @property - def campaign_id(self): - """Gets the campaign_id of this GenerateCampaignTags. # noqa: E501 + def ruleset_id(self): + """Gets the ruleset_id of this GenerateCampaignTags. # noqa: E501 - ID of the campaign. # noqa: E501 + ID of a ruleset. # noqa: E501 - :return: The campaign_id of this GenerateCampaignTags. # noqa: E501 + :return: The ruleset_id of this GenerateCampaignTags. # noqa: E501 :rtype: int """ - return self._campaign_id + return self._ruleset_id - @campaign_id.setter - def campaign_id(self, campaign_id): - """Sets the campaign_id of this GenerateCampaignTags. + @ruleset_id.setter + def ruleset_id(self, ruleset_id): + """Sets the ruleset_id of this GenerateCampaignTags. - ID of the campaign. # noqa: E501 + ID of a ruleset. # noqa: E501 - :param campaign_id: The campaign_id of this GenerateCampaignTags. # noqa: E501 + :param ruleset_id: The ruleset_id of this GenerateCampaignTags. # noqa: E501 :type: int """ - if self.local_vars_configuration.client_side_validation and campaign_id is None: # noqa: E501 - raise ValueError("Invalid value for `campaign_id`, must not be `None`") # noqa: E501 + if self.local_vars_configuration.client_side_validation and ruleset_id is None: # noqa: E501 + raise ValueError("Invalid value for `ruleset_id`, must not be `None`") # noqa: E501 - self._campaign_id = campaign_id + self._ruleset_id = ruleset_id def to_dict(self): """Returns the model properties as a dict""" diff --git a/talon_one/models/generate_loyalty_card.py b/talon_one/models/generate_loyalty_card.py index 3843ef2..d10360a 100644 --- a/talon_one/models/generate_loyalty_card.py +++ b/talon_one/models/generate_loyalty_card.py @@ -34,15 +34,17 @@ class GenerateLoyaltyCard(object): """ openapi_types = { 'status': 'str', - 'customer_profile_ids': 'list[str]' + 'customer_profile_ids': 'list[str]', + 'card_identifier': 'str' } attribute_map = { 'status': 'status', - 'customer_profile_ids': 'customerProfileIds' + 'customer_profile_ids': 'customerProfileIds', + 'card_identifier': 'cardIdentifier' } - def __init__(self, status='active', customer_profile_ids=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, status='active', customer_profile_ids=None, card_identifier=None, local_vars_configuration=None): # noqa: E501 """GenerateLoyaltyCard - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -50,12 +52,15 @@ def __init__(self, status='active', customer_profile_ids=None, local_vars_config self._status = None self._customer_profile_ids = None + self._card_identifier = None self.discriminator = None if status is not None: self.status = status if customer_profile_ids is not None: self.customer_profile_ids = customer_profile_ids + if card_identifier is not None: + self.card_identifier = card_identifier @property def status(self): @@ -109,6 +114,35 @@ def customer_profile_ids(self, customer_profile_ids): self._customer_profile_ids = customer_profile_ids + @property + def card_identifier(self): + """Gets the card_identifier of this GenerateLoyaltyCard. # noqa: E501 + + The alphanumeric identifier of the loyalty card. # noqa: E501 + + :return: The card_identifier of this GenerateLoyaltyCard. # noqa: E501 + :rtype: str + """ + return self._card_identifier + + @card_identifier.setter + def card_identifier(self, card_identifier): + """Sets the card_identifier of this GenerateLoyaltyCard. + + The alphanumeric identifier of the loyalty card. # noqa: E501 + + :param card_identifier: The card_identifier of this GenerateLoyaltyCard. # noqa: E501 + :type: str + """ + if (self.local_vars_configuration.client_side_validation and + card_identifier is not None and len(card_identifier) > 108): + raise ValueError("Invalid value for `card_identifier`, length must be less than or equal to `108`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + card_identifier is not None and not re.search(r'^[A-Za-z0-9_-]*$', card_identifier)): # noqa: E501 + raise ValueError(r"Invalid value for `card_identifier`, must be a follow pattern or equal to `/^[A-Za-z0-9_-]*$/`") # noqa: E501 + + self._card_identifier = card_identifier + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/inline_response20020.py b/talon_one/models/inline_response20020.py index be1a3dc..9b8c0ac 100644 --- a/talon_one/models/inline_response20020.py +++ b/talon_one/models/inline_response20020.py @@ -34,7 +34,7 @@ class InlineResponse20020(object): """ openapi_types = { 'total_result_size': 'int', - 'data': 'list[AccessLogEntry]' + 'data': 'list[CampaignAnalytics]' } attribute_map = { @@ -84,7 +84,7 @@ def data(self): :return: The data of this InlineResponse20020. # noqa: E501 - :rtype: list[AccessLogEntry] + :rtype: list[CampaignAnalytics] """ return self._data @@ -94,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20020. # noqa: E501 - :type: list[AccessLogEntry] + :type: list[CampaignAnalytics] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20021.py b/talon_one/models/inline_response20021.py index edf9e1b..a8fa956 100644 --- a/talon_one/models/inline_response20021.py +++ b/talon_one/models/inline_response20021.py @@ -34,25 +34,31 @@ class InlineResponse20021(object): """ openapi_types = { 'total_result_size': 'int', - 'data': 'list[CampaignAnalytics]' + 'has_more': 'bool', + 'data': 'list[ApplicationCustomer]' } attribute_map = { 'total_result_size': 'totalResultSize', + 'has_more': 'hasMore', 'data': 'data' } - def __init__(self, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, total_result_size=None, has_more=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20021 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration self._total_result_size = None + self._has_more = None self._data = None self.discriminator = None - self.total_result_size = total_result_size + if total_result_size is not None: + self.total_result_size = total_result_size + if has_more is not None: + self.has_more = has_more self.data = data @property @@ -73,18 +79,37 @@ def total_result_size(self, total_result_size): :param total_result_size: The total_result_size of this InlineResponse20021. # noqa: E501 :type: int """ - if self.local_vars_configuration.client_side_validation and total_result_size is None: # noqa: E501 - raise ValueError("Invalid value for `total_result_size`, must not be `None`") # noqa: E501 self._total_result_size = total_result_size + @property + def has_more(self): + """Gets the has_more of this InlineResponse20021. # noqa: E501 + + + :return: The has_more of this InlineResponse20021. # noqa: E501 + :rtype: bool + """ + return self._has_more + + @has_more.setter + def has_more(self, has_more): + """Sets the has_more of this InlineResponse20021. + + + :param has_more: The has_more of this InlineResponse20021. # noqa: E501 + :type: bool + """ + + self._has_more = has_more + @property def data(self): """Gets the data of this InlineResponse20021. # noqa: E501 :return: The data of this InlineResponse20021. # noqa: E501 - :rtype: list[CampaignAnalytics] + :rtype: list[ApplicationCustomer] """ return self._data @@ -94,7 +119,7 @@ def data(self, data): :param data: The data of this InlineResponse20021. # noqa: E501 - :type: list[CampaignAnalytics] + :type: list[ApplicationCustomer] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20022.py b/talon_one/models/inline_response20022.py index f47411b..8272f4f 100644 --- a/talon_one/models/inline_response20022.py +++ b/talon_one/models/inline_response20022.py @@ -33,55 +33,34 @@ class InlineResponse20022(object): and the value is json key in definition. """ openapi_types = { - 'total_result_size': 'int', 'has_more': 'bool', + 'total_result_size': 'int', 'data': 'list[ApplicationCustomer]' } attribute_map = { - 'total_result_size': 'totalResultSize', 'has_more': 'hasMore', + 'total_result_size': 'totalResultSize', 'data': 'data' } - def __init__(self, total_result_size=None, has_more=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, has_more=None, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20022 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration - self._total_result_size = None self._has_more = None + self._total_result_size = None self._data = None self.discriminator = None - if total_result_size is not None: - self.total_result_size = total_result_size if has_more is not None: self.has_more = has_more + if total_result_size is not None: + self.total_result_size = total_result_size self.data = data - @property - def total_result_size(self): - """Gets the total_result_size of this InlineResponse20022. # noqa: E501 - - - :return: The total_result_size of this InlineResponse20022. # noqa: E501 - :rtype: int - """ - return self._total_result_size - - @total_result_size.setter - def total_result_size(self, total_result_size): - """Sets the total_result_size of this InlineResponse20022. - - - :param total_result_size: The total_result_size of this InlineResponse20022. # noqa: E501 - :type: int - """ - - self._total_result_size = total_result_size - @property def has_more(self): """Gets the has_more of this InlineResponse20022. # noqa: E501 @@ -103,6 +82,27 @@ def has_more(self, has_more): self._has_more = has_more + @property + def total_result_size(self): + """Gets the total_result_size of this InlineResponse20022. # noqa: E501 + + + :return: The total_result_size of this InlineResponse20022. # noqa: E501 + :rtype: int + """ + return self._total_result_size + + @total_result_size.setter + def total_result_size(self, total_result_size): + """Sets the total_result_size of this InlineResponse20022. + + + :param total_result_size: The total_result_size of this InlineResponse20022. # noqa: E501 + :type: int + """ + + self._total_result_size = total_result_size + @property def data(self): """Gets the data of this InlineResponse20022. # noqa: E501 diff --git a/talon_one/models/inline_response20023.py b/talon_one/models/inline_response20023.py index 1064453..3cd93b5 100644 --- a/talon_one/models/inline_response20023.py +++ b/talon_one/models/inline_response20023.py @@ -35,7 +35,7 @@ class InlineResponse20023(object): openapi_types = { 'has_more': 'bool', 'total_result_size': 'int', - 'data': 'list[ApplicationCustomer]' + 'data': 'list[CustomerProfile]' } attribute_map = { @@ -109,7 +109,7 @@ def data(self): :return: The data of this InlineResponse20023. # noqa: E501 - :rtype: list[ApplicationCustomer] + :rtype: list[CustomerProfile] """ return self._data @@ -119,7 +119,7 @@ def data(self, data): :param data: The data of this InlineResponse20023. # noqa: E501 - :type: list[ApplicationCustomer] + :type: list[CustomerProfile] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20024.py b/talon_one/models/inline_response20024.py index b663290..d2efd3b 100644 --- a/talon_one/models/inline_response20024.py +++ b/talon_one/models/inline_response20024.py @@ -34,31 +34,25 @@ class InlineResponse20024(object): """ openapi_types = { 'has_more': 'bool', - 'total_result_size': 'int', 'data': 'list[CustomerProfile]' } attribute_map = { 'has_more': 'hasMore', - 'total_result_size': 'totalResultSize', 'data': 'data' } - def __init__(self, has_more=None, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, has_more=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20024 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration self._has_more = None - self._total_result_size = None self._data = None self.discriminator = None - if has_more is not None: - self.has_more = has_more - if total_result_size is not None: - self.total_result_size = total_result_size + self.has_more = has_more self.data = data @property @@ -79,30 +73,11 @@ def has_more(self, has_more): :param has_more: The has_more of this InlineResponse20024. # noqa: E501 :type: bool """ + if self.local_vars_configuration.client_side_validation and has_more is None: # noqa: E501 + raise ValueError("Invalid value for `has_more`, must not be `None`") # noqa: E501 self._has_more = has_more - @property - def total_result_size(self): - """Gets the total_result_size of this InlineResponse20024. # noqa: E501 - - - :return: The total_result_size of this InlineResponse20024. # noqa: E501 - :rtype: int - """ - return self._total_result_size - - @total_result_size.setter - def total_result_size(self, total_result_size): - """Sets the total_result_size of this InlineResponse20024. - - - :param total_result_size: The total_result_size of this InlineResponse20024. # noqa: E501 - :type: int - """ - - self._total_result_size = total_result_size - @property def data(self): """Gets the data of this InlineResponse20024. # noqa: E501 diff --git a/talon_one/models/inline_response20025.py b/talon_one/models/inline_response20025.py index 0967083..41ae6cc 100644 --- a/talon_one/models/inline_response20025.py +++ b/talon_one/models/inline_response20025.py @@ -34,7 +34,7 @@ class InlineResponse20025(object): """ openapi_types = { 'has_more': 'bool', - 'data': 'list[CustomerProfile]' + 'data': 'list[CustomerActivityReport]' } attribute_map = { @@ -84,7 +84,7 @@ def data(self): :return: The data of this InlineResponse20025. # noqa: E501 - :rtype: list[CustomerProfile] + :rtype: list[CustomerActivityReport] """ return self._data @@ -94,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20025. # noqa: E501 - :type: list[CustomerProfile] + :type: list[CustomerActivityReport] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20026.py b/talon_one/models/inline_response20026.py index 40304d6..99a0df9 100644 --- a/talon_one/models/inline_response20026.py +++ b/talon_one/models/inline_response20026.py @@ -34,7 +34,7 @@ class InlineResponse20026(object): """ openapi_types = { 'has_more': 'bool', - 'data': 'list[CustomerActivityReport]' + 'data': 'list[ApplicationSession]' } attribute_map = { @@ -52,7 +52,8 @@ def __init__(self, has_more=None, data=None, local_vars_configuration=None): # self._data = None self.discriminator = None - self.has_more = has_more + if has_more is not None: + self.has_more = has_more self.data = data @property @@ -73,8 +74,6 @@ def has_more(self, has_more): :param has_more: The has_more of this InlineResponse20026. # noqa: E501 :type: bool """ - if self.local_vars_configuration.client_side_validation and has_more is None: # noqa: E501 - raise ValueError("Invalid value for `has_more`, must not be `None`") # noqa: E501 self._has_more = has_more @@ -84,7 +83,7 @@ def data(self): :return: The data of this InlineResponse20026. # noqa: E501 - :rtype: list[CustomerActivityReport] + :rtype: list[ApplicationSession] """ return self._data @@ -94,7 +93,7 @@ def data(self, data): :param data: The data of this InlineResponse20026. # noqa: E501 - :type: list[CustomerActivityReport] + :type: list[ApplicationSession] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20027.py b/talon_one/models/inline_response20027.py index fc6a7b2..2f41a59 100644 --- a/talon_one/models/inline_response20027.py +++ b/talon_one/models/inline_response20027.py @@ -34,7 +34,7 @@ class InlineResponse20027(object): """ openapi_types = { 'has_more': 'bool', - 'data': 'list[ApplicationSession]' + 'data': 'list[ApplicationEvent]' } attribute_map = { @@ -52,8 +52,7 @@ def __init__(self, has_more=None, data=None, local_vars_configuration=None): # self._data = None self.discriminator = None - if has_more is not None: - self.has_more = has_more + self.has_more = has_more self.data = data @property @@ -74,6 +73,8 @@ def has_more(self, has_more): :param has_more: The has_more of this InlineResponse20027. # noqa: E501 :type: bool """ + if self.local_vars_configuration.client_side_validation and has_more is None: # noqa: E501 + raise ValueError("Invalid value for `has_more`, must not be `None`") # noqa: E501 self._has_more = has_more @@ -83,7 +84,7 @@ def data(self): :return: The data of this InlineResponse20027. # noqa: E501 - :rtype: list[ApplicationSession] + :rtype: list[ApplicationEvent] """ return self._data @@ -93,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20027. # noqa: E501 - :type: list[ApplicationSession] + :type: list[ApplicationEvent] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20028.py b/talon_one/models/inline_response20028.py index 4f54c2d..0c6fbaf 100644 --- a/talon_one/models/inline_response20028.py +++ b/talon_one/models/inline_response20028.py @@ -33,50 +33,50 @@ class InlineResponse20028(object): and the value is json key in definition. """ openapi_types = { - 'has_more': 'bool', - 'data': 'list[ApplicationEvent]' + 'total_result_size': 'int', + 'data': 'list[str]' } attribute_map = { - 'has_more': 'hasMore', + 'total_result_size': 'totalResultSize', 'data': 'data' } - def __init__(self, has_more=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20028 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration - self._has_more = None + self._total_result_size = None self._data = None self.discriminator = None - self.has_more = has_more + self.total_result_size = total_result_size self.data = data @property - def has_more(self): - """Gets the has_more of this InlineResponse20028. # noqa: E501 + def total_result_size(self): + """Gets the total_result_size of this InlineResponse20028. # noqa: E501 - :return: The has_more of this InlineResponse20028. # noqa: E501 - :rtype: bool + :return: The total_result_size of this InlineResponse20028. # noqa: E501 + :rtype: int """ - return self._has_more + return self._total_result_size - @has_more.setter - def has_more(self, has_more): - """Sets the has_more of this InlineResponse20028. + @total_result_size.setter + def total_result_size(self, total_result_size): + """Sets the total_result_size of this InlineResponse20028. - :param has_more: The has_more of this InlineResponse20028. # noqa: E501 - :type: bool + :param total_result_size: The total_result_size of this InlineResponse20028. # noqa: E501 + :type: int """ - if self.local_vars_configuration.client_side_validation and has_more is None: # noqa: E501 - raise ValueError("Invalid value for `has_more`, must not be `None`") # noqa: E501 + if self.local_vars_configuration.client_side_validation and total_result_size is None: # noqa: E501 + raise ValueError("Invalid value for `total_result_size`, must not be `None`") # noqa: E501 - self._has_more = has_more + self._total_result_size = total_result_size @property def data(self): @@ -84,7 +84,7 @@ def data(self): :return: The data of this InlineResponse20028. # noqa: E501 - :rtype: list[ApplicationEvent] + :rtype: list[str] """ return self._data @@ -94,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20028. # noqa: E501 - :type: list[ApplicationEvent] + :type: list[str] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20029.py b/talon_one/models/inline_response20029.py index a721253..52daf90 100644 --- a/talon_one/models/inline_response20029.py +++ b/talon_one/models/inline_response20029.py @@ -33,28 +33,55 @@ class InlineResponse20029(object): and the value is json key in definition. """ openapi_types = { + 'has_more': 'bool', 'total_result_size': 'int', - 'data': 'list[str]' + 'data': 'list[Audience]' } attribute_map = { + 'has_more': 'hasMore', 'total_result_size': 'totalResultSize', 'data': 'data' } - def __init__(self, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, has_more=None, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20029 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration + self._has_more = None self._total_result_size = None self._data = None self.discriminator = None - self.total_result_size = total_result_size + if has_more is not None: + self.has_more = has_more + if total_result_size is not None: + self.total_result_size = total_result_size self.data = data + @property + def has_more(self): + """Gets the has_more of this InlineResponse20029. # noqa: E501 + + + :return: The has_more of this InlineResponse20029. # noqa: E501 + :rtype: bool + """ + return self._has_more + + @has_more.setter + def has_more(self, has_more): + """Sets the has_more of this InlineResponse20029. + + + :param has_more: The has_more of this InlineResponse20029. # noqa: E501 + :type: bool + """ + + self._has_more = has_more + @property def total_result_size(self): """Gets the total_result_size of this InlineResponse20029. # noqa: E501 @@ -73,8 +100,6 @@ def total_result_size(self, total_result_size): :param total_result_size: The total_result_size of this InlineResponse20029. # noqa: E501 :type: int """ - if self.local_vars_configuration.client_side_validation and total_result_size is None: # noqa: E501 - raise ValueError("Invalid value for `total_result_size`, must not be `None`") # noqa: E501 self._total_result_size = total_result_size @@ -84,7 +109,7 @@ def data(self): :return: The data of this InlineResponse20029. # noqa: E501 - :rtype: list[str] + :rtype: list[Audience] """ return self._data @@ -94,7 +119,7 @@ def data(self, data): :param data: The data of this InlineResponse20029. # noqa: E501 - :type: list[str] + :type: list[Audience] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20030.py b/talon_one/models/inline_response20030.py index 6925fb6..b5bd3ed 100644 --- a/talon_one/models/inline_response20030.py +++ b/talon_one/models/inline_response20030.py @@ -34,31 +34,26 @@ class InlineResponse20030(object): """ openapi_types = { 'has_more': 'bool', - 'total_result_size': 'int', - 'data': 'list[Audience]' + 'data': 'list[AudienceAnalytics]' } attribute_map = { 'has_more': 'hasMore', - 'total_result_size': 'totalResultSize', 'data': 'data' } - def __init__(self, has_more=None, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, has_more=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20030 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration self._has_more = None - self._total_result_size = None self._data = None self.discriminator = None if has_more is not None: self.has_more = has_more - if total_result_size is not None: - self.total_result_size = total_result_size self.data = data @property @@ -82,34 +77,13 @@ def has_more(self, has_more): self._has_more = has_more - @property - def total_result_size(self): - """Gets the total_result_size of this InlineResponse20030. # noqa: E501 - - - :return: The total_result_size of this InlineResponse20030. # noqa: E501 - :rtype: int - """ - return self._total_result_size - - @total_result_size.setter - def total_result_size(self, total_result_size): - """Sets the total_result_size of this InlineResponse20030. - - - :param total_result_size: The total_result_size of this InlineResponse20030. # noqa: E501 - :type: int - """ - - self._total_result_size = total_result_size - @property def data(self): """Gets the data of this InlineResponse20030. # noqa: E501 :return: The data of this InlineResponse20030. # noqa: E501 - :rtype: list[Audience] + :rtype: list[AudienceAnalytics] """ return self._data @@ -119,7 +93,7 @@ def data(self, data): :param data: The data of this InlineResponse20030. # noqa: E501 - :type: list[Audience] + :type: list[AudienceAnalytics] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20031.py b/talon_one/models/inline_response20031.py index 85f3ab8..4d66d63 100644 --- a/talon_one/models/inline_response20031.py +++ b/talon_one/models/inline_response20031.py @@ -34,7 +34,7 @@ class InlineResponse20031(object): """ openapi_types = { 'has_more': 'bool', - 'data': 'list[AudienceAnalytics]' + 'data': 'list[CustomerProfile]' } attribute_map = { @@ -83,7 +83,7 @@ def data(self): :return: The data of this InlineResponse20031. # noqa: E501 - :rtype: list[AudienceAnalytics] + :rtype: list[CustomerProfile] """ return self._data @@ -93,7 +93,7 @@ def data(self, data): :param data: The data of this InlineResponse20031. # noqa: E501 - :type: list[AudienceAnalytics] + :type: list[CustomerProfile] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20032.py b/talon_one/models/inline_response20032.py index 1cb291a..b31acc9 100644 --- a/talon_one/models/inline_response20032.py +++ b/talon_one/models/inline_response20032.py @@ -34,26 +34,31 @@ class InlineResponse20032(object): """ openapi_types = { 'has_more': 'bool', - 'data': 'list[CustomerProfile]' + 'total_result_size': 'int', + 'data': 'list[ApplicationReferee]' } attribute_map = { 'has_more': 'hasMore', + 'total_result_size': 'totalResultSize', 'data': 'data' } - def __init__(self, has_more=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, has_more=None, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20032 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration self._has_more = None + self._total_result_size = None self._data = None self.discriminator = None if has_more is not None: self.has_more = has_more + if total_result_size is not None: + self.total_result_size = total_result_size self.data = data @property @@ -77,13 +82,34 @@ def has_more(self, has_more): self._has_more = has_more + @property + def total_result_size(self): + """Gets the total_result_size of this InlineResponse20032. # noqa: E501 + + + :return: The total_result_size of this InlineResponse20032. # noqa: E501 + :rtype: int + """ + return self._total_result_size + + @total_result_size.setter + def total_result_size(self, total_result_size): + """Sets the total_result_size of this InlineResponse20032. + + + :param total_result_size: The total_result_size of this InlineResponse20032. # noqa: E501 + :type: int + """ + + self._total_result_size = total_result_size + @property def data(self): """Gets the data of this InlineResponse20032. # noqa: E501 :return: The data of this InlineResponse20032. # noqa: E501 - :rtype: list[CustomerProfile] + :rtype: list[ApplicationReferee] """ return self._data @@ -93,7 +119,7 @@ def data(self, data): :param data: The data of this InlineResponse20032. # noqa: E501 - :type: list[CustomerProfile] + :type: list[ApplicationReferee] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20033.py b/talon_one/models/inline_response20033.py index 7149307..ff8fe22 100644 --- a/talon_one/models/inline_response20033.py +++ b/talon_one/models/inline_response20033.py @@ -33,55 +33,28 @@ class InlineResponse20033(object): and the value is json key in definition. """ openapi_types = { - 'has_more': 'bool', 'total_result_size': 'int', - 'data': 'list[ApplicationReferee]' + 'data': 'list[Attribute]' } attribute_map = { - 'has_more': 'hasMore', 'total_result_size': 'totalResultSize', 'data': 'data' } - def __init__(self, has_more=None, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20033 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration - self._has_more = None self._total_result_size = None self._data = None self.discriminator = None - if has_more is not None: - self.has_more = has_more - if total_result_size is not None: - self.total_result_size = total_result_size + self.total_result_size = total_result_size self.data = data - @property - def has_more(self): - """Gets the has_more of this InlineResponse20033. # noqa: E501 - - - :return: The has_more of this InlineResponse20033. # noqa: E501 - :rtype: bool - """ - return self._has_more - - @has_more.setter - def has_more(self, has_more): - """Sets the has_more of this InlineResponse20033. - - - :param has_more: The has_more of this InlineResponse20033. # noqa: E501 - :type: bool - """ - - self._has_more = has_more - @property def total_result_size(self): """Gets the total_result_size of this InlineResponse20033. # noqa: E501 @@ -100,6 +73,8 @@ def total_result_size(self, total_result_size): :param total_result_size: The total_result_size of this InlineResponse20033. # noqa: E501 :type: int """ + if self.local_vars_configuration.client_side_validation and total_result_size is None: # noqa: E501 + raise ValueError("Invalid value for `total_result_size`, must not be `None`") # noqa: E501 self._total_result_size = total_result_size @@ -109,7 +84,7 @@ def data(self): :return: The data of this InlineResponse20033. # noqa: E501 - :rtype: list[ApplicationReferee] + :rtype: list[Attribute] """ return self._data @@ -119,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20033. # noqa: E501 - :type: list[ApplicationReferee] + :type: list[Attribute] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20034.py b/talon_one/models/inline_response20034.py index 70f704f..a792db4 100644 --- a/talon_one/models/inline_response20034.py +++ b/talon_one/models/inline_response20034.py @@ -33,28 +33,55 @@ class InlineResponse20034(object): and the value is json key in definition. """ openapi_types = { + 'has_more': 'bool', 'total_result_size': 'int', - 'data': 'list[Attribute]' + 'data': 'list[CatalogItem]' } attribute_map = { + 'has_more': 'hasMore', 'total_result_size': 'totalResultSize', 'data': 'data' } - def __init__(self, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, has_more=None, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20034 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration + self._has_more = None self._total_result_size = None self._data = None self.discriminator = None - self.total_result_size = total_result_size + if has_more is not None: + self.has_more = has_more + if total_result_size is not None: + self.total_result_size = total_result_size self.data = data + @property + def has_more(self): + """Gets the has_more of this InlineResponse20034. # noqa: E501 + + + :return: The has_more of this InlineResponse20034. # noqa: E501 + :rtype: bool + """ + return self._has_more + + @has_more.setter + def has_more(self, has_more): + """Sets the has_more of this InlineResponse20034. + + + :param has_more: The has_more of this InlineResponse20034. # noqa: E501 + :type: bool + """ + + self._has_more = has_more + @property def total_result_size(self): """Gets the total_result_size of this InlineResponse20034. # noqa: E501 @@ -73,8 +100,6 @@ def total_result_size(self, total_result_size): :param total_result_size: The total_result_size of this InlineResponse20034. # noqa: E501 :type: int """ - if self.local_vars_configuration.client_side_validation and total_result_size is None: # noqa: E501 - raise ValueError("Invalid value for `total_result_size`, must not be `None`") # noqa: E501 self._total_result_size = total_result_size @@ -84,7 +109,7 @@ def data(self): :return: The data of this InlineResponse20034. # noqa: E501 - :rtype: list[Attribute] + :rtype: list[CatalogItem] """ return self._data @@ -94,7 +119,7 @@ def data(self, data): :param data: The data of this InlineResponse20034. # noqa: E501 - :type: list[Attribute] + :type: list[CatalogItem] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20035.py b/talon_one/models/inline_response20035.py index ea7a8e4..3664d21 100644 --- a/talon_one/models/inline_response20035.py +++ b/talon_one/models/inline_response20035.py @@ -33,55 +33,28 @@ class InlineResponse20035(object): and the value is json key in definition. """ openapi_types = { - 'has_more': 'bool', 'total_result_size': 'int', - 'data': 'list[CatalogItem]' + 'data': 'list[AccountAdditionalCost]' } attribute_map = { - 'has_more': 'hasMore', 'total_result_size': 'totalResultSize', 'data': 'data' } - def __init__(self, has_more=None, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20035 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration - self._has_more = None self._total_result_size = None self._data = None self.discriminator = None - if has_more is not None: - self.has_more = has_more - if total_result_size is not None: - self.total_result_size = total_result_size + self.total_result_size = total_result_size self.data = data - @property - def has_more(self): - """Gets the has_more of this InlineResponse20035. # noqa: E501 - - - :return: The has_more of this InlineResponse20035. # noqa: E501 - :rtype: bool - """ - return self._has_more - - @has_more.setter - def has_more(self, has_more): - """Sets the has_more of this InlineResponse20035. - - - :param has_more: The has_more of this InlineResponse20035. # noqa: E501 - :type: bool - """ - - self._has_more = has_more - @property def total_result_size(self): """Gets the total_result_size of this InlineResponse20035. # noqa: E501 @@ -100,6 +73,8 @@ def total_result_size(self, total_result_size): :param total_result_size: The total_result_size of this InlineResponse20035. # noqa: E501 :type: int """ + if self.local_vars_configuration.client_side_validation and total_result_size is None: # noqa: E501 + raise ValueError("Invalid value for `total_result_size`, must not be `None`") # noqa: E501 self._total_result_size = total_result_size @@ -109,7 +84,7 @@ def data(self): :return: The data of this InlineResponse20035. # noqa: E501 - :rtype: list[CatalogItem] + :rtype: list[AccountAdditionalCost] """ return self._data @@ -119,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20035. # noqa: E501 - :type: list[CatalogItem] + :type: list[AccountAdditionalCost] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20036.py b/talon_one/models/inline_response20036.py index 00623cc..33c3889 100644 --- a/talon_one/models/inline_response20036.py +++ b/talon_one/models/inline_response20036.py @@ -34,7 +34,7 @@ class InlineResponse20036(object): """ openapi_types = { 'total_result_size': 'int', - 'data': 'list[AccountAdditionalCost]' + 'data': 'list[WebhookWithOutgoingIntegrationDetails]' } attribute_map = { @@ -84,7 +84,7 @@ def data(self): :return: The data of this InlineResponse20036. # noqa: E501 - :rtype: list[AccountAdditionalCost] + :rtype: list[WebhookWithOutgoingIntegrationDetails] """ return self._data @@ -94,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20036. # noqa: E501 - :type: list[AccountAdditionalCost] + :type: list[WebhookWithOutgoingIntegrationDetails] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20037.py b/talon_one/models/inline_response20037.py index 2b7d9c8..9d80b28 100644 --- a/talon_one/models/inline_response20037.py +++ b/talon_one/models/inline_response20037.py @@ -34,7 +34,7 @@ class InlineResponse20037(object): """ openapi_types = { 'total_result_size': 'int', - 'data': 'list[WebhookWithOutgoingIntegrationDetails]' + 'data': 'list[WebhookActivationLogEntry]' } attribute_map = { @@ -84,7 +84,7 @@ def data(self): :return: The data of this InlineResponse20037. # noqa: E501 - :rtype: list[WebhookWithOutgoingIntegrationDetails] + :rtype: list[WebhookActivationLogEntry] """ return self._data @@ -94,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20037. # noqa: E501 - :type: list[WebhookWithOutgoingIntegrationDetails] + :type: list[WebhookActivationLogEntry] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20038.py b/talon_one/models/inline_response20038.py index e269f80..d260d4c 100644 --- a/talon_one/models/inline_response20038.py +++ b/talon_one/models/inline_response20038.py @@ -34,7 +34,7 @@ class InlineResponse20038(object): """ openapi_types = { 'total_result_size': 'int', - 'data': 'list[WebhookActivationLogEntry]' + 'data': 'list[WebhookLogEntry]' } attribute_map = { @@ -84,7 +84,7 @@ def data(self): :return: The data of this InlineResponse20038. # noqa: E501 - :rtype: list[WebhookActivationLogEntry] + :rtype: list[WebhookLogEntry] """ return self._data @@ -94,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20038. # noqa: E501 - :type: list[WebhookActivationLogEntry] + :type: list[WebhookLogEntry] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20039.py b/talon_one/models/inline_response20039.py index fbb4f29..4776043 100644 --- a/talon_one/models/inline_response20039.py +++ b/talon_one/models/inline_response20039.py @@ -34,7 +34,7 @@ class InlineResponse20039(object): """ openapi_types = { 'total_result_size': 'int', - 'data': 'list[WebhookLogEntry]' + 'data': 'list[EventType]' } attribute_map = { @@ -84,7 +84,7 @@ def data(self): :return: The data of this InlineResponse20039. # noqa: E501 - :rtype: list[WebhookLogEntry] + :rtype: list[EventType] """ return self._data @@ -94,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20039. # noqa: E501 - :type: list[WebhookLogEntry] + :type: list[EventType] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20040.py b/talon_one/models/inline_response20040.py index 04961da..b1313e8 100644 --- a/talon_one/models/inline_response20040.py +++ b/talon_one/models/inline_response20040.py @@ -34,7 +34,7 @@ class InlineResponse20040(object): """ openapi_types = { 'total_result_size': 'int', - 'data': 'list[EventType]' + 'data': 'list[User]' } attribute_map = { @@ -84,7 +84,7 @@ def data(self): :return: The data of this InlineResponse20040. # noqa: E501 - :rtype: list[EventType] + :rtype: list[User] """ return self._data @@ -94,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20040. # noqa: E501 - :type: list[EventType] + :type: list[User] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20041.py b/talon_one/models/inline_response20041.py index 956ca26..697a909 100644 --- a/talon_one/models/inline_response20041.py +++ b/talon_one/models/inline_response20041.py @@ -34,25 +34,31 @@ class InlineResponse20041(object): """ openapi_types = { 'total_result_size': 'int', - 'data': 'list[User]' + 'has_more': 'bool', + 'data': 'list[Change]' } attribute_map = { 'total_result_size': 'totalResultSize', + 'has_more': 'hasMore', 'data': 'data' } - def __init__(self, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, total_result_size=None, has_more=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20041 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration self._total_result_size = None + self._has_more = None self._data = None self.discriminator = None - self.total_result_size = total_result_size + if total_result_size is not None: + self.total_result_size = total_result_size + if has_more is not None: + self.has_more = has_more self.data = data @property @@ -73,18 +79,37 @@ def total_result_size(self, total_result_size): :param total_result_size: The total_result_size of this InlineResponse20041. # noqa: E501 :type: int """ - if self.local_vars_configuration.client_side_validation and total_result_size is None: # noqa: E501 - raise ValueError("Invalid value for `total_result_size`, must not be `None`") # noqa: E501 self._total_result_size = total_result_size + @property + def has_more(self): + """Gets the has_more of this InlineResponse20041. # noqa: E501 + + + :return: The has_more of this InlineResponse20041. # noqa: E501 + :rtype: bool + """ + return self._has_more + + @has_more.setter + def has_more(self, has_more): + """Sets the has_more of this InlineResponse20041. + + + :param has_more: The has_more of this InlineResponse20041. # noqa: E501 + :type: bool + """ + + self._has_more = has_more + @property def data(self): """Gets the data of this InlineResponse20041. # noqa: E501 :return: The data of this InlineResponse20041. # noqa: E501 - :rtype: list[User] + :rtype: list[Change] """ return self._data @@ -94,7 +119,7 @@ def data(self, data): :param data: The data of this InlineResponse20041. # noqa: E501 - :type: list[User] + :type: list[Change] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20042.py b/talon_one/models/inline_response20042.py index d3456c4..d467c5d 100644 --- a/talon_one/models/inline_response20042.py +++ b/talon_one/models/inline_response20042.py @@ -34,31 +34,25 @@ class InlineResponse20042(object): """ openapi_types = { 'total_result_size': 'int', - 'has_more': 'bool', - 'data': 'list[Change]' + 'data': 'list[Export]' } attribute_map = { 'total_result_size': 'totalResultSize', - 'has_more': 'hasMore', 'data': 'data' } - def __init__(self, total_result_size=None, has_more=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20042 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration self._total_result_size = None - self._has_more = None self._data = None self.discriminator = None - if total_result_size is not None: - self.total_result_size = total_result_size - if has_more is not None: - self.has_more = has_more + self.total_result_size = total_result_size self.data = data @property @@ -79,37 +73,18 @@ def total_result_size(self, total_result_size): :param total_result_size: The total_result_size of this InlineResponse20042. # noqa: E501 :type: int """ + if self.local_vars_configuration.client_side_validation and total_result_size is None: # noqa: E501 + raise ValueError("Invalid value for `total_result_size`, must not be `None`") # noqa: E501 self._total_result_size = total_result_size - @property - def has_more(self): - """Gets the has_more of this InlineResponse20042. # noqa: E501 - - - :return: The has_more of this InlineResponse20042. # noqa: E501 - :rtype: bool - """ - return self._has_more - - @has_more.setter - def has_more(self, has_more): - """Sets the has_more of this InlineResponse20042. - - - :param has_more: The has_more of this InlineResponse20042. # noqa: E501 - :type: bool - """ - - self._has_more = has_more - @property def data(self): """Gets the data of this InlineResponse20042. # noqa: E501 :return: The data of this InlineResponse20042. # noqa: E501 - :rtype: list[Change] + :rtype: list[Export] """ return self._data @@ -119,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20042. # noqa: E501 - :type: list[Change] + :type: list[Export] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20043.py b/talon_one/models/inline_response20043.py index b1eb7bf..8445020 100644 --- a/talon_one/models/inline_response20043.py +++ b/talon_one/models/inline_response20043.py @@ -34,7 +34,7 @@ class InlineResponse20043(object): """ openapi_types = { 'total_result_size': 'int', - 'data': 'list[Export]' + 'data': 'list[RoleV2]' } attribute_map = { @@ -84,7 +84,7 @@ def data(self): :return: The data of this InlineResponse20043. # noqa: E501 - :rtype: list[Export] + :rtype: list[RoleV2] """ return self._data @@ -94,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20043. # noqa: E501 - :type: list[Export] + :type: list[RoleV2] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20044.py b/talon_one/models/inline_response20044.py index cfaf954..b5beb85 100644 --- a/talon_one/models/inline_response20044.py +++ b/talon_one/models/inline_response20044.py @@ -33,28 +33,55 @@ class InlineResponse20044(object): and the value is json key in definition. """ openapi_types = { + 'has_more': 'bool', 'total_result_size': 'int', - 'data': 'list[RoleV2]' + 'data': 'list[Store]' } attribute_map = { + 'has_more': 'hasMore', 'total_result_size': 'totalResultSize', 'data': 'data' } - def __init__(self, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, has_more=None, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20044 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration + self._has_more = None self._total_result_size = None self._data = None self.discriminator = None - self.total_result_size = total_result_size + if has_more is not None: + self.has_more = has_more + if total_result_size is not None: + self.total_result_size = total_result_size self.data = data + @property + def has_more(self): + """Gets the has_more of this InlineResponse20044. # noqa: E501 + + + :return: The has_more of this InlineResponse20044. # noqa: E501 + :rtype: bool + """ + return self._has_more + + @has_more.setter + def has_more(self, has_more): + """Sets the has_more of this InlineResponse20044. + + + :param has_more: The has_more of this InlineResponse20044. # noqa: E501 + :type: bool + """ + + self._has_more = has_more + @property def total_result_size(self): """Gets the total_result_size of this InlineResponse20044. # noqa: E501 @@ -73,8 +100,6 @@ def total_result_size(self, total_result_size): :param total_result_size: The total_result_size of this InlineResponse20044. # noqa: E501 :type: int """ - if self.local_vars_configuration.client_side_validation and total_result_size is None: # noqa: E501 - raise ValueError("Invalid value for `total_result_size`, must not be `None`") # noqa: E501 self._total_result_size = total_result_size @@ -84,7 +109,7 @@ def data(self): :return: The data of this InlineResponse20044. # noqa: E501 - :rtype: list[RoleV2] + :rtype: list[Store] """ return self._data @@ -94,7 +119,7 @@ def data(self, data): :param data: The data of this InlineResponse20044. # noqa: E501 - :type: list[RoleV2] + :type: list[Store] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20045.py b/talon_one/models/inline_response20045.py index f7ad34e..c2f9ee2 100644 --- a/talon_one/models/inline_response20045.py +++ b/talon_one/models/inline_response20045.py @@ -34,31 +34,26 @@ class InlineResponse20045(object): """ openapi_types = { 'has_more': 'bool', - 'total_result_size': 'int', - 'data': 'list[Store]' + 'data': 'list[Achievement]' } attribute_map = { 'has_more': 'hasMore', - 'total_result_size': 'totalResultSize', 'data': 'data' } - def __init__(self, has_more=None, total_result_size=None, data=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, has_more=None, data=None, local_vars_configuration=None): # noqa: E501 """InlineResponse20045 - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration self._has_more = None - self._total_result_size = None self._data = None self.discriminator = None if has_more is not None: self.has_more = has_more - if total_result_size is not None: - self.total_result_size = total_result_size self.data = data @property @@ -82,34 +77,13 @@ def has_more(self, has_more): self._has_more = has_more - @property - def total_result_size(self): - """Gets the total_result_size of this InlineResponse20045. # noqa: E501 - - - :return: The total_result_size of this InlineResponse20045. # noqa: E501 - :rtype: int - """ - return self._total_result_size - - @total_result_size.setter - def total_result_size(self, total_result_size): - """Sets the total_result_size of this InlineResponse20045. - - - :param total_result_size: The total_result_size of this InlineResponse20045. # noqa: E501 - :type: int - """ - - self._total_result_size = total_result_size - @property def data(self): """Gets the data of this InlineResponse20045. # noqa: E501 :return: The data of this InlineResponse20045. # noqa: E501 - :rtype: list[Store] + :rtype: list[Achievement] """ return self._data @@ -119,7 +93,7 @@ def data(self, data): :param data: The data of this InlineResponse20045. # noqa: E501 - :type: list[Store] + :type: list[Achievement] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/inline_response20046.py b/talon_one/models/inline_response20046.py index 4ef3bf1..28771ae 100644 --- a/talon_one/models/inline_response20046.py +++ b/talon_one/models/inline_response20046.py @@ -34,7 +34,7 @@ class InlineResponse20046(object): """ openapi_types = { 'has_more': 'bool', - 'data': 'list[Achievement]' + 'data': 'list[AchievementProgress]' } attribute_map = { @@ -52,8 +52,7 @@ def __init__(self, has_more=None, data=None, local_vars_configuration=None): # self._data = None self.discriminator = None - if has_more is not None: - self.has_more = has_more + self.has_more = has_more self.data = data @property @@ -74,6 +73,8 @@ def has_more(self, has_more): :param has_more: The has_more of this InlineResponse20046. # noqa: E501 :type: bool """ + if self.local_vars_configuration.client_side_validation and has_more is None: # noqa: E501 + raise ValueError("Invalid value for `has_more`, must not be `None`") # noqa: E501 self._has_more = has_more @@ -83,7 +84,7 @@ def data(self): :return: The data of this InlineResponse20046. # noqa: E501 - :rtype: list[Achievement] + :rtype: list[AchievementProgress] """ return self._data @@ -93,7 +94,7 @@ def data(self, data): :param data: The data of this InlineResponse20046. # noqa: E501 - :type: list[Achievement] + :type: list[AchievementProgress] """ if self.local_vars_configuration.client_side_validation and data is None: # noqa: E501 raise ValueError("Invalid value for `data`, must not be `None`") # noqa: E501 diff --git a/talon_one/models/integration_customer_session_response.py b/talon_one/models/integration_customer_session_response.py index c2e59d8..74bdadd 100644 --- a/talon_one/models/integration_customer_session_response.py +++ b/talon_one/models/integration_customer_session_response.py @@ -82,6 +82,7 @@ def customer_session(self, customer_session): def effects(self): """Gets the effects of this IntegrationCustomerSessionResponse. # noqa: E501 + The returned effects. **Note:** This endpoint returns only the effects that are valid after any rollback effects and their corresponding non-rollback effects are removed. # noqa: E501 :return: The effects of this IntegrationCustomerSessionResponse. # noqa: E501 :rtype: list[Effect] @@ -92,6 +93,7 @@ def effects(self): def effects(self, effects): """Sets the effects of this IntegrationCustomerSessionResponse. + The returned effects. **Note:** This endpoint returns only the effects that are valid after any rollback effects and their corresponding non-rollback effects are removed. # noqa: E501 :param effects: The effects of this IntegrationCustomerSessionResponse. # noqa: E501 :type: list[Effect] diff --git a/talon_one/models/ledger_info.py b/talon_one/models/ledger_info.py index 69146e4..4f224ed 100644 --- a/talon_one/models/ledger_info.py +++ b/talon_one/models/ledger_info.py @@ -186,7 +186,7 @@ def spent_balance(self, spent_balance): def tentative_current_balance(self): """Gets the tentative_current_balance of this LedgerInfo. # noqa: E501 - 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. # noqa: E501 + The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. # noqa: E501 :return: The tentative_current_balance of this LedgerInfo. # noqa: E501 :rtype: float @@ -197,7 +197,7 @@ def tentative_current_balance(self): def tentative_current_balance(self, tentative_current_balance): """Sets the tentative_current_balance of this LedgerInfo. - 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. # noqa: E501 + The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. # noqa: E501 :param tentative_current_balance: The tentative_current_balance of this LedgerInfo. # noqa: E501 :type: float @@ -211,7 +211,7 @@ def tentative_current_balance(self, tentative_current_balance): def tentative_pending_balance(self): """Gets the tentative_pending_balance of this LedgerInfo. # noqa: E501 - 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. # noqa: E501 + The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. # noqa: E501 :return: The tentative_pending_balance of this LedgerInfo. # noqa: E501 :rtype: float @@ -222,7 +222,7 @@ def tentative_pending_balance(self): def tentative_pending_balance(self, tentative_pending_balance): """Sets the tentative_pending_balance of this LedgerInfo. - 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. # noqa: E501 + The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. # noqa: E501 :param tentative_pending_balance: The tentative_pending_balance of this LedgerInfo. # noqa: E501 :type: float diff --git a/talon_one/models/limit_config.py b/talon_one/models/limit_config.py index 515e65f..14ea80b 100644 --- a/talon_one/models/limit_config.py +++ b/talon_one/models/limit_config.py @@ -168,7 +168,7 @@ def entities(self, entities): """ if self.local_vars_configuration.client_side_validation and entities is None: # noqa: E501 raise ValueError("Invalid value for `entities`, must not be `None`") # noqa: E501 - allowed_values = ["Coupon", "Referral", "Profile", "Identifier"] # noqa: E501 + allowed_values = ["Coupon", "Referral", "Profile", "Identifier", "Store", "Session"] # noqa: E501 if (self.local_vars_configuration.client_side_validation and not set(entities).issubset(set(allowed_values))): # noqa: E501 raise ValueError( diff --git a/talon_one/models/list_campaign_store_budgets.py b/talon_one/models/list_campaign_store_budgets.py new file mode 100644 index 0000000..df53879 --- /dev/null +++ b/talon_one/models/list_campaign_store_budgets.py @@ -0,0 +1,201 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ListCampaignStoreBudgets(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'store': 'ListCampaignStoreBudgetsStore', + 'limit': 'int', + 'action': 'str', + 'period': 'str' + } + + attribute_map = { + 'store': 'store', + 'limit': 'limit', + 'action': 'action', + 'period': 'period' + } + + def __init__(self, store=None, limit=None, action=None, period=None, local_vars_configuration=None): # noqa: E501 + """ListCampaignStoreBudgets - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._store = None + self._limit = None + self._action = None + self._period = None + self.discriminator = None + + self.store = store + self.limit = limit + self.action = action + if period is not None: + self.period = period + + @property + def store(self): + """Gets the store of this ListCampaignStoreBudgets. # noqa: E501 + + + :return: The store of this ListCampaignStoreBudgets. # noqa: E501 + :rtype: ListCampaignStoreBudgetsStore + """ + return self._store + + @store.setter + def store(self, store): + """Sets the store of this ListCampaignStoreBudgets. + + + :param store: The store of this ListCampaignStoreBudgets. # noqa: E501 + :type: ListCampaignStoreBudgetsStore + """ + if self.local_vars_configuration.client_side_validation and store is None: # noqa: E501 + raise ValueError("Invalid value for `store`, must not be `None`") # noqa: E501 + + self._store = store + + @property + def limit(self): + """Gets the limit of this ListCampaignStoreBudgets. # noqa: E501 + + + :return: The limit of this ListCampaignStoreBudgets. # noqa: E501 + :rtype: int + """ + return self._limit + + @limit.setter + def limit(self, limit): + """Sets the limit of this ListCampaignStoreBudgets. + + + :param limit: The limit of this ListCampaignStoreBudgets. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and limit is None: # noqa: E501 + raise ValueError("Invalid value for `limit`, must not be `None`") # noqa: E501 + + self._limit = limit + + @property + def action(self): + """Gets the action of this ListCampaignStoreBudgets. # noqa: E501 + + + :return: The action of this ListCampaignStoreBudgets. # noqa: E501 + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """Sets the action of this ListCampaignStoreBudgets. + + + :param action: The action of this ListCampaignStoreBudgets. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and action is None: # noqa: E501 + raise ValueError("Invalid value for `action`, must not be `None`") # noqa: E501 + + self._action = action + + @property + def period(self): + """Gets the period of this ListCampaignStoreBudgets. # noqa: E501 + + + :return: The period of this ListCampaignStoreBudgets. # noqa: E501 + :rtype: str + """ + return self._period + + @period.setter + def period(self, period): + """Sets the period of this ListCampaignStoreBudgets. + + + :param period: The period of this ListCampaignStoreBudgets. # noqa: E501 + :type: str + """ + + self._period = period + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ListCampaignStoreBudgets): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ListCampaignStoreBudgets): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/list_campaign_store_budgets_store.py b/talon_one/models/list_campaign_store_budgets_store.py new file mode 100644 index 0000000..9e47f63 --- /dev/null +++ b/talon_one/models/list_campaign_store_budgets_store.py @@ -0,0 +1,175 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ListCampaignStoreBudgetsStore(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'id': 'int', + 'integration_id': 'str', + 'name': 'str' + } + + attribute_map = { + 'id': 'id', + 'integration_id': 'integrationId', + 'name': 'name' + } + + def __init__(self, id=None, integration_id=None, name=None, local_vars_configuration=None): # noqa: E501 + """ListCampaignStoreBudgetsStore - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._id = None + self._integration_id = None + self._name = None + self.discriminator = None + + self.id = id + self.integration_id = integration_id + self.name = name + + @property + def id(self): + """Gets the id of this ListCampaignStoreBudgetsStore. # noqa: E501 + + + :return: The id of this ListCampaignStoreBudgetsStore. # noqa: E501 + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this ListCampaignStoreBudgetsStore. + + + :param id: The id of this ListCampaignStoreBudgetsStore. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501 + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + @property + def integration_id(self): + """Gets the integration_id of this ListCampaignStoreBudgetsStore. # noqa: E501 + + + :return: The integration_id of this ListCampaignStoreBudgetsStore. # noqa: E501 + :rtype: str + """ + return self._integration_id + + @integration_id.setter + def integration_id(self, integration_id): + """Sets the integration_id of this ListCampaignStoreBudgetsStore. + + + :param integration_id: The integration_id of this ListCampaignStoreBudgetsStore. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and integration_id is None: # noqa: E501 + raise ValueError("Invalid value for `integration_id`, must not be `None`") # noqa: E501 + + self._integration_id = integration_id + + @property + def name(self): + """Gets the name of this ListCampaignStoreBudgetsStore. # noqa: E501 + + + :return: The name of this ListCampaignStoreBudgetsStore. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this ListCampaignStoreBudgetsStore. + + + :param name: The name of this ListCampaignStoreBudgetsStore. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and name is None: # noqa: E501 + raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501 + + self._name = name + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ListCampaignStoreBudgetsStore): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ListCampaignStoreBudgetsStore): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/loyalty_card.py b/talon_one/models/loyalty_card.py index 8a618c3..9454f08 100644 --- a/talon_one/models/loyalty_card.py +++ b/talon_one/models/loyalty_card.py @@ -36,6 +36,8 @@ class LoyaltyCard(object): 'id': 'int', 'created': 'datetime', 'program_id': 'int', + 'program_name': 'str', + 'program_title': 'str', 'status': 'str', 'block_reason': 'str', 'identifier': 'str', @@ -45,13 +47,16 @@ class LoyaltyCard(object): 'subledgers': 'dict(str, LedgerInfo)', 'modified': 'datetime', 'old_card_identifier': 'str', - 'new_card_identifier': 'str' + 'new_card_identifier': 'str', + 'batch_id': 'str' } attribute_map = { 'id': 'id', 'created': 'created', 'program_id': 'programID', + 'program_name': 'programName', + 'program_title': 'programTitle', 'status': 'status', 'block_reason': 'blockReason', 'identifier': 'identifier', @@ -61,10 +66,11 @@ class LoyaltyCard(object): 'subledgers': 'subledgers', 'modified': 'modified', 'old_card_identifier': 'oldCardIdentifier', - 'new_card_identifier': 'newCardIdentifier' + 'new_card_identifier': 'newCardIdentifier', + 'batch_id': 'batchId' } - def __init__(self, id=None, created=None, program_id=None, status=None, block_reason=None, identifier=None, users_per_card_limit=None, profiles=None, ledger=None, subledgers=None, modified=None, old_card_identifier=None, new_card_identifier=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, id=None, created=None, program_id=None, program_name=None, program_title=None, status=None, block_reason=None, identifier=None, users_per_card_limit=None, profiles=None, ledger=None, subledgers=None, modified=None, old_card_identifier=None, new_card_identifier=None, batch_id=None, local_vars_configuration=None): # noqa: E501 """LoyaltyCard - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -73,6 +79,8 @@ def __init__(self, id=None, created=None, program_id=None, status=None, block_re self._id = None self._created = None self._program_id = None + self._program_name = None + self._program_title = None self._status = None self._block_reason = None self._identifier = None @@ -83,11 +91,16 @@ def __init__(self, id=None, created=None, program_id=None, status=None, block_re self._modified = None self._old_card_identifier = None self._new_card_identifier = None + self._batch_id = None self.discriminator = None self.id = id self.created = created self.program_id = program_id + if program_name is not None: + self.program_name = program_name + if program_title is not None: + self.program_title = program_title self.status = status if block_reason is not None: self.block_reason = block_reason @@ -105,6 +118,8 @@ def __init__(self, id=None, created=None, program_id=None, status=None, block_re self.old_card_identifier = old_card_identifier if new_card_identifier is not None: self.new_card_identifier = new_card_identifier + if batch_id is not None: + self.batch_id = batch_id @property def id(self): @@ -181,6 +196,52 @@ def program_id(self, program_id): self._program_id = program_id + @property + def program_name(self): + """Gets the program_name of this LoyaltyCard. # noqa: E501 + + The integration name of the loyalty program that owns this entity. # noqa: E501 + + :return: The program_name of this LoyaltyCard. # noqa: E501 + :rtype: str + """ + return self._program_name + + @program_name.setter + def program_name(self, program_name): + """Sets the program_name of this LoyaltyCard. + + The integration name of the loyalty program that owns this entity. # noqa: E501 + + :param program_name: The program_name of this LoyaltyCard. # noqa: E501 + :type: str + """ + + self._program_name = program_name + + @property + def program_title(self): + """Gets the program_title of this LoyaltyCard. # noqa: E501 + + The Campaign Manager-displayed name of the loyalty program that owns this entity. # noqa: E501 + + :return: The program_title of this LoyaltyCard. # noqa: E501 + :rtype: str + """ + return self._program_title + + @program_title.setter + def program_title(self, program_title): + """Sets the program_title of this LoyaltyCard. + + The Campaign Manager-displayed name of the loyalty program that owns this entity. # noqa: E501 + + :param program_title: The program_title of this LoyaltyCard. # noqa: E501 + :type: str + """ + + self._program_title = program_title + @property def status(self): """Gets the status of this LoyaltyCard. # noqa: E501 @@ -254,6 +315,9 @@ def identifier(self, identifier): if (self.local_vars_configuration.client_side_validation and identifier is not None and len(identifier) > 108): raise ValueError("Invalid value for `identifier`, length must be less than or equal to `108`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + identifier is not None and not re.search(r'^[A-Za-z0-9_-]*$', identifier)): # noqa: E501 + raise ValueError(r"Invalid value for `identifier`, must be a follow pattern or equal to `/^[A-Za-z0-9_-]*$/`") # noqa: E501 self._identifier = identifier @@ -398,6 +462,9 @@ def old_card_identifier(self, old_card_identifier): if (self.local_vars_configuration.client_side_validation and old_card_identifier is not None and len(old_card_identifier) > 108): raise ValueError("Invalid value for `old_card_identifier`, length must be less than or equal to `108`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + old_card_identifier is not None and not re.search(r'^[A-Za-z0-9_-]*$', old_card_identifier)): # noqa: E501 + raise ValueError(r"Invalid value for `old_card_identifier`, must be a follow pattern or equal to `/^[A-Za-z0-9_-]*$/`") # noqa: E501 self._old_card_identifier = old_card_identifier @@ -424,9 +491,35 @@ def new_card_identifier(self, new_card_identifier): if (self.local_vars_configuration.client_side_validation and new_card_identifier is not None and len(new_card_identifier) > 108): raise ValueError("Invalid value for `new_card_identifier`, length must be less than or equal to `108`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + new_card_identifier is not None and not re.search(r'^[A-Za-z0-9_-]*$', new_card_identifier)): # noqa: E501 + raise ValueError(r"Invalid value for `new_card_identifier`, must be a follow pattern or equal to `/^[A-Za-z0-9_-]*$/`") # noqa: E501 self._new_card_identifier = new_card_identifier + @property + def batch_id(self): + """Gets the batch_id of this LoyaltyCard. # noqa: E501 + + The ID of the batch in which the loyalty card was created. # noqa: E501 + + :return: The batch_id of this LoyaltyCard. # noqa: E501 + :rtype: str + """ + return self._batch_id + + @batch_id.setter + def batch_id(self, batch_id): + """Sets the batch_id of this LoyaltyCard. + + The ID of the batch in which the loyalty card was created. # noqa: E501 + + :param batch_id: The batch_id of this LoyaltyCard. # noqa: E501 + :type: str + """ + + self._batch_id = batch_id + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/loyalty_card_batch.py b/talon_one/models/loyalty_card_batch.py new file mode 100644 index 0000000..db195b5 --- /dev/null +++ b/talon_one/models/loyalty_card_batch.py @@ -0,0 +1,220 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class LoyaltyCardBatch(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'number_of_cards': 'int', + 'batch_id': 'str', + 'status': 'str', + 'card_code_settings': 'CodeGeneratorSettings' + } + + attribute_map = { + 'number_of_cards': 'numberOfCards', + 'batch_id': 'batchId', + 'status': 'status', + 'card_code_settings': 'cardCodeSettings' + } + + def __init__(self, number_of_cards=None, batch_id=None, status='active', card_code_settings=None, local_vars_configuration=None): # noqa: E501 + """LoyaltyCardBatch - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._number_of_cards = None + self._batch_id = None + self._status = None + self._card_code_settings = None + self.discriminator = None + + self.number_of_cards = number_of_cards + if batch_id is not None: + self.batch_id = batch_id + if status is not None: + self.status = status + if card_code_settings is not None: + self.card_code_settings = card_code_settings + + @property + def number_of_cards(self): + """Gets the number_of_cards of this LoyaltyCardBatch. # noqa: E501 + + Number of loyalty cards in the batch. # noqa: E501 + + :return: The number_of_cards of this LoyaltyCardBatch. # noqa: E501 + :rtype: int + """ + return self._number_of_cards + + @number_of_cards.setter + def number_of_cards(self, number_of_cards): + """Sets the number_of_cards of this LoyaltyCardBatch. + + Number of loyalty cards in the batch. # noqa: E501 + + :param number_of_cards: The number_of_cards of this LoyaltyCardBatch. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and number_of_cards is None: # noqa: E501 + raise ValueError("Invalid value for `number_of_cards`, must not be `None`") # noqa: E501 + + self._number_of_cards = number_of_cards + + @property + def batch_id(self): + """Gets the batch_id of this LoyaltyCardBatch. # noqa: E501 + + ID of the loyalty card batch. # noqa: E501 + + :return: The batch_id of this LoyaltyCardBatch. # noqa: E501 + :rtype: str + """ + return self._batch_id + + @batch_id.setter + def batch_id(self, batch_id): + """Sets the batch_id of this LoyaltyCardBatch. + + ID of the loyalty card batch. # noqa: E501 + + :param batch_id: The batch_id of this LoyaltyCardBatch. # noqa: E501 + :type: str + """ + if (self.local_vars_configuration.client_side_validation and + batch_id is not None and len(batch_id) > 20): + raise ValueError("Invalid value for `batch_id`, length must be less than or equal to `20`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + batch_id is not None and len(batch_id) < 4): + raise ValueError("Invalid value for `batch_id`, length must be greater than or equal to `4`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + batch_id is not None and not re.search(r'^[A-Za-z0-9_-]*$', batch_id)): # noqa: E501 + raise ValueError(r"Invalid value for `batch_id`, must be a follow pattern or equal to `/^[A-Za-z0-9_-]*$/`") # noqa: E501 + + self._batch_id = batch_id + + @property + def status(self): + """Gets the status of this LoyaltyCardBatch. # noqa: E501 + + Status of the loyalty cards in the batch. # noqa: E501 + + :return: The status of this LoyaltyCardBatch. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this LoyaltyCardBatch. + + Status of the loyalty cards in the batch. # noqa: E501 + + :param status: The status of this LoyaltyCardBatch. # noqa: E501 + :type: str + """ + allowed_values = ["active", "inactive"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and status not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `status` ({0}), must be one of {1}" # noqa: E501 + .format(status, allowed_values) + ) + + self._status = status + + @property + def card_code_settings(self): + """Gets the card_code_settings of this LoyaltyCardBatch. # noqa: E501 + + + :return: The card_code_settings of this LoyaltyCardBatch. # noqa: E501 + :rtype: CodeGeneratorSettings + """ + return self._card_code_settings + + @card_code_settings.setter + def card_code_settings(self, card_code_settings): + """Sets the card_code_settings of this LoyaltyCardBatch. + + + :param card_code_settings: The card_code_settings of this LoyaltyCardBatch. # noqa: E501 + :type: CodeGeneratorSettings + """ + + self._card_code_settings = card_code_settings + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, LoyaltyCardBatch): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, LoyaltyCardBatch): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/loyalty_card_batch_response.py b/talon_one/models/loyalty_card_batch_response.py new file mode 100644 index 0000000..ebb742e --- /dev/null +++ b/talon_one/models/loyalty_card_batch_response.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class LoyaltyCardBatchResponse(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'number_of_cards_generated': 'int', + 'batch_id': 'str' + } + + attribute_map = { + 'number_of_cards_generated': 'numberOfCardsGenerated', + 'batch_id': 'batchId' + } + + def __init__(self, number_of_cards_generated=None, batch_id=None, local_vars_configuration=None): # noqa: E501 + """LoyaltyCardBatchResponse - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._number_of_cards_generated = None + self._batch_id = None + self.discriminator = None + + self.number_of_cards_generated = number_of_cards_generated + self.batch_id = batch_id + + @property + def number_of_cards_generated(self): + """Gets the number_of_cards_generated of this LoyaltyCardBatchResponse. # noqa: E501 + + Number of loyalty cards in the batch. # noqa: E501 + + :return: The number_of_cards_generated of this LoyaltyCardBatchResponse. # noqa: E501 + :rtype: int + """ + return self._number_of_cards_generated + + @number_of_cards_generated.setter + def number_of_cards_generated(self, number_of_cards_generated): + """Sets the number_of_cards_generated of this LoyaltyCardBatchResponse. + + Number of loyalty cards in the batch. # noqa: E501 + + :param number_of_cards_generated: The number_of_cards_generated of this LoyaltyCardBatchResponse. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and number_of_cards_generated is None: # noqa: E501 + raise ValueError("Invalid value for `number_of_cards_generated`, must not be `None`") # noqa: E501 + + self._number_of_cards_generated = number_of_cards_generated + + @property + def batch_id(self): + """Gets the batch_id of this LoyaltyCardBatchResponse. # noqa: E501 + + ID of the loyalty card batch. # noqa: E501 + + :return: The batch_id of this LoyaltyCardBatchResponse. # noqa: E501 + :rtype: str + """ + return self._batch_id + + @batch_id.setter + def batch_id(self, batch_id): + """Sets the batch_id of this LoyaltyCardBatchResponse. + + ID of the loyalty card batch. # noqa: E501 + + :param batch_id: The batch_id of this LoyaltyCardBatchResponse. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and batch_id is None: # noqa: E501 + raise ValueError("Invalid value for `batch_id`, must not be `None`") # noqa: E501 + + self._batch_id = batch_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, LoyaltyCardBatchResponse): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, LoyaltyCardBatchResponse): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/loyalty_program.py b/talon_one/models/loyalty_program.py index 0a9239c..5bd7bad 100644 --- a/talon_one/models/loyalty_program.py +++ b/talon_one/models/loyalty_program.py @@ -49,6 +49,7 @@ class LoyaltyProgram(object): 'tiers_expire_in': 'str', 'tiers_downgrade_policy': 'str', 'card_code_settings': 'CodeGeneratorSettings', + 'return_policy': 'str', 'account_id': 'int', 'name': 'str', 'tiers': 'list[LoyaltyTier]', @@ -57,7 +58,8 @@ class LoyaltyProgram(object): 'can_update_tiers': 'bool', 'can_update_join_policy': 'bool', 'can_update_tier_expiration_policy': 'bool', - 'can_upgrade_to_advanced_tiers': 'bool' + 'can_upgrade_to_advanced_tiers': 'bool', + 'can_update_subledgers': 'bool' } attribute_map = { @@ -77,6 +79,7 @@ class LoyaltyProgram(object): 'tiers_expire_in': 'tiersExpireIn', 'tiers_downgrade_policy': 'tiersDowngradePolicy', 'card_code_settings': 'cardCodeSettings', + 'return_policy': 'returnPolicy', 'account_id': 'accountID', 'name': 'name', 'tiers': 'tiers', @@ -85,10 +88,11 @@ class LoyaltyProgram(object): 'can_update_tiers': 'canUpdateTiers', 'can_update_join_policy': 'canUpdateJoinPolicy', 'can_update_tier_expiration_policy': 'canUpdateTierExpirationPolicy', - 'can_upgrade_to_advanced_tiers': 'canUpgradeToAdvancedTiers' + 'can_upgrade_to_advanced_tiers': 'canUpgradeToAdvancedTiers', + 'can_update_subledgers': 'canUpdateSubledgers' } - def __init__(self, id=None, created=None, title=None, description=None, subscribed_applications=None, default_validity=None, default_pending=None, allow_subledger=None, users_per_card_limit=None, sandbox=None, program_join_policy=None, tiers_expiration_policy=None, tier_cycle_start_date=None, tiers_expire_in=None, tiers_downgrade_policy=None, card_code_settings=None, account_id=None, name=None, tiers=None, timezone=None, card_based=False, can_update_tiers=False, can_update_join_policy=None, can_update_tier_expiration_policy=None, can_upgrade_to_advanced_tiers=False, local_vars_configuration=None): # noqa: E501 + def __init__(self, id=None, created=None, title=None, description=None, subscribed_applications=None, default_validity=None, default_pending=None, allow_subledger=None, users_per_card_limit=None, sandbox=None, program_join_policy=None, tiers_expiration_policy=None, tier_cycle_start_date=None, tiers_expire_in=None, tiers_downgrade_policy=None, card_code_settings=None, return_policy=None, account_id=None, name=None, tiers=None, timezone=None, card_based=False, can_update_tiers=False, can_update_join_policy=None, can_update_tier_expiration_policy=None, can_upgrade_to_advanced_tiers=False, can_update_subledgers=False, local_vars_configuration=None): # noqa: E501 """LoyaltyProgram - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -110,6 +114,7 @@ def __init__(self, id=None, created=None, title=None, description=None, subscrib self._tiers_expire_in = None self._tiers_downgrade_policy = None self._card_code_settings = None + self._return_policy = None self._account_id = None self._name = None self._tiers = None @@ -119,6 +124,7 @@ def __init__(self, id=None, created=None, title=None, description=None, subscrib self._can_update_join_policy = None self._can_update_tier_expiration_policy = None self._can_upgrade_to_advanced_tiers = None + self._can_update_subledgers = None self.discriminator = None self.id = id @@ -144,6 +150,8 @@ def __init__(self, id=None, created=None, title=None, description=None, subscrib self.tiers_downgrade_policy = tiers_downgrade_policy if card_code_settings is not None: self.card_code_settings = card_code_settings + if return_policy is not None: + self.return_policy = return_policy self.account_id = account_id self.name = name if tiers is not None: @@ -158,12 +166,14 @@ def __init__(self, id=None, created=None, title=None, description=None, subscrib self.can_update_tier_expiration_policy = can_update_tier_expiration_policy if can_upgrade_to_advanced_tiers is not None: self.can_upgrade_to_advanced_tiers = can_upgrade_to_advanced_tiers + if can_update_subledgers is not None: + self.can_update_subledgers = can_update_subledgers @property def id(self): """Gets the id of this LoyaltyProgram. # noqa: E501 - The ID of loyalty program. Internal ID of this entity. # noqa: E501 + The ID of loyalty program. # noqa: E501 :return: The id of this LoyaltyProgram. # noqa: E501 :rtype: int @@ -174,7 +184,7 @@ def id(self): def id(self, id): """Sets the id of this LoyaltyProgram. - The ID of loyalty program. Internal ID of this entity. # noqa: E501 + The ID of loyalty program. # noqa: E501 :param id: The id of this LoyaltyProgram. # noqa: E501 :type: int @@ -564,6 +574,35 @@ def card_code_settings(self, card_code_settings): self._card_code_settings = card_code_settings + @property + def return_policy(self): + """Gets the return_policy of this LoyaltyProgram. # noqa: E501 + + The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. # noqa: E501 + + :return: The return_policy of this LoyaltyProgram. # noqa: E501 + :rtype: str + """ + return self._return_policy + + @return_policy.setter + def return_policy(self, return_policy): + """Sets the return_policy of this LoyaltyProgram. + + The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. # noqa: E501 + + :param return_policy: The return_policy of this LoyaltyProgram. # noqa: E501 + :type: str + """ + allowed_values = ["only_pending", "within_balance"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and return_policy not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `return_policy` ({0}), must be one of {1}" # noqa: E501 + .format(return_policy, allowed_values) + ) + + self._return_policy = return_policy + @property def account_id(self): """Gets the account_id of this LoyaltyProgram. # noqa: E501 @@ -782,6 +821,29 @@ def can_upgrade_to_advanced_tiers(self, can_upgrade_to_advanced_tiers): self._can_upgrade_to_advanced_tiers = can_upgrade_to_advanced_tiers + @property + def can_update_subledgers(self): + """Gets the can_update_subledgers of this LoyaltyProgram. # noqa: E501 + + `True` if the `allowSubledger` property can be updated in the loyalty program. # noqa: E501 + + :return: The can_update_subledgers of this LoyaltyProgram. # noqa: E501 + :rtype: bool + """ + return self._can_update_subledgers + + @can_update_subledgers.setter + def can_update_subledgers(self, can_update_subledgers): + """Sets the can_update_subledgers of this LoyaltyProgram. + + `True` if the `allowSubledger` property can be updated in the loyalty program. # noqa: E501 + + :param can_update_subledgers: The can_update_subledgers of this LoyaltyProgram. # noqa: E501 + :type: bool + """ + + self._can_update_subledgers = can_update_subledgers + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/loyalty_program_balance.py b/talon_one/models/loyalty_program_balance.py index 000e0b2..8bc8065 100644 --- a/talon_one/models/loyalty_program_balance.py +++ b/talon_one/models/loyalty_program_balance.py @@ -176,7 +176,7 @@ def spent_balance(self, spent_balance): def tentative_current_balance(self): """Gets the tentative_current_balance of this LoyaltyProgramBalance. # noqa: E501 - 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. # noqa: E501 + The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. # noqa: E501 :return: The tentative_current_balance of this LoyaltyProgramBalance. # noqa: E501 :rtype: float @@ -187,7 +187,7 @@ def tentative_current_balance(self): def tentative_current_balance(self, tentative_current_balance): """Sets the tentative_current_balance of this LoyaltyProgramBalance. - 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. # noqa: E501 + The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. # noqa: E501 :param tentative_current_balance: The tentative_current_balance of this LoyaltyProgramBalance. # noqa: E501 :type: float @@ -201,7 +201,7 @@ def tentative_current_balance(self, tentative_current_balance): def tentative_pending_balance(self): """Gets the tentative_pending_balance of this LoyaltyProgramBalance. # noqa: E501 - 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. # noqa: E501 + The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. # noqa: E501 :return: The tentative_pending_balance of this LoyaltyProgramBalance. # noqa: E501 :rtype: float @@ -212,7 +212,7 @@ def tentative_pending_balance(self): def tentative_pending_balance(self, tentative_pending_balance): """Sets the tentative_pending_balance of this LoyaltyProgramBalance. - 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. # noqa: E501 + The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value. **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. # noqa: E501 :param tentative_pending_balance: The tentative_pending_balance of this LoyaltyProgramBalance. # noqa: E501 :type: float diff --git a/talon_one/models/loyalty_program_entity.py b/talon_one/models/loyalty_program_entity.py index 6187cc8..86fcf71 100644 --- a/talon_one/models/loyalty_program_entity.py +++ b/talon_one/models/loyalty_program_entity.py @@ -33,23 +33,33 @@ class LoyaltyProgramEntity(object): and the value is json key in definition. """ openapi_types = { - 'program_id': 'int' + 'program_id': 'int', + 'program_name': 'str', + 'program_title': 'str' } attribute_map = { - 'program_id': 'programID' + 'program_id': 'programID', + 'program_name': 'programName', + 'program_title': 'programTitle' } - def __init__(self, program_id=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, program_id=None, program_name=None, program_title=None, local_vars_configuration=None): # noqa: E501 """LoyaltyProgramEntity - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration self._program_id = None + self._program_name = None + self._program_title = None self.discriminator = None self.program_id = program_id + if program_name is not None: + self.program_name = program_name + if program_title is not None: + self.program_title = program_title @property def program_id(self): @@ -76,6 +86,52 @@ def program_id(self, program_id): self._program_id = program_id + @property + def program_name(self): + """Gets the program_name of this LoyaltyProgramEntity. # noqa: E501 + + The integration name of the loyalty program that owns this entity. # noqa: E501 + + :return: The program_name of this LoyaltyProgramEntity. # noqa: E501 + :rtype: str + """ + return self._program_name + + @program_name.setter + def program_name(self, program_name): + """Sets the program_name of this LoyaltyProgramEntity. + + The integration name of the loyalty program that owns this entity. # noqa: E501 + + :param program_name: The program_name of this LoyaltyProgramEntity. # noqa: E501 + :type: str + """ + + self._program_name = program_name + + @property + def program_title(self): + """Gets the program_title of this LoyaltyProgramEntity. # noqa: E501 + + The Campaign Manager-displayed name of the loyalty program that owns this entity. # noqa: E501 + + :return: The program_title of this LoyaltyProgramEntity. # noqa: E501 + :rtype: str + """ + return self._program_title + + @program_title.setter + def program_title(self, program_title): + """Sets the program_title of this LoyaltyProgramEntity. + + The Campaign Manager-displayed name of the loyalty program that owns this entity. # noqa: E501 + + :param program_title: The program_title of this LoyaltyProgramEntity. # noqa: E501 + :type: str + """ + + self._program_title = program_title + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/loyalty_program_transaction.py b/talon_one/models/loyalty_program_transaction.py index b565c3e..5d1bc0a 100644 --- a/talon_one/models/loyalty_program_transaction.py +++ b/talon_one/models/loyalty_program_transaction.py @@ -412,6 +412,9 @@ def card_identifier(self, card_identifier): if (self.local_vars_configuration.client_side_validation and card_identifier is not None and len(card_identifier) > 108): raise ValueError("Invalid value for `card_identifier`, length must be less than or equal to `108`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + card_identifier is not None and not re.search(r'^[A-Za-z0-9_-]*$', card_identifier)): # noqa: E501 + raise ValueError(r"Invalid value for `card_identifier`, must be a follow pattern or equal to `/^[A-Za-z0-9_-]*$/`") # noqa: E501 self._card_identifier = card_identifier diff --git a/talon_one/models/loyalty_tier.py b/talon_one/models/loyalty_tier.py index 2991e76..9e6561f 100644 --- a/talon_one/models/loyalty_tier.py +++ b/talon_one/models/loyalty_tier.py @@ -36,6 +36,8 @@ class LoyaltyTier(object): 'id': 'int', 'created': 'datetime', 'program_id': 'int', + 'program_name': 'str', + 'program_title': 'str', 'name': 'str', 'min_points': 'float' } @@ -44,11 +46,13 @@ class LoyaltyTier(object): 'id': 'id', 'created': 'created', 'program_id': 'programID', + 'program_name': 'programName', + 'program_title': 'programTitle', 'name': 'name', 'min_points': 'minPoints' } - def __init__(self, id=None, created=None, program_id=None, name=None, min_points=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, id=None, created=None, program_id=None, program_name=None, program_title=None, name=None, min_points=None, local_vars_configuration=None): # noqa: E501 """LoyaltyTier - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -57,6 +61,8 @@ def __init__(self, id=None, created=None, program_id=None, name=None, min_points self._id = None self._created = None self._program_id = None + self._program_name = None + self._program_title = None self._name = None self._min_points = None self.discriminator = None @@ -64,6 +70,10 @@ def __init__(self, id=None, created=None, program_id=None, name=None, min_points self.id = id self.created = created self.program_id = program_id + if program_name is not None: + self.program_name = program_name + if program_title is not None: + self.program_title = program_title self.name = name self.min_points = min_points @@ -142,11 +152,57 @@ def program_id(self, program_id): self._program_id = program_id + @property + def program_name(self): + """Gets the program_name of this LoyaltyTier. # noqa: E501 + + The integration name of the loyalty program that owns this entity. # noqa: E501 + + :return: The program_name of this LoyaltyTier. # noqa: E501 + :rtype: str + """ + return self._program_name + + @program_name.setter + def program_name(self, program_name): + """Sets the program_name of this LoyaltyTier. + + The integration name of the loyalty program that owns this entity. # noqa: E501 + + :param program_name: The program_name of this LoyaltyTier. # noqa: E501 + :type: str + """ + + self._program_name = program_name + + @property + def program_title(self): + """Gets the program_title of this LoyaltyTier. # noqa: E501 + + The Campaign Manager-displayed name of the loyalty program that owns this entity. # noqa: E501 + + :return: The program_title of this LoyaltyTier. # noqa: E501 + :rtype: str + """ + return self._program_title + + @program_title.setter + def program_title(self, program_title): + """Sets the program_title of this LoyaltyTier. + + The Campaign Manager-displayed name of the loyalty program that owns this entity. # noqa: E501 + + :param program_title: The program_title of this LoyaltyTier. # noqa: E501 + :type: str + """ + + self._program_title = program_title + @property def name(self): """Gets the name of this LoyaltyTier. # noqa: E501 - The name of the tier # noqa: E501 + The name of the tier. # noqa: E501 :return: The name of this LoyaltyTier. # noqa: E501 :rtype: str @@ -157,7 +213,7 @@ def name(self): def name(self, name): """Sets the name of this LoyaltyTier. - The name of the tier # noqa: E501 + The name of the tier. # noqa: E501 :param name: The name of this LoyaltyTier. # noqa: E501 :type: str @@ -171,7 +227,7 @@ def name(self, name): def min_points(self): """Gets the min_points of this LoyaltyTier. # noqa: E501 - The minimum amount of points required to be eligible for the tier. # noqa: E501 + The minimum amount of points required to enter the tier. # noqa: E501 :return: The min_points of this LoyaltyTier. # noqa: E501 :rtype: float @@ -182,7 +238,7 @@ def min_points(self): def min_points(self, min_points): """Sets the min_points of this LoyaltyTier. - The minimum amount of points required to be eligible for the tier. # noqa: E501 + The minimum amount of points required to enter the tier. # noqa: E501 :param min_points: The min_points of this LoyaltyTier. # noqa: E501 :type: float diff --git a/talon_one/models/message_log_entry.py b/talon_one/models/message_log_entry.py index b845f87..020a496 100644 --- a/talon_one/models/message_log_entry.py +++ b/talon_one/models/message_log_entry.py @@ -38,12 +38,16 @@ class MessageLogEntry(object): 'change_type': 'str', 'notification_id': 'int', 'notification_name': 'str', + 'webhook_id': 'int', + 'webhook_name': 'str', 'request': 'MessageLogRequest', 'response': 'MessageLogResponse', 'created_at': 'datetime', 'entity_type': 'str', + 'url': 'str', 'application_id': 'int', - 'loyalty_program_id': 'int' + 'loyalty_program_id': 'int', + 'campaign_id': 'int' } attribute_map = { @@ -52,15 +56,19 @@ class MessageLogEntry(object): 'change_type': 'changeType', 'notification_id': 'notificationId', 'notification_name': 'notificationName', + 'webhook_id': 'webhookId', + 'webhook_name': 'webhookName', 'request': 'request', 'response': 'response', 'created_at': 'createdAt', 'entity_type': 'entityType', + 'url': 'url', 'application_id': 'applicationId', - 'loyalty_program_id': 'loyaltyProgramId' + 'loyalty_program_id': 'loyaltyProgramId', + 'campaign_id': 'campaignId' } - def __init__(self, id=None, service=None, change_type=None, notification_id=None, notification_name=None, request=None, response=None, created_at=None, entity_type=None, application_id=None, loyalty_program_id=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, id=None, service=None, change_type=None, notification_id=None, notification_name=None, webhook_id=None, webhook_name=None, request=None, response=None, created_at=None, entity_type=None, url=None, application_id=None, loyalty_program_id=None, campaign_id=None, local_vars_configuration=None): # noqa: E501 """MessageLogEntry - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -71,12 +79,16 @@ def __init__(self, id=None, service=None, change_type=None, notification_id=None self._change_type = None self._notification_id = None self._notification_name = None + self._webhook_id = None + self._webhook_name = None self._request = None self._response = None self._created_at = None self._entity_type = None + self._url = None self._application_id = None self._loyalty_program_id = None + self._campaign_id = None self.discriminator = None self.id = id @@ -87,17 +99,24 @@ def __init__(self, id=None, service=None, change_type=None, notification_id=None self.notification_id = notification_id if notification_name is not None: self.notification_name = notification_name + if webhook_id is not None: + self.webhook_id = webhook_id + if webhook_name is not None: + self.webhook_name = webhook_name if request is not None: self.request = request if response is not None: self.response = response self.created_at = created_at - if entity_type is not None: - self.entity_type = entity_type + self.entity_type = entity_type + if url is not None: + self.url = url if application_id is not None: self.application_id = application_id if loyalty_program_id is not None: self.loyalty_program_id = loyalty_program_id + if campaign_id is not None: + self.campaign_id = campaign_id @property def id(self): @@ -218,6 +237,52 @@ def notification_name(self, notification_name): self._notification_name = notification_name + @property + def webhook_id(self): + """Gets the webhook_id of this MessageLogEntry. # noqa: E501 + + ID of the webhook. # noqa: E501 + + :return: The webhook_id of this MessageLogEntry. # noqa: E501 + :rtype: int + """ + return self._webhook_id + + @webhook_id.setter + def webhook_id(self, webhook_id): + """Sets the webhook_id of this MessageLogEntry. + + ID of the webhook. # noqa: E501 + + :param webhook_id: The webhook_id of this MessageLogEntry. # noqa: E501 + :type: int + """ + + self._webhook_id = webhook_id + + @property + def webhook_name(self): + """Gets the webhook_name of this MessageLogEntry. # noqa: E501 + + The name of the webhook. # noqa: E501 + + :return: The webhook_name of this MessageLogEntry. # noqa: E501 + :rtype: str + """ + return self._webhook_name + + @webhook_name.setter + def webhook_name(self, webhook_name): + """Sets the webhook_name of this MessageLogEntry. + + The name of the webhook. # noqa: E501 + + :param webhook_name: The webhook_name of this MessageLogEntry. # noqa: E501 + :type: str + """ + + self._webhook_name = webhook_name + @property def request(self): """Gets the request of this MessageLogEntry. # noqa: E501 @@ -289,7 +354,7 @@ def created_at(self, created_at): def entity_type(self): """Gets the entity_type of this MessageLogEntry. # noqa: E501 - The entity type the notification is related to. # noqa: E501 + The entity type the log is related to. # noqa: E501 :return: The entity_type of this MessageLogEntry. # noqa: E501 :rtype: str @@ -300,12 +365,14 @@ def entity_type(self): def entity_type(self, entity_type): """Sets the entity_type of this MessageLogEntry. - The entity type the notification is related to. # noqa: E501 + The entity type the log is related to. # noqa: E501 :param entity_type: The entity_type of this MessageLogEntry. # noqa: E501 :type: str """ - allowed_values = ["application", "loyalty_program"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and entity_type is None: # noqa: E501 + raise ValueError("Invalid value for `entity_type`, must not be `None`") # noqa: E501 + allowed_values = ["application", "loyalty_program", "webhook"] # noqa: E501 if self.local_vars_configuration.client_side_validation and entity_type not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `entity_type` ({0}), must be one of {1}" # noqa: E501 @@ -314,6 +381,29 @@ def entity_type(self, entity_type): self._entity_type = entity_type + @property + def url(self): + """Gets the url of this MessageLogEntry. # noqa: E501 + + The target URL of the request. # noqa: E501 + + :return: The url of this MessageLogEntry. # noqa: E501 + :rtype: str + """ + return self._url + + @url.setter + def url(self, url): + """Sets the url of this MessageLogEntry. + + The target URL of the request. # noqa: E501 + + :param url: The url of this MessageLogEntry. # noqa: E501 + :type: str + """ + + self._url = url + @property def application_id(self): """Gets the application_id of this MessageLogEntry. # noqa: E501 @@ -366,6 +456,32 @@ def loyalty_program_id(self, loyalty_program_id): self._loyalty_program_id = loyalty_program_id + @property + def campaign_id(self): + """Gets the campaign_id of this MessageLogEntry. # noqa: E501 + + Identifier of the campaign. # noqa: E501 + + :return: The campaign_id of this MessageLogEntry. # noqa: E501 + :rtype: int + """ + return self._campaign_id + + @campaign_id.setter + def campaign_id(self, campaign_id): + """Sets the campaign_id of this MessageLogEntry. + + Identifier of the campaign. # noqa: E501 + + :param campaign_id: The campaign_id of this MessageLogEntry. # noqa: E501 + :type: int + """ + if (self.local_vars_configuration.client_side_validation and + campaign_id is not None and campaign_id < 1): # noqa: E501 + raise ValueError("Invalid value for `campaign_id`, must be a value greater than or equal to `1`") # noqa: E501 + + self._campaign_id = campaign_id + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/new_application_cif.py b/talon_one/models/new_application_cif.py new file mode 100644 index 0000000..475f4ba --- /dev/null +++ b/talon_one/models/new_application_cif.py @@ -0,0 +1,263 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class NewApplicationCIF(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'name': 'str', + 'description': 'str', + 'active_expression_id': 'int', + 'modified_by': 'int', + 'created_by': 'int', + 'modified': 'datetime' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'active_expression_id': 'activeExpressionId', + 'modified_by': 'modifiedBy', + 'created_by': 'createdBy', + 'modified': 'modified' + } + + def __init__(self, name=None, description=None, active_expression_id=None, modified_by=None, created_by=None, modified=None, local_vars_configuration=None): # noqa: E501 + """NewApplicationCIF - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._name = None + self._description = None + self._active_expression_id = None + self._modified_by = None + self._created_by = None + self._modified = None + self.discriminator = None + + self.name = name + if description is not None: + self.description = description + if active_expression_id is not None: + self.active_expression_id = active_expression_id + if modified_by is not None: + self.modified_by = modified_by + if created_by is not None: + self.created_by = created_by + if modified is not None: + self.modified = modified + + @property + def name(self): + """Gets the name of this NewApplicationCIF. # noqa: E501 + + The name of the Application cart item filter used in API requests. # noqa: E501 + + :return: The name of this NewApplicationCIF. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this NewApplicationCIF. + + The name of the Application cart item filter used in API requests. # noqa: E501 + + :param name: The name of this NewApplicationCIF. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and name is None: # noqa: E501 + raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501 + + self._name = name + + @property + def description(self): + """Gets the description of this NewApplicationCIF. # noqa: E501 + + A short description of the Application cart item filter. # noqa: E501 + + :return: The description of this NewApplicationCIF. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this NewApplicationCIF. + + A short description of the Application cart item filter. # noqa: E501 + + :param description: The description of this NewApplicationCIF. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def active_expression_id(self): + """Gets the active_expression_id of this NewApplicationCIF. # noqa: E501 + + The ID of the expression that the Application cart item filter uses. # noqa: E501 + + :return: The active_expression_id of this NewApplicationCIF. # noqa: E501 + :rtype: int + """ + return self._active_expression_id + + @active_expression_id.setter + def active_expression_id(self, active_expression_id): + """Sets the active_expression_id of this NewApplicationCIF. + + The ID of the expression that the Application cart item filter uses. # noqa: E501 + + :param active_expression_id: The active_expression_id of this NewApplicationCIF. # noqa: E501 + :type: int + """ + + self._active_expression_id = active_expression_id + + @property + def modified_by(self): + """Gets the modified_by of this NewApplicationCIF. # noqa: E501 + + The ID of the user who last updated the Application cart item filter. # noqa: E501 + + :return: The modified_by of this NewApplicationCIF. # noqa: E501 + :rtype: int + """ + return self._modified_by + + @modified_by.setter + def modified_by(self, modified_by): + """Sets the modified_by of this NewApplicationCIF. + + The ID of the user who last updated the Application cart item filter. # noqa: E501 + + :param modified_by: The modified_by of this NewApplicationCIF. # noqa: E501 + :type: int + """ + + self._modified_by = modified_by + + @property + def created_by(self): + """Gets the created_by of this NewApplicationCIF. # noqa: E501 + + The ID of the user who created the Application cart item filter. # noqa: E501 + + :return: The created_by of this NewApplicationCIF. # noqa: E501 + :rtype: int + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """Sets the created_by of this NewApplicationCIF. + + The ID of the user who created the Application cart item filter. # noqa: E501 + + :param created_by: The created_by of this NewApplicationCIF. # noqa: E501 + :type: int + """ + + self._created_by = created_by + + @property + def modified(self): + """Gets the modified of this NewApplicationCIF. # noqa: E501 + + Timestamp of the most recent update to the Application cart item filter. # noqa: E501 + + :return: The modified of this NewApplicationCIF. # noqa: E501 + :rtype: datetime + """ + return self._modified + + @modified.setter + def modified(self, modified): + """Sets the modified of this NewApplicationCIF. + + Timestamp of the most recent update to the Application cart item filter. # noqa: E501 + + :param modified: The modified of this NewApplicationCIF. # noqa: E501 + :type: datetime + """ + + self._modified = modified + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, NewApplicationCIF): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, NewApplicationCIF): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/new_application_cif_expression.py b/talon_one/models/new_application_cif_expression.py new file mode 100644 index 0000000..3df3a20 --- /dev/null +++ b/talon_one/models/new_application_cif_expression.py @@ -0,0 +1,178 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class NewApplicationCIFExpression(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'cart_item_filter_id': 'int', + 'created_by': 'int', + 'expression': 'list[object]' + } + + attribute_map = { + 'cart_item_filter_id': 'cartItemFilterId', + 'created_by': 'createdBy', + 'expression': 'expression' + } + + def __init__(self, cart_item_filter_id=None, created_by=None, expression=None, local_vars_configuration=None): # noqa: E501 + """NewApplicationCIFExpression - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._cart_item_filter_id = None + self._created_by = None + self._expression = None + self.discriminator = None + + if cart_item_filter_id is not None: + self.cart_item_filter_id = cart_item_filter_id + if created_by is not None: + self.created_by = created_by + if expression is not None: + self.expression = expression + + @property + def cart_item_filter_id(self): + """Gets the cart_item_filter_id of this NewApplicationCIFExpression. # noqa: E501 + + The ID of the Application cart item filter. # noqa: E501 + + :return: The cart_item_filter_id of this NewApplicationCIFExpression. # noqa: E501 + :rtype: int + """ + return self._cart_item_filter_id + + @cart_item_filter_id.setter + def cart_item_filter_id(self, cart_item_filter_id): + """Sets the cart_item_filter_id of this NewApplicationCIFExpression. + + The ID of the Application cart item filter. # noqa: E501 + + :param cart_item_filter_id: The cart_item_filter_id of this NewApplicationCIFExpression. # noqa: E501 + :type: int + """ + + self._cart_item_filter_id = cart_item_filter_id + + @property + def created_by(self): + """Gets the created_by of this NewApplicationCIFExpression. # noqa: E501 + + The ID of the user who created the Application cart item filter. # noqa: E501 + + :return: The created_by of this NewApplicationCIFExpression. # noqa: E501 + :rtype: int + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """Sets the created_by of this NewApplicationCIFExpression. + + The ID of the user who created the Application cart item filter. # noqa: E501 + + :param created_by: The created_by of this NewApplicationCIFExpression. # noqa: E501 + :type: int + """ + + self._created_by = created_by + + @property + def expression(self): + """Gets the expression of this NewApplicationCIFExpression. # noqa: E501 + + Arbitrary additional JSON data associated with the Application cart item filter. # noqa: E501 + + :return: The expression of this NewApplicationCIFExpression. # noqa: E501 + :rtype: list[object] + """ + return self._expression + + @expression.setter + def expression(self, expression): + """Sets the expression of this NewApplicationCIFExpression. + + Arbitrary additional JSON data associated with the Application cart item filter. # noqa: E501 + + :param expression: The expression of this NewApplicationCIFExpression. # noqa: E501 + :type: list[object] + """ + + self._expression = expression + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, NewApplicationCIFExpression): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, NewApplicationCIFExpression): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/new_campaign_store_budget.py b/talon_one/models/new_campaign_store_budget.py new file mode 100644 index 0000000..cd7973f --- /dev/null +++ b/talon_one/models/new_campaign_store_budget.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class NewCampaignStoreBudget(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'action': 'str', + 'store_limits': 'list[NewCampaignStoreBudgetStoreLimit]', + 'period': 'str' + } + + attribute_map = { + 'action': 'action', + 'store_limits': 'storeLimits', + 'period': 'period' + } + + def __init__(self, action=None, store_limits=None, period=None, local_vars_configuration=None): # noqa: E501 + """NewCampaignStoreBudget - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._action = None + self._store_limits = None + self._period = None + self.discriminator = None + + self.action = action + self.store_limits = store_limits + if period is not None: + self.period = period + + @property + def action(self): + """Gets the action of this NewCampaignStoreBudget. # noqa: E501 + + + :return: The action of this NewCampaignStoreBudget. # noqa: E501 + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """Sets the action of this NewCampaignStoreBudget. + + + :param action: The action of this NewCampaignStoreBudget. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and action is None: # noqa: E501 + raise ValueError("Invalid value for `action`, must not be `None`") # noqa: E501 + allowed_values = ["setDiscount"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and action not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `action` ({0}), must be one of {1}" # noqa: E501 + .format(action, allowed_values) + ) + + self._action = action + + @property + def store_limits(self): + """Gets the store_limits of this NewCampaignStoreBudget. # noqa: E501 + + The set of budget limits for stores linked to the campaign. # noqa: E501 + + :return: The store_limits of this NewCampaignStoreBudget. # noqa: E501 + :rtype: list[NewCampaignStoreBudgetStoreLimit] + """ + return self._store_limits + + @store_limits.setter + def store_limits(self, store_limits): + """Sets the store_limits of this NewCampaignStoreBudget. + + The set of budget limits for stores linked to the campaign. # noqa: E501 + + :param store_limits: The store_limits of this NewCampaignStoreBudget. # noqa: E501 + :type: list[NewCampaignStoreBudgetStoreLimit] + """ + if self.local_vars_configuration.client_side_validation and store_limits is None: # noqa: E501 + raise ValueError("Invalid value for `store_limits`, must not be `None`") # noqa: E501 + + self._store_limits = store_limits + + @property + def period(self): + """Gets the period of this NewCampaignStoreBudget. # noqa: E501 + + + :return: The period of this NewCampaignStoreBudget. # noqa: E501 + :rtype: str + """ + return self._period + + @period.setter + def period(self, period): + """Sets the period of this NewCampaignStoreBudget. + + + :param period: The period of this NewCampaignStoreBudget. # noqa: E501 + :type: str + """ + allowed_values = ["daily", "weekly", "monthly", "yearly"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and period not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `period` ({0}), must be one of {1}" # noqa: E501 + .format(period, allowed_values) + ) + + self._period = period + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, NewCampaignStoreBudget): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, NewCampaignStoreBudget): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/new_campaign_store_budget_store_limit.py b/talon_one/models/new_campaign_store_budget_store_limit.py new file mode 100644 index 0000000..2ae7fcd --- /dev/null +++ b/talon_one/models/new_campaign_store_budget_store_limit.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class NewCampaignStoreBudgetStoreLimit(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'store_id': 'int', + 'limit': 'float' + } + + attribute_map = { + 'store_id': 'storeId', + 'limit': 'limit' + } + + def __init__(self, store_id=None, limit=None, local_vars_configuration=None): # noqa: E501 + """NewCampaignStoreBudgetStoreLimit - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._store_id = None + self._limit = None + self.discriminator = None + + self.store_id = store_id + self.limit = limit + + @property + def store_id(self): + """Gets the store_id of this NewCampaignStoreBudgetStoreLimit. # noqa: E501 + + The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. # noqa: E501 + + :return: The store_id of this NewCampaignStoreBudgetStoreLimit. # noqa: E501 + :rtype: int + """ + return self._store_id + + @store_id.setter + def store_id(self, store_id): + """Sets the store_id of this NewCampaignStoreBudgetStoreLimit. + + The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint. # noqa: E501 + + :param store_id: The store_id of this NewCampaignStoreBudgetStoreLimit. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and store_id is None: # noqa: E501 + raise ValueError("Invalid value for `store_id`, must not be `None`") # noqa: E501 + + self._store_id = store_id + + @property + def limit(self): + """Gets the limit of this NewCampaignStoreBudgetStoreLimit. # noqa: E501 + + The value to set for the limit. # noqa: E501 + + :return: The limit of this NewCampaignStoreBudgetStoreLimit. # noqa: E501 + :rtype: float + """ + return self._limit + + @limit.setter + def limit(self, limit): + """Sets the limit of this NewCampaignStoreBudgetStoreLimit. + + The value to set for the limit. # noqa: E501 + + :param limit: The limit of this NewCampaignStoreBudgetStoreLimit. # noqa: E501 + :type: float + """ + if self.local_vars_configuration.client_side_validation and limit is None: # noqa: E501 + raise ValueError("Invalid value for `limit`, must not be `None`") # noqa: E501 + + self._limit = limit + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, NewCampaignStoreBudgetStoreLimit): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, NewCampaignStoreBudgetStoreLimit): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/new_campaign_template.py b/talon_one/models/new_campaign_template.py index c2a9941..3563795 100644 --- a/talon_one/models/new_campaign_template.py +++ b/talon_one/models/new_campaign_template.py @@ -42,6 +42,7 @@ class NewCampaignTemplate(object): 'tags': 'list[str]', 'features': 'list[str]', 'coupon_settings': 'CodeGeneratorSettings', + 'coupon_reservation_settings': 'CampaignTemplateCouponReservationSettings', 'referral_settings': 'CodeGeneratorSettings', 'limits': 'list[TemplateLimitConfig]', 'template_params': 'list[CampaignTemplateParams]', @@ -60,6 +61,7 @@ class NewCampaignTemplate(object): 'tags': 'tags', 'features': 'features', 'coupon_settings': 'couponSettings', + 'coupon_reservation_settings': 'couponReservationSettings', 'referral_settings': 'referralSettings', 'limits': 'limits', 'template_params': 'templateParams', @@ -68,7 +70,7 @@ class NewCampaignTemplate(object): 'campaign_type': 'campaignType' } - def __init__(self, name=None, description=None, instructions=None, campaign_attributes=None, coupon_attributes=None, state=None, tags=None, features=None, coupon_settings=None, referral_settings=None, limits=None, template_params=None, campaign_collections=None, default_campaign_group_id=None, campaign_type='advanced', local_vars_configuration=None): # noqa: E501 + def __init__(self, name=None, description=None, instructions=None, campaign_attributes=None, coupon_attributes=None, state=None, tags=None, features=None, coupon_settings=None, coupon_reservation_settings=None, referral_settings=None, limits=None, template_params=None, campaign_collections=None, default_campaign_group_id=None, campaign_type='advanced', local_vars_configuration=None): # noqa: E501 """NewCampaignTemplate - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -83,6 +85,7 @@ def __init__(self, name=None, description=None, instructions=None, campaign_attr self._tags = None self._features = None self._coupon_settings = None + self._coupon_reservation_settings = None self._referral_settings = None self._limits = None self._template_params = None @@ -105,6 +108,8 @@ def __init__(self, name=None, description=None, instructions=None, campaign_attr self.features = features if coupon_settings is not None: self.coupon_settings = coupon_settings + if coupon_reservation_settings is not None: + self.coupon_reservation_settings = coupon_reservation_settings if referral_settings is not None: self.referral_settings = referral_settings if limits is not None: @@ -347,6 +352,27 @@ def coupon_settings(self, coupon_settings): self._coupon_settings = coupon_settings + @property + def coupon_reservation_settings(self): + """Gets the coupon_reservation_settings of this NewCampaignTemplate. # noqa: E501 + + + :return: The coupon_reservation_settings of this NewCampaignTemplate. # noqa: E501 + :rtype: CampaignTemplateCouponReservationSettings + """ + return self._coupon_reservation_settings + + @coupon_reservation_settings.setter + def coupon_reservation_settings(self, coupon_reservation_settings): + """Sets the coupon_reservation_settings of this NewCampaignTemplate. + + + :param coupon_reservation_settings: The coupon_reservation_settings of this NewCampaignTemplate. # noqa: E501 + :type: CampaignTemplateCouponReservationSettings + """ + + self._coupon_reservation_settings = coupon_reservation_settings + @property def referral_settings(self): """Gets the referral_settings of this NewCampaignTemplate. # noqa: E501 diff --git a/talon_one/models/new_customer_session_v2.py b/talon_one/models/new_customer_session_v2.py index 412664c..d49eefe 100644 --- a/talon_one/models/new_customer_session_v2.py +++ b/talon_one/models/new_customer_session_v2.py @@ -181,7 +181,7 @@ def evaluable_campaign_ids(self, evaluable_campaign_ids): def coupon_codes(self): """Gets the coupon_codes of this NewCustomerSessionV2. # noqa: E501 - 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. # noqa: E501 + Any coupon codes entered. **Important - for requests only**: - 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. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, omit the parameter entirely. # noqa: E501 :return: The coupon_codes of this NewCustomerSessionV2. # noqa: E501 :rtype: list[str] @@ -192,7 +192,7 @@ def coupon_codes(self): def coupon_codes(self, coupon_codes): """Sets the coupon_codes of this NewCustomerSessionV2. - 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. # noqa: E501 + Any coupon codes entered. **Important - for requests only**: - 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. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, omit the parameter entirely. # noqa: E501 :param coupon_codes: The coupon_codes of this NewCustomerSessionV2. # noqa: E501 :type: list[str] @@ -204,7 +204,7 @@ def coupon_codes(self, coupon_codes): def referral_code(self): """Gets the referral_code of this NewCustomerSessionV2. # noqa: E501 - 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. # noqa: E501 + Any referral code entered. **Important - for requests only**: - 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. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, omit the parameter entirely. # noqa: E501 :return: The referral_code of this NewCustomerSessionV2. # noqa: E501 :rtype: str @@ -215,7 +215,7 @@ def referral_code(self): def referral_code(self, referral_code): """Sets the referral_code of this NewCustomerSessionV2. - 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. # noqa: E501 + Any referral code entered. **Important - for requests only**: - 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. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, omit the parameter entirely. # noqa: E501 :param referral_code: The referral_code of this NewCustomerSessionV2. # noqa: E501 :type: str @@ -328,7 +328,7 @@ def additional_costs(self, additional_costs): def identifiers(self): """Gets the identifiers of this NewCustomerSessionV2. # noqa: E501 - 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). # noqa: E501 + 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). - We recommend passing an anonymized (hashed) version of the identifier value. # noqa: E501 :return: The identifiers of this NewCustomerSessionV2. # noqa: E501 :rtype: list[str] @@ -339,7 +339,7 @@ def identifiers(self): def identifiers(self, identifiers): """Sets the identifiers of this NewCustomerSessionV2. - 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). # noqa: E501 + 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). - We recommend passing an anonymized (hashed) version of the identifier value. # noqa: E501 :param identifiers: The identifiers of this NewCustomerSessionV2. # noqa: E501 :type: list[str] diff --git a/talon_one/models/new_loyalty_program.py b/talon_one/models/new_loyalty_program.py index 8ea9c12..cc67190 100644 --- a/talon_one/models/new_loyalty_program.py +++ b/talon_one/models/new_loyalty_program.py @@ -47,6 +47,7 @@ class NewLoyaltyProgram(object): 'tiers_expire_in': 'str', 'tiers_downgrade_policy': 'str', 'card_code_settings': 'CodeGeneratorSettings', + 'return_policy': 'str', 'name': 'str', 'tiers': 'list[NewLoyaltyTier]', 'timezone': 'str', @@ -68,13 +69,14 @@ class NewLoyaltyProgram(object): 'tiers_expire_in': 'tiersExpireIn', 'tiers_downgrade_policy': 'tiersDowngradePolicy', 'card_code_settings': 'cardCodeSettings', + 'return_policy': 'returnPolicy', 'name': 'name', 'tiers': 'tiers', 'timezone': 'timezone', 'card_based': 'cardBased' } - def __init__(self, title=None, description=None, subscribed_applications=None, default_validity=None, default_pending=None, allow_subledger=None, users_per_card_limit=None, sandbox=None, program_join_policy=None, tiers_expiration_policy=None, tier_cycle_start_date=None, tiers_expire_in=None, tiers_downgrade_policy=None, card_code_settings=None, name=None, tiers=None, timezone=None, card_based=False, local_vars_configuration=None): # noqa: E501 + def __init__(self, title=None, description=None, subscribed_applications=None, default_validity=None, default_pending=None, allow_subledger=None, users_per_card_limit=None, sandbox=None, program_join_policy=None, tiers_expiration_policy=None, tier_cycle_start_date=None, tiers_expire_in=None, tiers_downgrade_policy=None, card_code_settings=None, return_policy=None, name=None, tiers=None, timezone=None, card_based=False, local_vars_configuration=None): # noqa: E501 """NewLoyaltyProgram - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -94,6 +96,7 @@ def __init__(self, title=None, description=None, subscribed_applications=None, d self._tiers_expire_in = None self._tiers_downgrade_policy = None self._card_code_settings = None + self._return_policy = None self._name = None self._tiers = None self._timezone = None @@ -123,6 +126,8 @@ def __init__(self, title=None, description=None, subscribed_applications=None, d self.tiers_downgrade_policy = tiers_downgrade_policy if card_code_settings is not None: self.card_code_settings = card_code_settings + if return_policy is not None: + self.return_policy = return_policy self.name = name if tiers is not None: self.tiers = tiers @@ -480,6 +485,35 @@ def card_code_settings(self, card_code_settings): self._card_code_settings = card_code_settings + @property + def return_policy(self): + """Gets the return_policy of this NewLoyaltyProgram. # noqa: E501 + + The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. # noqa: E501 + + :return: The return_policy of this NewLoyaltyProgram. # noqa: E501 + :rtype: str + """ + return self._return_policy + + @return_policy.setter + def return_policy(self, return_policy): + """Sets the return_policy of this NewLoyaltyProgram. + + The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. # noqa: E501 + + :param return_policy: The return_policy of this NewLoyaltyProgram. # noqa: E501 + :type: str + """ + allowed_values = ["only_pending", "within_balance"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and return_policy not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `return_policy` ({0}), must be one of {1}" # noqa: E501 + .format(return_policy, allowed_values) + ) + + self._return_policy = return_policy + @property def name(self): """Gets the name of this NewLoyaltyProgram. # noqa: E501 diff --git a/talon_one/models/new_loyalty_tier.py b/talon_one/models/new_loyalty_tier.py index 7157554..904ec48 100644 --- a/talon_one/models/new_loyalty_tier.py +++ b/talon_one/models/new_loyalty_tier.py @@ -59,7 +59,7 @@ def __init__(self, name=None, min_points=None, local_vars_configuration=None): def name(self): """Gets the name of this NewLoyaltyTier. # noqa: E501 - The name of the tier # noqa: E501 + The name of the tier. # noqa: E501 :return: The name of this NewLoyaltyTier. # noqa: E501 :rtype: str @@ -70,7 +70,7 @@ def name(self): def name(self, name): """Sets the name of this NewLoyaltyTier. - The name of the tier # noqa: E501 + The name of the tier. # noqa: E501 :param name: The name of this NewLoyaltyTier. # noqa: E501 :type: str @@ -84,7 +84,7 @@ def name(self, name): def min_points(self): """Gets the min_points of this NewLoyaltyTier. # noqa: E501 - The minimum amount of points required to be eligible for the tier. # noqa: E501 + The minimum amount of points required to enter the tier. # noqa: E501 :return: The min_points of this NewLoyaltyTier. # noqa: E501 :rtype: float @@ -95,7 +95,7 @@ def min_points(self): def min_points(self, min_points): """Sets the min_points of this NewLoyaltyTier. - The minimum amount of points required to be eligible for the tier. # noqa: E501 + The minimum amount of points required to enter the tier. # noqa: E501 :param min_points: The min_points of this NewLoyaltyTier. # noqa: E501 :type: float diff --git a/talon_one/models/new_revision_version.py b/talon_one/models/new_revision_version.py new file mode 100644 index 0000000..3211ecb --- /dev/null +++ b/talon_one/models/new_revision_version.py @@ -0,0 +1,405 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class NewRevisionVersion(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'name': 'str', + 'start_time': 'datetime', + 'end_time': 'datetime', + 'attributes': 'object', + 'description': 'str', + 'active_ruleset_id': 'int', + 'tags': 'list[str]', + 'coupon_settings': 'CodeGeneratorSettings', + 'referral_settings': 'CodeGeneratorSettings', + 'limits': 'list[LimitConfig]', + 'features': 'list[str]' + } + + attribute_map = { + 'name': 'name', + 'start_time': 'startTime', + 'end_time': 'endTime', + 'attributes': 'attributes', + 'description': 'description', + 'active_ruleset_id': 'activeRulesetId', + 'tags': 'tags', + 'coupon_settings': 'couponSettings', + 'referral_settings': 'referralSettings', + 'limits': 'limits', + 'features': 'features' + } + + def __init__(self, name=None, start_time=None, end_time=None, attributes=None, description=None, active_ruleset_id=None, tags=None, coupon_settings=None, referral_settings=None, limits=None, features=None, local_vars_configuration=None): # noqa: E501 + """NewRevisionVersion - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._name = None + self._start_time = None + self._end_time = None + self._attributes = None + self._description = None + self._active_ruleset_id = None + self._tags = None + self._coupon_settings = None + self._referral_settings = None + self._limits = None + self._features = None + self.discriminator = None + + if name is not None: + self.name = name + self.start_time = start_time + self.end_time = end_time + if attributes is not None: + self.attributes = attributes + self.description = description + self.active_ruleset_id = active_ruleset_id + if tags is not None: + self.tags = tags + if coupon_settings is not None: + self.coupon_settings = coupon_settings + if referral_settings is not None: + self.referral_settings = referral_settings + if limits is not None: + self.limits = limits + if features is not None: + self.features = features + + @property + def name(self): + """Gets the name of this NewRevisionVersion. # noqa: E501 + + A user-facing name for this campaign. # noqa: E501 + + :return: The name of this NewRevisionVersion. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this NewRevisionVersion. + + A user-facing name for this campaign. # noqa: E501 + + :param name: The name of this NewRevisionVersion. # noqa: E501 + :type: str + """ + if (self.local_vars_configuration.client_side_validation and + name is not None and len(name) < 1): + raise ValueError("Invalid value for `name`, length must be greater than or equal to `1`") # noqa: E501 + + self._name = name + + @property + def start_time(self): + """Gets the start_time of this NewRevisionVersion. # noqa: E501 + + Timestamp when the campaign will become active. # noqa: E501 + + :return: The start_time of this NewRevisionVersion. # noqa: E501 + :rtype: datetime + """ + return self._start_time + + @start_time.setter + def start_time(self, start_time): + """Sets the start_time of this NewRevisionVersion. + + Timestamp when the campaign will become active. # noqa: E501 + + :param start_time: The start_time of this NewRevisionVersion. # noqa: E501 + :type: datetime + """ + + self._start_time = start_time + + @property + def end_time(self): + """Gets the end_time of this NewRevisionVersion. # noqa: E501 + + Timestamp when the campaign will become inactive. # noqa: E501 + + :return: The end_time of this NewRevisionVersion. # noqa: E501 + :rtype: datetime + """ + return self._end_time + + @end_time.setter + def end_time(self, end_time): + """Sets the end_time of this NewRevisionVersion. + + Timestamp when the campaign will become inactive. # noqa: E501 + + :param end_time: The end_time of this NewRevisionVersion. # noqa: E501 + :type: datetime + """ + + self._end_time = end_time + + @property + def attributes(self): + """Gets the attributes of this NewRevisionVersion. # noqa: E501 + + Arbitrary properties associated with this campaign. # noqa: E501 + + :return: The attributes of this NewRevisionVersion. # noqa: E501 + :rtype: object + """ + return self._attributes + + @attributes.setter + def attributes(self, attributes): + """Sets the attributes of this NewRevisionVersion. + + Arbitrary properties associated with this campaign. # noqa: E501 + + :param attributes: The attributes of this NewRevisionVersion. # noqa: E501 + :type: object + """ + + self._attributes = attributes + + @property + def description(self): + """Gets the description of this NewRevisionVersion. # noqa: E501 + + A detailed description of the campaign. # noqa: E501 + + :return: The description of this NewRevisionVersion. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this NewRevisionVersion. + + A detailed description of the campaign. # noqa: E501 + + :param description: The description of this NewRevisionVersion. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def active_ruleset_id(self): + """Gets the active_ruleset_id of this NewRevisionVersion. # noqa: E501 + + The ID of the ruleset this campaign template will use. # noqa: E501 + + :return: The active_ruleset_id of this NewRevisionVersion. # noqa: E501 + :rtype: int + """ + return self._active_ruleset_id + + @active_ruleset_id.setter + def active_ruleset_id(self, active_ruleset_id): + """Sets the active_ruleset_id of this NewRevisionVersion. + + The ID of the ruleset this campaign template will use. # noqa: E501 + + :param active_ruleset_id: The active_ruleset_id of this NewRevisionVersion. # noqa: E501 + :type: int + """ + + self._active_ruleset_id = active_ruleset_id + + @property + def tags(self): + """Gets the tags of this NewRevisionVersion. # noqa: E501 + + A list of tags for the campaign template. # noqa: E501 + + :return: The tags of this NewRevisionVersion. # noqa: E501 + :rtype: list[str] + """ + return self._tags + + @tags.setter + def tags(self, tags): + """Sets the tags of this NewRevisionVersion. + + A list of tags for the campaign template. # noqa: E501 + + :param tags: The tags of this NewRevisionVersion. # noqa: E501 + :type: list[str] + """ + + self._tags = tags + + @property + def coupon_settings(self): + """Gets the coupon_settings of this NewRevisionVersion. # noqa: E501 + + + :return: The coupon_settings of this NewRevisionVersion. # noqa: E501 + :rtype: CodeGeneratorSettings + """ + return self._coupon_settings + + @coupon_settings.setter + def coupon_settings(self, coupon_settings): + """Sets the coupon_settings of this NewRevisionVersion. + + + :param coupon_settings: The coupon_settings of this NewRevisionVersion. # noqa: E501 + :type: CodeGeneratorSettings + """ + + self._coupon_settings = coupon_settings + + @property + def referral_settings(self): + """Gets the referral_settings of this NewRevisionVersion. # noqa: E501 + + + :return: The referral_settings of this NewRevisionVersion. # noqa: E501 + :rtype: CodeGeneratorSettings + """ + return self._referral_settings + + @referral_settings.setter + def referral_settings(self, referral_settings): + """Sets the referral_settings of this NewRevisionVersion. + + + :param referral_settings: The referral_settings of this NewRevisionVersion. # noqa: E501 + :type: CodeGeneratorSettings + """ + + self._referral_settings = referral_settings + + @property + def limits(self): + """Gets the limits of this NewRevisionVersion. # noqa: E501 + + The set of limits that will operate for this campaign version. # noqa: E501 + + :return: The limits of this NewRevisionVersion. # noqa: E501 + :rtype: list[LimitConfig] + """ + return self._limits + + @limits.setter + def limits(self, limits): + """Sets the limits of this NewRevisionVersion. + + The set of limits that will operate for this campaign version. # noqa: E501 + + :param limits: The limits of this NewRevisionVersion. # noqa: E501 + :type: list[LimitConfig] + """ + + self._limits = limits + + @property + def features(self): + """Gets the features of this NewRevisionVersion. # noqa: E501 + + A list of features for the campaign template. # noqa: E501 + + :return: The features of this NewRevisionVersion. # noqa: E501 + :rtype: list[str] + """ + return self._features + + @features.setter + def features(self, features): + """Sets the features of this NewRevisionVersion. + + A list of features for the campaign template. # noqa: E501 + + :param features: The features of this NewRevisionVersion. # noqa: E501 + :type: list[str] + """ + allowed_values = ["coupons", "referrals", "loyalty", "giveaways", "strikethrough", "achievements"] # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + not set(features).issubset(set(allowed_values))): # noqa: E501 + raise ValueError( + "Invalid values for `features` [{0}], must be a subset of [{1}]" # noqa: E501 + .format(", ".join(map(str, set(features) - set(allowed_values))), # noqa: E501 + ", ".join(map(str, allowed_values))) + ) + + self._features = features + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, NewRevisionVersion): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, NewRevisionVersion): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/new_webhook.py b/talon_one/models/new_webhook.py index 4e89615..d84456a 100644 --- a/talon_one/models/new_webhook.py +++ b/talon_one/models/new_webhook.py @@ -89,7 +89,7 @@ def __init__(self, application_ids=None, title=None, description=None, verb=None def application_ids(self): """Gets the application_ids of this NewWebhook. # noqa: E501 - The IDs of the Applications that are related to this entity. # noqa: E501 + The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. # noqa: E501 :return: The application_ids of this NewWebhook. # noqa: E501 :rtype: list[int] @@ -100,7 +100,7 @@ def application_ids(self): def application_ids(self, application_ids): """Sets the application_ids of this NewWebhook. - The IDs of the Applications that are related to this entity. # noqa: E501 + The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. # noqa: E501 :param application_ids: The application_ids of this NewWebhook. # noqa: E501 :type: list[int] diff --git a/talon_one/models/product.py b/talon_one/models/product.py index e0e10a3..16e497d 100644 --- a/talon_one/models/product.py +++ b/talon_one/models/product.py @@ -55,7 +55,7 @@ def __init__(self, name=None, local_vars_configuration=None): # noqa: E501 def name(self): """Gets the name of this Product. # noqa: E501 - The name of the product. # noqa: E501 + The product the item belongs to. # noqa: E501 :return: The name of this Product. # noqa: E501 :rtype: str @@ -66,7 +66,7 @@ def name(self): def name(self, name): """Sets the name of this Product. - The name of the product. # noqa: E501 + The product the item belongs to. # noqa: E501 :param name: The name of this Product. # noqa: E501 :type: str diff --git a/talon_one/models/product_search_match.py b/talon_one/models/product_search_match.py new file mode 100644 index 0000000..b65f06e --- /dev/null +++ b/talon_one/models/product_search_match.py @@ -0,0 +1,180 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ProductSearchMatch(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'product_id': 'int', + 'value': 'str', + 'product_sku_id': 'int' + } + + attribute_map = { + 'product_id': 'productId', + 'value': 'value', + 'product_sku_id': 'productSkuId' + } + + def __init__(self, product_id=None, value=None, product_sku_id=None, local_vars_configuration=None): # noqa: E501 + """ProductSearchMatch - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._product_id = None + self._value = None + self._product_sku_id = None + self.discriminator = None + + self.product_id = product_id + self.value = value + if product_sku_id is not None: + self.product_sku_id = product_sku_id + + @property + def product_id(self): + """Gets the product_id of this ProductSearchMatch. # noqa: E501 + + The ID of the product. # noqa: E501 + + :return: The product_id of this ProductSearchMatch. # noqa: E501 + :rtype: int + """ + return self._product_id + + @product_id.setter + def product_id(self, product_id): + """Sets the product_id of this ProductSearchMatch. + + The ID of the product. # noqa: E501 + + :param product_id: The product_id of this ProductSearchMatch. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and product_id is None: # noqa: E501 + raise ValueError("Invalid value for `product_id`, must not be `None`") # noqa: E501 + + self._product_id = product_id + + @property + def value(self): + """Gets the value of this ProductSearchMatch. # noqa: E501 + + The string matching the given value. Either a product name or SKU. # noqa: E501 + + :return: The value of this ProductSearchMatch. # noqa: E501 + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """Sets the value of this ProductSearchMatch. + + The string matching the given value. Either a product name or SKU. # noqa: E501 + + :param value: The value of this ProductSearchMatch. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and value is None: # noqa: E501 + raise ValueError("Invalid value for `value`, must not be `None`") # noqa: E501 + + self._value = value + + @property + def product_sku_id(self): + """Gets the product_sku_id of this ProductSearchMatch. # noqa: E501 + + The ID of the SKU linked to a product. If empty, this is an analytics-level product. # noqa: E501 + + :return: The product_sku_id of this ProductSearchMatch. # noqa: E501 + :rtype: int + """ + return self._product_sku_id + + @product_sku_id.setter + def product_sku_id(self, product_sku_id): + """Sets the product_sku_id of this ProductSearchMatch. + + The ID of the SKU linked to a product. If empty, this is an analytics-level product. # noqa: E501 + + :param product_sku_id: The product_sku_id of this ProductSearchMatch. # noqa: E501 + :type: int + """ + + self._product_sku_id = product_sku_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ProductSearchMatch): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ProductSearchMatch): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/product_sku_unit_analytics.py b/talon_one/models/product_sku_unit_analytics.py new file mode 100644 index 0000000..22885dc --- /dev/null +++ b/talon_one/models/product_sku_unit_analytics.py @@ -0,0 +1,208 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ProductSkuUnitAnalytics(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'start_time': 'datetime', + 'end_time': 'datetime', + 'purchased_units': 'AnalyticsDataPointWithTrend', + 'sku': 'str' + } + + attribute_map = { + 'start_time': 'startTime', + 'end_time': 'endTime', + 'purchased_units': 'purchasedUnits', + 'sku': 'sku' + } + + def __init__(self, start_time=None, end_time=None, purchased_units=None, sku=None, local_vars_configuration=None): # noqa: E501 + """ProductSkuUnitAnalytics - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._start_time = None + self._end_time = None + self._purchased_units = None + self._sku = None + self.discriminator = None + + self.start_time = start_time + self.end_time = end_time + self.purchased_units = purchased_units + self.sku = sku + + @property + def start_time(self): + """Gets the start_time of this ProductSkuUnitAnalytics. # noqa: E501 + + The start of the aggregation time frame in UTC. # noqa: E501 + + :return: The start_time of this ProductSkuUnitAnalytics. # noqa: E501 + :rtype: datetime + """ + return self._start_time + + @start_time.setter + def start_time(self, start_time): + """Sets the start_time of this ProductSkuUnitAnalytics. + + The start of the aggregation time frame in UTC. # noqa: E501 + + :param start_time: The start_time of this ProductSkuUnitAnalytics. # noqa: E501 + :type: datetime + """ + if self.local_vars_configuration.client_side_validation and start_time is None: # noqa: E501 + raise ValueError("Invalid value for `start_time`, must not be `None`") # noqa: E501 + + self._start_time = start_time + + @property + def end_time(self): + """Gets the end_time of this ProductSkuUnitAnalytics. # noqa: E501 + + The end of the aggregation time frame in UTC. # noqa: E501 + + :return: The end_time of this ProductSkuUnitAnalytics. # noqa: E501 + :rtype: datetime + """ + return self._end_time + + @end_time.setter + def end_time(self, end_time): + """Sets the end_time of this ProductSkuUnitAnalytics. + + The end of the aggregation time frame in UTC. # noqa: E501 + + :param end_time: The end_time of this ProductSkuUnitAnalytics. # noqa: E501 + :type: datetime + """ + if self.local_vars_configuration.client_side_validation and end_time is None: # noqa: E501 + raise ValueError("Invalid value for `end_time`, must not be `None`") # noqa: E501 + + self._end_time = end_time + + @property + def purchased_units(self): + """Gets the purchased_units of this ProductSkuUnitAnalytics. # noqa: E501 + + + :return: The purchased_units of this ProductSkuUnitAnalytics. # noqa: E501 + :rtype: AnalyticsDataPointWithTrend + """ + return self._purchased_units + + @purchased_units.setter + def purchased_units(self, purchased_units): + """Sets the purchased_units of this ProductSkuUnitAnalytics. + + + :param purchased_units: The purchased_units of this ProductSkuUnitAnalytics. # noqa: E501 + :type: AnalyticsDataPointWithTrend + """ + if self.local_vars_configuration.client_side_validation and purchased_units is None: # noqa: E501 + raise ValueError("Invalid value for `purchased_units`, must not be `None`") # noqa: E501 + + self._purchased_units = purchased_units + + @property + def sku(self): + """Gets the sku of this ProductSkuUnitAnalytics. # noqa: E501 + + The SKU linked to the analytics-level product. # noqa: E501 + + :return: The sku of this ProductSkuUnitAnalytics. # noqa: E501 + :rtype: str + """ + return self._sku + + @sku.setter + def sku(self, sku): + """Sets the sku of this ProductSkuUnitAnalytics. + + The SKU linked to the analytics-level product. # noqa: E501 + + :param sku: The sku of this ProductSkuUnitAnalytics. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and sku is None: # noqa: E501 + raise ValueError("Invalid value for `sku`, must not be `None`") # noqa: E501 + + self._sku = sku + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ProductSkuUnitAnalytics): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ProductSkuUnitAnalytics): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/product_unit_analytics.py b/talon_one/models/product_unit_analytics.py new file mode 100644 index 0000000..a665ea4 --- /dev/null +++ b/talon_one/models/product_unit_analytics.py @@ -0,0 +1,237 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ProductUnitAnalytics(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'start_time': 'datetime', + 'end_time': 'datetime', + 'purchased_units': 'AnalyticsDataPointWithTrend', + 'product_id': 'int', + 'product_name': 'str' + } + + attribute_map = { + 'start_time': 'startTime', + 'end_time': 'endTime', + 'purchased_units': 'purchasedUnits', + 'product_id': 'productId', + 'product_name': 'productName' + } + + def __init__(self, start_time=None, end_time=None, purchased_units=None, product_id=None, product_name=None, local_vars_configuration=None): # noqa: E501 + """ProductUnitAnalytics - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._start_time = None + self._end_time = None + self._purchased_units = None + self._product_id = None + self._product_name = None + self.discriminator = None + + self.start_time = start_time + self.end_time = end_time + self.purchased_units = purchased_units + self.product_id = product_id + self.product_name = product_name + + @property + def start_time(self): + """Gets the start_time of this ProductUnitAnalytics. # noqa: E501 + + The start of the aggregation time frame in UTC. # noqa: E501 + + :return: The start_time of this ProductUnitAnalytics. # noqa: E501 + :rtype: datetime + """ + return self._start_time + + @start_time.setter + def start_time(self, start_time): + """Sets the start_time of this ProductUnitAnalytics. + + The start of the aggregation time frame in UTC. # noqa: E501 + + :param start_time: The start_time of this ProductUnitAnalytics. # noqa: E501 + :type: datetime + """ + if self.local_vars_configuration.client_side_validation and start_time is None: # noqa: E501 + raise ValueError("Invalid value for `start_time`, must not be `None`") # noqa: E501 + + self._start_time = start_time + + @property + def end_time(self): + """Gets the end_time of this ProductUnitAnalytics. # noqa: E501 + + The end of the aggregation time frame in UTC. # noqa: E501 + + :return: The end_time of this ProductUnitAnalytics. # noqa: E501 + :rtype: datetime + """ + return self._end_time + + @end_time.setter + def end_time(self, end_time): + """Sets the end_time of this ProductUnitAnalytics. + + The end of the aggregation time frame in UTC. # noqa: E501 + + :param end_time: The end_time of this ProductUnitAnalytics. # noqa: E501 + :type: datetime + """ + if self.local_vars_configuration.client_side_validation and end_time is None: # noqa: E501 + raise ValueError("Invalid value for `end_time`, must not be `None`") # noqa: E501 + + self._end_time = end_time + + @property + def purchased_units(self): + """Gets the purchased_units of this ProductUnitAnalytics. # noqa: E501 + + + :return: The purchased_units of this ProductUnitAnalytics. # noqa: E501 + :rtype: AnalyticsDataPointWithTrend + """ + return self._purchased_units + + @purchased_units.setter + def purchased_units(self, purchased_units): + """Sets the purchased_units of this ProductUnitAnalytics. + + + :param purchased_units: The purchased_units of this ProductUnitAnalytics. # noqa: E501 + :type: AnalyticsDataPointWithTrend + """ + if self.local_vars_configuration.client_side_validation and purchased_units is None: # noqa: E501 + raise ValueError("Invalid value for `purchased_units`, must not be `None`") # noqa: E501 + + self._purchased_units = purchased_units + + @property + def product_id(self): + """Gets the product_id of this ProductUnitAnalytics. # noqa: E501 + + The ID of the analytics-level product. # noqa: E501 + + :return: The product_id of this ProductUnitAnalytics. # noqa: E501 + :rtype: int + """ + return self._product_id + + @product_id.setter + def product_id(self, product_id): + """Sets the product_id of this ProductUnitAnalytics. + + The ID of the analytics-level product. # noqa: E501 + + :param product_id: The product_id of this ProductUnitAnalytics. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and product_id is None: # noqa: E501 + raise ValueError("Invalid value for `product_id`, must not be `None`") # noqa: E501 + + self._product_id = product_id + + @property + def product_name(self): + """Gets the product_name of this ProductUnitAnalytics. # noqa: E501 + + The name of the analytics-level product. # noqa: E501 + + :return: The product_name of this ProductUnitAnalytics. # noqa: E501 + :rtype: str + """ + return self._product_name + + @product_name.setter + def product_name(self, product_name): + """Sets the product_name of this ProductUnitAnalytics. + + The name of the analytics-level product. # noqa: E501 + + :param product_name: The product_name of this ProductUnitAnalytics. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and product_name is None: # noqa: E501 + raise ValueError("Invalid value for `product_name`, must not be `None`") # noqa: E501 + + self._product_name = product_name + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ProductUnitAnalytics): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ProductUnitAnalytics): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/revision.py b/talon_one/models/revision.py new file mode 100644 index 0000000..238c84f --- /dev/null +++ b/talon_one/models/revision.py @@ -0,0 +1,362 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class Revision(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'id': 'int', + 'activate_at': 'datetime', + 'account_id': 'int', + 'application_id': 'int', + 'campaign_id': 'int', + 'created': 'datetime', + 'created_by': 'int', + 'activated_at': 'datetime', + 'activated_by': 'int', + 'current_version': 'RevisionVersion' + } + + attribute_map = { + 'id': 'id', + 'activate_at': 'activateAt', + 'account_id': 'accountId', + 'application_id': 'applicationId', + 'campaign_id': 'campaignId', + 'created': 'created', + 'created_by': 'createdBy', + 'activated_at': 'activatedAt', + 'activated_by': 'activatedBy', + 'current_version': 'currentVersion' + } + + def __init__(self, id=None, activate_at=None, account_id=None, application_id=None, campaign_id=None, created=None, created_by=None, activated_at=None, activated_by=None, current_version=None, local_vars_configuration=None): # noqa: E501 + """Revision - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._id = None + self._activate_at = None + self._account_id = None + self._application_id = None + self._campaign_id = None + self._created = None + self._created_by = None + self._activated_at = None + self._activated_by = None + self._current_version = None + self.discriminator = None + + self.id = id + if activate_at is not None: + self.activate_at = activate_at + self.account_id = account_id + self.application_id = application_id + self.campaign_id = campaign_id + self.created = created + self.created_by = created_by + if activated_at is not None: + self.activated_at = activated_at + if activated_by is not None: + self.activated_by = activated_by + if current_version is not None: + self.current_version = current_version + + @property + def id(self): + """Gets the id of this Revision. # noqa: E501 + + Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. # noqa: E501 + + :return: The id of this Revision. # noqa: E501 + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this Revision. + + Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. # noqa: E501 + + :param id: The id of this Revision. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501 + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + @property + def activate_at(self): + """Gets the activate_at of this Revision. # noqa: E501 + + + :return: The activate_at of this Revision. # noqa: E501 + :rtype: datetime + """ + return self._activate_at + + @activate_at.setter + def activate_at(self, activate_at): + """Sets the activate_at of this Revision. + + + :param activate_at: The activate_at of this Revision. # noqa: E501 + :type: datetime + """ + + self._activate_at = activate_at + + @property + def account_id(self): + """Gets the account_id of this Revision. # noqa: E501 + + + :return: The account_id of this Revision. # noqa: E501 + :rtype: int + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this Revision. + + + :param account_id: The account_id of this Revision. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and account_id is None: # noqa: E501 + raise ValueError("Invalid value for `account_id`, must not be `None`") # noqa: E501 + + self._account_id = account_id + + @property + def application_id(self): + """Gets the application_id of this Revision. # noqa: E501 + + + :return: The application_id of this Revision. # noqa: E501 + :rtype: int + """ + return self._application_id + + @application_id.setter + def application_id(self, application_id): + """Sets the application_id of this Revision. + + + :param application_id: The application_id of this Revision. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and application_id is None: # noqa: E501 + raise ValueError("Invalid value for `application_id`, must not be `None`") # noqa: E501 + + self._application_id = application_id + + @property + def campaign_id(self): + """Gets the campaign_id of this Revision. # noqa: E501 + + + :return: The campaign_id of this Revision. # noqa: E501 + :rtype: int + """ + return self._campaign_id + + @campaign_id.setter + def campaign_id(self, campaign_id): + """Sets the campaign_id of this Revision. + + + :param campaign_id: The campaign_id of this Revision. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and campaign_id is None: # noqa: E501 + raise ValueError("Invalid value for `campaign_id`, must not be `None`") # noqa: E501 + + self._campaign_id = campaign_id + + @property + def created(self): + """Gets the created of this Revision. # noqa: E501 + + + :return: The created of this Revision. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this Revision. + + + :param created: The created of this Revision. # noqa: E501 + :type: datetime + """ + if self.local_vars_configuration.client_side_validation and created is None: # noqa: E501 + raise ValueError("Invalid value for `created`, must not be `None`") # noqa: E501 + + self._created = created + + @property + def created_by(self): + """Gets the created_by of this Revision. # noqa: E501 + + + :return: The created_by of this Revision. # noqa: E501 + :rtype: int + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """Sets the created_by of this Revision. + + + :param created_by: The created_by of this Revision. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and created_by is None: # noqa: E501 + raise ValueError("Invalid value for `created_by`, must not be `None`") # noqa: E501 + + self._created_by = created_by + + @property + def activated_at(self): + """Gets the activated_at of this Revision. # noqa: E501 + + + :return: The activated_at of this Revision. # noqa: E501 + :rtype: datetime + """ + return self._activated_at + + @activated_at.setter + def activated_at(self, activated_at): + """Sets the activated_at of this Revision. + + + :param activated_at: The activated_at of this Revision. # noqa: E501 + :type: datetime + """ + + self._activated_at = activated_at + + @property + def activated_by(self): + """Gets the activated_by of this Revision. # noqa: E501 + + + :return: The activated_by of this Revision. # noqa: E501 + :rtype: int + """ + return self._activated_by + + @activated_by.setter + def activated_by(self, activated_by): + """Sets the activated_by of this Revision. + + + :param activated_by: The activated_by of this Revision. # noqa: E501 + :type: int + """ + + self._activated_by = activated_by + + @property + def current_version(self): + """Gets the current_version of this Revision. # noqa: E501 + + + :return: The current_version of this Revision. # noqa: E501 + :rtype: RevisionVersion + """ + return self._current_version + + @current_version.setter + def current_version(self, current_version): + """Sets the current_version of this Revision. + + + :param current_version: The current_version of this Revision. # noqa: E501 + :type: RevisionVersion + """ + + self._current_version = current_version + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, Revision): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, Revision): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/revision_activation.py b/talon_one/models/revision_activation.py new file mode 100644 index 0000000..7fd9eea --- /dev/null +++ b/talon_one/models/revision_activation.py @@ -0,0 +1,120 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class RevisionActivation(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'activate_at': 'datetime' + } + + attribute_map = { + 'activate_at': 'activateAt' + } + + def __init__(self, activate_at=None, local_vars_configuration=None): # noqa: E501 + """RevisionActivation - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._activate_at = None + self.discriminator = None + + if activate_at is not None: + self.activate_at = activate_at + + @property + def activate_at(self): + """Gets the activate_at of this RevisionActivation. # noqa: E501 + + + :return: The activate_at of this RevisionActivation. # noqa: E501 + :rtype: datetime + """ + return self._activate_at + + @activate_at.setter + def activate_at(self, activate_at): + """Sets the activate_at of this RevisionActivation. + + + :param activate_at: The activate_at of this RevisionActivation. # noqa: E501 + :type: datetime + """ + + self._activate_at = activate_at + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, RevisionActivation): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, RevisionActivation): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/revision_version.py b/talon_one/models/revision_version.py new file mode 100644 index 0000000..0ac267f --- /dev/null +++ b/talon_one/models/revision_version.py @@ -0,0 +1,623 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class RevisionVersion(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'id': 'int', + 'account_id': 'int', + 'application_id': 'int', + 'campaign_id': 'int', + 'created': 'datetime', + 'created_by': 'int', + 'revision_id': 'int', + 'version': 'int', + 'name': 'str', + 'start_time': 'datetime', + 'end_time': 'datetime', + 'attributes': 'object', + 'description': 'str', + 'active_ruleset_id': 'int', + 'tags': 'list[str]', + 'coupon_settings': 'CodeGeneratorSettings', + 'referral_settings': 'CodeGeneratorSettings', + 'limits': 'list[LimitConfig]', + 'features': 'list[str]' + } + + attribute_map = { + 'id': 'id', + 'account_id': 'accountId', + 'application_id': 'applicationId', + 'campaign_id': 'campaignId', + 'created': 'created', + 'created_by': 'createdBy', + 'revision_id': 'revisionId', + 'version': 'version', + 'name': 'name', + 'start_time': 'startTime', + 'end_time': 'endTime', + 'attributes': 'attributes', + 'description': 'description', + 'active_ruleset_id': 'activeRulesetId', + 'tags': 'tags', + 'coupon_settings': 'couponSettings', + 'referral_settings': 'referralSettings', + 'limits': 'limits', + 'features': 'features' + } + + def __init__(self, id=None, account_id=None, application_id=None, campaign_id=None, created=None, created_by=None, revision_id=None, version=None, name=None, start_time=None, end_time=None, attributes=None, description=None, active_ruleset_id=None, tags=None, coupon_settings=None, referral_settings=None, limits=None, features=None, local_vars_configuration=None): # noqa: E501 + """RevisionVersion - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._id = None + self._account_id = None + self._application_id = None + self._campaign_id = None + self._created = None + self._created_by = None + self._revision_id = None + self._version = None + self._name = None + self._start_time = None + self._end_time = None + self._attributes = None + self._description = None + self._active_ruleset_id = None + self._tags = None + self._coupon_settings = None + self._referral_settings = None + self._limits = None + self._features = None + self.discriminator = None + + self.id = id + self.account_id = account_id + self.application_id = application_id + self.campaign_id = campaign_id + self.created = created + self.created_by = created_by + self.revision_id = revision_id + self.version = version + if name is not None: + self.name = name + self.start_time = start_time + self.end_time = end_time + if attributes is not None: + self.attributes = attributes + self.description = description + self.active_ruleset_id = active_ruleset_id + if tags is not None: + self.tags = tags + if coupon_settings is not None: + self.coupon_settings = coupon_settings + if referral_settings is not None: + self.referral_settings = referral_settings + if limits is not None: + self.limits = limits + if features is not None: + self.features = features + + @property + def id(self): + """Gets the id of this RevisionVersion. # noqa: E501 + + Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. # noqa: E501 + + :return: The id of this RevisionVersion. # noqa: E501 + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this RevisionVersion. + + Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. # noqa: E501 + + :param id: The id of this RevisionVersion. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501 + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + @property + def account_id(self): + """Gets the account_id of this RevisionVersion. # noqa: E501 + + + :return: The account_id of this RevisionVersion. # noqa: E501 + :rtype: int + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this RevisionVersion. + + + :param account_id: The account_id of this RevisionVersion. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and account_id is None: # noqa: E501 + raise ValueError("Invalid value for `account_id`, must not be `None`") # noqa: E501 + + self._account_id = account_id + + @property + def application_id(self): + """Gets the application_id of this RevisionVersion. # noqa: E501 + + + :return: The application_id of this RevisionVersion. # noqa: E501 + :rtype: int + """ + return self._application_id + + @application_id.setter + def application_id(self, application_id): + """Sets the application_id of this RevisionVersion. + + + :param application_id: The application_id of this RevisionVersion. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and application_id is None: # noqa: E501 + raise ValueError("Invalid value for `application_id`, must not be `None`") # noqa: E501 + + self._application_id = application_id + + @property + def campaign_id(self): + """Gets the campaign_id of this RevisionVersion. # noqa: E501 + + + :return: The campaign_id of this RevisionVersion. # noqa: E501 + :rtype: int + """ + return self._campaign_id + + @campaign_id.setter + def campaign_id(self, campaign_id): + """Sets the campaign_id of this RevisionVersion. + + + :param campaign_id: The campaign_id of this RevisionVersion. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and campaign_id is None: # noqa: E501 + raise ValueError("Invalid value for `campaign_id`, must not be `None`") # noqa: E501 + + self._campaign_id = campaign_id + + @property + def created(self): + """Gets the created of this RevisionVersion. # noqa: E501 + + + :return: The created of this RevisionVersion. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this RevisionVersion. + + + :param created: The created of this RevisionVersion. # noqa: E501 + :type: datetime + """ + if self.local_vars_configuration.client_side_validation and created is None: # noqa: E501 + raise ValueError("Invalid value for `created`, must not be `None`") # noqa: E501 + + self._created = created + + @property + def created_by(self): + """Gets the created_by of this RevisionVersion. # noqa: E501 + + + :return: The created_by of this RevisionVersion. # noqa: E501 + :rtype: int + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """Sets the created_by of this RevisionVersion. + + + :param created_by: The created_by of this RevisionVersion. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and created_by is None: # noqa: E501 + raise ValueError("Invalid value for `created_by`, must not be `None`") # noqa: E501 + + self._created_by = created_by + + @property + def revision_id(self): + """Gets the revision_id of this RevisionVersion. # noqa: E501 + + + :return: The revision_id of this RevisionVersion. # noqa: E501 + :rtype: int + """ + return self._revision_id + + @revision_id.setter + def revision_id(self, revision_id): + """Sets the revision_id of this RevisionVersion. + + + :param revision_id: The revision_id of this RevisionVersion. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and revision_id is None: # noqa: E501 + raise ValueError("Invalid value for `revision_id`, must not be `None`") # noqa: E501 + + self._revision_id = revision_id + + @property + def version(self): + """Gets the version of this RevisionVersion. # noqa: E501 + + + :return: The version of this RevisionVersion. # noqa: E501 + :rtype: int + """ + return self._version + + @version.setter + def version(self, version): + """Sets the version of this RevisionVersion. + + + :param version: The version of this RevisionVersion. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and version is None: # noqa: E501 + raise ValueError("Invalid value for `version`, must not be `None`") # noqa: E501 + + self._version = version + + @property + def name(self): + """Gets the name of this RevisionVersion. # noqa: E501 + + A user-facing name for this campaign. # noqa: E501 + + :return: The name of this RevisionVersion. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this RevisionVersion. + + A user-facing name for this campaign. # noqa: E501 + + :param name: The name of this RevisionVersion. # noqa: E501 + :type: str + """ + if (self.local_vars_configuration.client_side_validation and + name is not None and len(name) < 1): + raise ValueError("Invalid value for `name`, length must be greater than or equal to `1`") # noqa: E501 + + self._name = name + + @property + def start_time(self): + """Gets the start_time of this RevisionVersion. # noqa: E501 + + Timestamp when the campaign will become active. # noqa: E501 + + :return: The start_time of this RevisionVersion. # noqa: E501 + :rtype: datetime + """ + return self._start_time + + @start_time.setter + def start_time(self, start_time): + """Sets the start_time of this RevisionVersion. + + Timestamp when the campaign will become active. # noqa: E501 + + :param start_time: The start_time of this RevisionVersion. # noqa: E501 + :type: datetime + """ + + self._start_time = start_time + + @property + def end_time(self): + """Gets the end_time of this RevisionVersion. # noqa: E501 + + Timestamp when the campaign will become inactive. # noqa: E501 + + :return: The end_time of this RevisionVersion. # noqa: E501 + :rtype: datetime + """ + return self._end_time + + @end_time.setter + def end_time(self, end_time): + """Sets the end_time of this RevisionVersion. + + Timestamp when the campaign will become inactive. # noqa: E501 + + :param end_time: The end_time of this RevisionVersion. # noqa: E501 + :type: datetime + """ + + self._end_time = end_time + + @property + def attributes(self): + """Gets the attributes of this RevisionVersion. # noqa: E501 + + Arbitrary properties associated with this campaign. # noqa: E501 + + :return: The attributes of this RevisionVersion. # noqa: E501 + :rtype: object + """ + return self._attributes + + @attributes.setter + def attributes(self, attributes): + """Sets the attributes of this RevisionVersion. + + Arbitrary properties associated with this campaign. # noqa: E501 + + :param attributes: The attributes of this RevisionVersion. # noqa: E501 + :type: object + """ + + self._attributes = attributes + + @property + def description(self): + """Gets the description of this RevisionVersion. # noqa: E501 + + A detailed description of the campaign. # noqa: E501 + + :return: The description of this RevisionVersion. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this RevisionVersion. + + A detailed description of the campaign. # noqa: E501 + + :param description: The description of this RevisionVersion. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def active_ruleset_id(self): + """Gets the active_ruleset_id of this RevisionVersion. # noqa: E501 + + The ID of the ruleset this campaign template will use. # noqa: E501 + + :return: The active_ruleset_id of this RevisionVersion. # noqa: E501 + :rtype: int + """ + return self._active_ruleset_id + + @active_ruleset_id.setter + def active_ruleset_id(self, active_ruleset_id): + """Sets the active_ruleset_id of this RevisionVersion. + + The ID of the ruleset this campaign template will use. # noqa: E501 + + :param active_ruleset_id: The active_ruleset_id of this RevisionVersion. # noqa: E501 + :type: int + """ + + self._active_ruleset_id = active_ruleset_id + + @property + def tags(self): + """Gets the tags of this RevisionVersion. # noqa: E501 + + A list of tags for the campaign template. # noqa: E501 + + :return: The tags of this RevisionVersion. # noqa: E501 + :rtype: list[str] + """ + return self._tags + + @tags.setter + def tags(self, tags): + """Sets the tags of this RevisionVersion. + + A list of tags for the campaign template. # noqa: E501 + + :param tags: The tags of this RevisionVersion. # noqa: E501 + :type: list[str] + """ + + self._tags = tags + + @property + def coupon_settings(self): + """Gets the coupon_settings of this RevisionVersion. # noqa: E501 + + + :return: The coupon_settings of this RevisionVersion. # noqa: E501 + :rtype: CodeGeneratorSettings + """ + return self._coupon_settings + + @coupon_settings.setter + def coupon_settings(self, coupon_settings): + """Sets the coupon_settings of this RevisionVersion. + + + :param coupon_settings: The coupon_settings of this RevisionVersion. # noqa: E501 + :type: CodeGeneratorSettings + """ + + self._coupon_settings = coupon_settings + + @property + def referral_settings(self): + """Gets the referral_settings of this RevisionVersion. # noqa: E501 + + + :return: The referral_settings of this RevisionVersion. # noqa: E501 + :rtype: CodeGeneratorSettings + """ + return self._referral_settings + + @referral_settings.setter + def referral_settings(self, referral_settings): + """Sets the referral_settings of this RevisionVersion. + + + :param referral_settings: The referral_settings of this RevisionVersion. # noqa: E501 + :type: CodeGeneratorSettings + """ + + self._referral_settings = referral_settings + + @property + def limits(self): + """Gets the limits of this RevisionVersion. # noqa: E501 + + The set of limits that will operate for this campaign version. # noqa: E501 + + :return: The limits of this RevisionVersion. # noqa: E501 + :rtype: list[LimitConfig] + """ + return self._limits + + @limits.setter + def limits(self, limits): + """Sets the limits of this RevisionVersion. + + The set of limits that will operate for this campaign version. # noqa: E501 + + :param limits: The limits of this RevisionVersion. # noqa: E501 + :type: list[LimitConfig] + """ + + self._limits = limits + + @property + def features(self): + """Gets the features of this RevisionVersion. # noqa: E501 + + A list of features for the campaign template. # noqa: E501 + + :return: The features of this RevisionVersion. # noqa: E501 + :rtype: list[str] + """ + return self._features + + @features.setter + def features(self, features): + """Sets the features of this RevisionVersion. + + A list of features for the campaign template. # noqa: E501 + + :param features: The features of this RevisionVersion. # noqa: E501 + :type: list[str] + """ + allowed_values = ["coupons", "referrals", "loyalty", "giveaways", "strikethrough", "achievements"] # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + not set(features).issubset(set(allowed_values))): # noqa: E501 + raise ValueError( + "Invalid values for `features` [{0}], must be a subset of [{1}]" # noqa: E501 + .format(", ".join(map(str, set(features) - set(allowed_values))), # noqa: E501 + ", ".join(map(str, allowed_values))) + ) + + self._features = features + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, RevisionVersion): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, RevisionVersion): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/rollback_added_loyalty_points_effect_props.py b/talon_one/models/rollback_added_loyalty_points_effect_props.py index 463ae4d..cbf643f 100644 --- a/talon_one/models/rollback_added_loyalty_points_effect_props.py +++ b/talon_one/models/rollback_added_loyalty_points_effect_props.py @@ -279,6 +279,9 @@ def card_identifier(self, card_identifier): if (self.local_vars_configuration.client_side_validation and card_identifier is not None and len(card_identifier) > 108): raise ValueError("Invalid value for `card_identifier`, length must be less than or equal to `108`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + card_identifier is not None and not re.search(r'^[A-Za-z0-9_-]*$', card_identifier)): # noqa: E501 + raise ValueError(r"Invalid value for `card_identifier`, must be a follow pattern or equal to `/^[A-Za-z0-9_-]*$/`") # noqa: E501 self._card_identifier = card_identifier diff --git a/talon_one/models/rollback_deducted_loyalty_points_effect_props.py b/talon_one/models/rollback_deducted_loyalty_points_effect_props.py index dcba1bb..4abab5b 100644 --- a/talon_one/models/rollback_deducted_loyalty_points_effect_props.py +++ b/talon_one/models/rollback_deducted_loyalty_points_effect_props.py @@ -279,6 +279,9 @@ def card_identifier(self, card_identifier): if (self.local_vars_configuration.client_side_validation and card_identifier is not None and len(card_identifier) > 108): raise ValueError("Invalid value for `card_identifier`, length must be less than or equal to `108`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + card_identifier is not None and not re.search(r'^[A-Za-z0-9_-]*$', card_identifier)): # noqa: E501 + raise ValueError(r"Invalid value for `card_identifier`, must be a follow pattern or equal to `/^[A-Za-z0-9_-]*$/`") # noqa: E501 self._card_identifier = card_identifier diff --git a/talon_one/models/scim_base_user.py b/talon_one/models/scim_base_user.py new file mode 100644 index 0000000..89bf608 --- /dev/null +++ b/talon_one/models/scim_base_user.py @@ -0,0 +1,204 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ScimBaseUser(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'active': 'bool', + 'display_name': 'str', + 'user_name': 'str', + 'name': 'ScimBaseUserName' + } + + attribute_map = { + 'active': 'active', + 'display_name': 'displayName', + 'user_name': 'userName', + 'name': 'name' + } + + def __init__(self, active=None, display_name=None, user_name=None, name=None, local_vars_configuration=None): # noqa: E501 + """ScimBaseUser - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._active = None + self._display_name = None + self._user_name = None + self._name = None + self.discriminator = None + + if active is not None: + self.active = active + if display_name is not None: + self.display_name = display_name + if user_name is not None: + self.user_name = user_name + if name is not None: + self.name = name + + @property + def active(self): + """Gets the active of this ScimBaseUser. # noqa: E501 + + Status of the user. # noqa: E501 + + :return: The active of this ScimBaseUser. # noqa: E501 + :rtype: bool + """ + return self._active + + @active.setter + def active(self, active): + """Sets the active of this ScimBaseUser. + + Status of the user. # noqa: E501 + + :param active: The active of this ScimBaseUser. # noqa: E501 + :type: bool + """ + + self._active = active + + @property + def display_name(self): + """Gets the display_name of this ScimBaseUser. # noqa: E501 + + Display name of the user. # noqa: E501 + + :return: The display_name of this ScimBaseUser. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this ScimBaseUser. + + Display name of the user. # noqa: E501 + + :param display_name: The display_name of this ScimBaseUser. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def user_name(self): + """Gets the user_name of this ScimBaseUser. # noqa: E501 + + Unique identifier of the user. This is usually an email address. # noqa: E501 + + :return: The user_name of this ScimBaseUser. # noqa: E501 + :rtype: str + """ + return self._user_name + + @user_name.setter + def user_name(self, user_name): + """Sets the user_name of this ScimBaseUser. + + Unique identifier of the user. This is usually an email address. # noqa: E501 + + :param user_name: The user_name of this ScimBaseUser. # noqa: E501 + :type: str + """ + + self._user_name = user_name + + @property + def name(self): + """Gets the name of this ScimBaseUser. # noqa: E501 + + + :return: The name of this ScimBaseUser. # noqa: E501 + :rtype: ScimBaseUserName + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this ScimBaseUser. + + + :param name: The name of this ScimBaseUser. # noqa: E501 + :type: ScimBaseUserName + """ + + self._name = name + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ScimBaseUser): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ScimBaseUser): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/scim_base_user_name.py b/talon_one/models/scim_base_user_name.py new file mode 100644 index 0000000..c6d0c82 --- /dev/null +++ b/talon_one/models/scim_base_user_name.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ScimBaseUserName(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'formatted': 'str' + } + + attribute_map = { + 'formatted': 'formatted' + } + + def __init__(self, formatted=None, local_vars_configuration=None): # noqa: E501 + """ScimBaseUserName - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._formatted = None + self.discriminator = None + + if formatted is not None: + self.formatted = formatted + + @property + def formatted(self): + """Gets the formatted of this ScimBaseUserName. # noqa: E501 + + The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. # noqa: E501 + + :return: The formatted of this ScimBaseUserName. # noqa: E501 + :rtype: str + """ + return self._formatted + + @formatted.setter + def formatted(self, formatted): + """Sets the formatted of this ScimBaseUserName. + + The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. # noqa: E501 + + :param formatted: The formatted of this ScimBaseUserName. # noqa: E501 + :type: str + """ + + self._formatted = formatted + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ScimBaseUserName): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ScimBaseUserName): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/scim_new_user.py b/talon_one/models/scim_new_user.py index 06c7c55..1d003c2 100644 --- a/talon_one/models/scim_new_user.py +++ b/talon_one/models/scim_new_user.py @@ -35,16 +35,18 @@ class ScimNewUser(object): openapi_types = { 'active': 'bool', 'display_name': 'str', - 'user_name': 'str' + 'user_name': 'str', + 'name': 'ScimBaseUserName' } attribute_map = { 'active': 'active', 'display_name': 'displayName', - 'user_name': 'userName' + 'user_name': 'userName', + 'name': 'name' } - def __init__(self, active=None, display_name=None, user_name=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, active=None, display_name=None, user_name=None, name=None, local_vars_configuration=None): # noqa: E501 """ScimNewUser - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -53,6 +55,7 @@ def __init__(self, active=None, display_name=None, user_name=None, local_vars_co self._active = None self._display_name = None self._user_name = None + self._name = None self.discriminator = None if active is not None: @@ -60,6 +63,8 @@ def __init__(self, active=None, display_name=None, user_name=None, local_vars_co if display_name is not None: self.display_name = display_name self.user_name = user_name + if name is not None: + self.name = name @property def active(self): @@ -132,6 +137,27 @@ def user_name(self, user_name): self._user_name = user_name + @property + def name(self): + """Gets the name of this ScimNewUser. # noqa: E501 + + + :return: The name of this ScimNewUser. # noqa: E501 + :rtype: ScimBaseUserName + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this ScimNewUser. + + + :param name: The name of this ScimNewUser. # noqa: E501 + :type: ScimBaseUserName + """ + + self._name = name + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/scim_patch_operation.py b/talon_one/models/scim_patch_operation.py new file mode 100644 index 0000000..843bcf8 --- /dev/null +++ b/talon_one/models/scim_patch_operation.py @@ -0,0 +1,185 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ScimPatchOperation(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'op': 'str', + 'path': 'str', + 'value': 'str' + } + + attribute_map = { + 'op': 'op', + 'path': 'path', + 'value': 'value' + } + + def __init__(self, op=None, path=None, value=None, local_vars_configuration=None): # noqa: E501 + """ScimPatchOperation - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._op = None + self._path = None + self._value = None + self.discriminator = None + + self.op = op + if path is not None: + self.path = path + if value is not None: + self.value = value + + @property + def op(self): + """Gets the op of this ScimPatchOperation. # noqa: E501 + + The method that should be used in the operation. # noqa: E501 + + :return: The op of this ScimPatchOperation. # noqa: E501 + :rtype: str + """ + return self._op + + @op.setter + def op(self, op): + """Sets the op of this ScimPatchOperation. + + The method that should be used in the operation. # noqa: E501 + + :param op: The op of this ScimPatchOperation. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and op is None: # noqa: E501 + raise ValueError("Invalid value for `op`, must not be `None`") # noqa: E501 + allowed_values = ["add", "remove", "replace"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and op not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `op` ({0}), must be one of {1}" # noqa: E501 + .format(op, allowed_values) + ) + + self._op = op + + @property + def path(self): + """Gets the path of this ScimPatchOperation. # noqa: E501 + + The path specifying the attribute that should be updated. # noqa: E501 + + :return: The path of this ScimPatchOperation. # noqa: E501 + :rtype: str + """ + return self._path + + @path.setter + def path(self, path): + """Sets the path of this ScimPatchOperation. + + The path specifying the attribute that should be updated. # noqa: E501 + + :param path: The path of this ScimPatchOperation. # noqa: E501 + :type: str + """ + + self._path = path + + @property + def value(self): + """Gets the value of this ScimPatchOperation. # noqa: E501 + + The value that should be updated. Required if `op` is `add` or `replace`. # noqa: E501 + + :return: The value of this ScimPatchOperation. # noqa: E501 + :rtype: str + """ + return self._value + + @value.setter + def value(self, value): + """Sets the value of this ScimPatchOperation. + + The value that should be updated. Required if `op` is `add` or `replace`. # noqa: E501 + + :param value: The value of this ScimPatchOperation. # noqa: E501 + :type: str + """ + + self._value = value + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ScimPatchOperation): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ScimPatchOperation): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/scim_patch_request.py b/talon_one/models/scim_patch_request.py new file mode 100644 index 0000000..bf972f5 --- /dev/null +++ b/talon_one/models/scim_patch_request.py @@ -0,0 +1,149 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ScimPatchRequest(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'schemas': 'list[str]', + 'operations': 'list[ScimPatchOperation]' + } + + attribute_map = { + 'schemas': 'schemas', + 'operations': 'Operations' + } + + def __init__(self, schemas=None, operations=None, local_vars_configuration=None): # noqa: E501 + """ScimPatchRequest - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._schemas = None + self._operations = None + self.discriminator = None + + if schemas is not None: + self.schemas = schemas + self.operations = operations + + @property + def schemas(self): + """Gets the schemas of this ScimPatchRequest. # noqa: E501 + + SCIM schema for the given resource. # noqa: E501 + + :return: The schemas of this ScimPatchRequest. # noqa: E501 + :rtype: list[str] + """ + return self._schemas + + @schemas.setter + def schemas(self, schemas): + """Sets the schemas of this ScimPatchRequest. + + SCIM schema for the given resource. # noqa: E501 + + :param schemas: The schemas of this ScimPatchRequest. # noqa: E501 + :type: list[str] + """ + + self._schemas = schemas + + @property + def operations(self): + """Gets the operations of this ScimPatchRequest. # noqa: E501 + + + :return: The operations of this ScimPatchRequest. # noqa: E501 + :rtype: list[ScimPatchOperation] + """ + return self._operations + + @operations.setter + def operations(self, operations): + """Sets the operations of this ScimPatchRequest. + + + :param operations: The operations of this ScimPatchRequest. # noqa: E501 + :type: list[ScimPatchOperation] + """ + if self.local_vars_configuration.client_side_validation and operations is None: # noqa: E501 + raise ValueError("Invalid value for `operations`, must not be `None`") # noqa: E501 + + self._operations = operations + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ScimPatchRequest): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ScimPatchRequest): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/scim_resource.py b/talon_one/models/scim_resource.py index df3563d..eb8168f 100644 --- a/talon_one/models/scim_resource.py +++ b/talon_one/models/scim_resource.py @@ -34,15 +34,17 @@ class ScimResource(object): """ openapi_types = { 'id': 'str', - 'name': 'str' + 'name': 'str', + 'description': 'str' } attribute_map = { 'id': 'id', - 'name': 'name' + 'name': 'name', + 'description': 'description' } - def __init__(self, id=None, name=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, id=None, name=None, description=None, local_vars_configuration=None): # noqa: E501 """ScimResource - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -50,12 +52,15 @@ def __init__(self, id=None, name=None, local_vars_configuration=None): # noqa: self._id = None self._name = None + self._description = None self.discriminator = None if id is not None: self.id = id if name is not None: self.name = name + if description is not None: + self.description = description @property def id(self): @@ -103,6 +108,29 @@ def name(self, name): self._name = name + @property + def description(self): + """Gets the description of this ScimResource. # noqa: E501 + + Human-readable description of the resource. # noqa: E501 + + :return: The description of this ScimResource. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this ScimResource. + + Human-readable description of the resource. # noqa: E501 + + :param description: The description of this ScimResource. # noqa: E501 + :type: str + """ + + self._description = description + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/scim_schema_resource.py b/talon_one/models/scim_schema_resource.py new file mode 100644 index 0000000..435f90d --- /dev/null +++ b/talon_one/models/scim_schema_resource.py @@ -0,0 +1,204 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ScimSchemaResource(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'id': 'str', + 'name': 'str', + 'description': 'str', + 'attributes': 'list[object]' + } + + attribute_map = { + 'id': 'id', + 'name': 'name', + 'description': 'description', + 'attributes': 'attributes' + } + + def __init__(self, id=None, name=None, description=None, attributes=None, local_vars_configuration=None): # noqa: E501 + """ScimSchemaResource - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._id = None + self._name = None + self._description = None + self._attributes = None + self.discriminator = None + + if id is not None: + self.id = id + if name is not None: + self.name = name + if description is not None: + self.description = description + if attributes is not None: + self.attributes = attributes + + @property + def id(self): + """Gets the id of this ScimSchemaResource. # noqa: E501 + + ID of the resource. # noqa: E501 + + :return: The id of this ScimSchemaResource. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this ScimSchemaResource. + + ID of the resource. # noqa: E501 + + :param id: The id of this ScimSchemaResource. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def name(self): + """Gets the name of this ScimSchemaResource. # noqa: E501 + + Name of the resource. # noqa: E501 + + :return: The name of this ScimSchemaResource. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this ScimSchemaResource. + + Name of the resource. # noqa: E501 + + :param name: The name of this ScimSchemaResource. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this ScimSchemaResource. # noqa: E501 + + Human-readable description of the schema resource. # noqa: E501 + + :return: The description of this ScimSchemaResource. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this ScimSchemaResource. + + Human-readable description of the schema resource. # noqa: E501 + + :param description: The description of this ScimSchemaResource. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def attributes(self): + """Gets the attributes of this ScimSchemaResource. # noqa: E501 + + + :return: The attributes of this ScimSchemaResource. # noqa: E501 + :rtype: list[object] + """ + return self._attributes + + @attributes.setter + def attributes(self, attributes): + """Sets the attributes of this ScimSchemaResource. + + + :param attributes: The attributes of this ScimSchemaResource. # noqa: E501 + :type: list[object] + """ + + self._attributes = attributes + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ScimSchemaResource): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ScimSchemaResource): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/scim_schemas_list_response.py b/talon_one/models/scim_schemas_list_response.py new file mode 100644 index 0000000..9d8ad5f --- /dev/null +++ b/talon_one/models/scim_schemas_list_response.py @@ -0,0 +1,177 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ScimSchemasListResponse(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'resources': 'list[ScimSchemaResource]', + 'schemas': 'list[str]', + 'total_results': 'int' + } + + attribute_map = { + 'resources': 'Resources', + 'schemas': 'schemas', + 'total_results': 'totalResults' + } + + def __init__(self, resources=None, schemas=None, total_results=None, local_vars_configuration=None): # noqa: E501 + """ScimSchemasListResponse - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._resources = None + self._schemas = None + self._total_results = None + self.discriminator = None + + self.resources = resources + if schemas is not None: + self.schemas = schemas + if total_results is not None: + self.total_results = total_results + + @property + def resources(self): + """Gets the resources of this ScimSchemasListResponse. # noqa: E501 + + + :return: The resources of this ScimSchemasListResponse. # noqa: E501 + :rtype: list[ScimSchemaResource] + """ + return self._resources + + @resources.setter + def resources(self, resources): + """Sets the resources of this ScimSchemasListResponse. + + + :param resources: The resources of this ScimSchemasListResponse. # noqa: E501 + :type: list[ScimSchemaResource] + """ + if self.local_vars_configuration.client_side_validation and resources is None: # noqa: E501 + raise ValueError("Invalid value for `resources`, must not be `None`") # noqa: E501 + + self._resources = resources + + @property + def schemas(self): + """Gets the schemas of this ScimSchemasListResponse. # noqa: E501 + + SCIM schema for the given resource. # noqa: E501 + + :return: The schemas of this ScimSchemasListResponse. # noqa: E501 + :rtype: list[str] + """ + return self._schemas + + @schemas.setter + def schemas(self, schemas): + """Sets the schemas of this ScimSchemasListResponse. + + SCIM schema for the given resource. # noqa: E501 + + :param schemas: The schemas of this ScimSchemasListResponse. # noqa: E501 + :type: list[str] + """ + + self._schemas = schemas + + @property + def total_results(self): + """Gets the total_results of this ScimSchemasListResponse. # noqa: E501 + + Number of total results in the response. # noqa: E501 + + :return: The total_results of this ScimSchemasListResponse. # noqa: E501 + :rtype: int + """ + return self._total_results + + @total_results.setter + def total_results(self, total_results): + """Sets the total_results of this ScimSchemasListResponse. + + Number of total results in the response. # noqa: E501 + + :param total_results: The total_results of this ScimSchemasListResponse. # noqa: E501 + :type: int + """ + + self._total_results = total_results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ScimSchemasListResponse): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ScimSchemasListResponse): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/scim_service_provider_config_response.py b/talon_one/models/scim_service_provider_config_response.py new file mode 100644 index 0000000..36b7c44 --- /dev/null +++ b/talon_one/models/scim_service_provider_config_response.py @@ -0,0 +1,280 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ScimServiceProviderConfigResponse(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'bulk': 'ScimServiceProviderConfigResponseBulk', + 'change_password': 'ScimServiceProviderConfigResponseChangePassword', + 'documentation_uri': 'str', + 'filter': 'ScimServiceProviderConfigResponseFilter', + 'patch': 'ScimServiceProviderConfigResponsePatch', + 'schemas': 'list[str]', + 'sort': 'ScimServiceProviderConfigResponseSort' + } + + attribute_map = { + 'bulk': 'bulk', + 'change_password': 'changePassword', + 'documentation_uri': 'documentationUri', + 'filter': 'filter', + 'patch': 'patch', + 'schemas': 'schemas', + 'sort': 'sort' + } + + def __init__(self, bulk=None, change_password=None, documentation_uri=None, filter=None, patch=None, schemas=None, sort=None, local_vars_configuration=None): # noqa: E501 + """ScimServiceProviderConfigResponse - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._bulk = None + self._change_password = None + self._documentation_uri = None + self._filter = None + self._patch = None + self._schemas = None + self._sort = None + self.discriminator = None + + if bulk is not None: + self.bulk = bulk + if change_password is not None: + self.change_password = change_password + if documentation_uri is not None: + self.documentation_uri = documentation_uri + if filter is not None: + self.filter = filter + if patch is not None: + self.patch = patch + if schemas is not None: + self.schemas = schemas + if sort is not None: + self.sort = sort + + @property + def bulk(self): + """Gets the bulk of this ScimServiceProviderConfigResponse. # noqa: E501 + + + :return: The bulk of this ScimServiceProviderConfigResponse. # noqa: E501 + :rtype: ScimServiceProviderConfigResponseBulk + """ + return self._bulk + + @bulk.setter + def bulk(self, bulk): + """Sets the bulk of this ScimServiceProviderConfigResponse. + + + :param bulk: The bulk of this ScimServiceProviderConfigResponse. # noqa: E501 + :type: ScimServiceProviderConfigResponseBulk + """ + + self._bulk = bulk + + @property + def change_password(self): + """Gets the change_password of this ScimServiceProviderConfigResponse. # noqa: E501 + + + :return: The change_password of this ScimServiceProviderConfigResponse. # noqa: E501 + :rtype: ScimServiceProviderConfigResponseChangePassword + """ + return self._change_password + + @change_password.setter + def change_password(self, change_password): + """Sets the change_password of this ScimServiceProviderConfigResponse. + + + :param change_password: The change_password of this ScimServiceProviderConfigResponse. # noqa: E501 + :type: ScimServiceProviderConfigResponseChangePassword + """ + + self._change_password = change_password + + @property + def documentation_uri(self): + """Gets the documentation_uri of this ScimServiceProviderConfigResponse. # noqa: E501 + + The URI that points to the SCIM service provider's documentation, providing further details about the service's capabilities and usage. # noqa: E501 + + :return: The documentation_uri of this ScimServiceProviderConfigResponse. # noqa: E501 + :rtype: str + """ + return self._documentation_uri + + @documentation_uri.setter + def documentation_uri(self, documentation_uri): + """Sets the documentation_uri of this ScimServiceProviderConfigResponse. + + The URI that points to the SCIM service provider's documentation, providing further details about the service's capabilities and usage. # noqa: E501 + + :param documentation_uri: The documentation_uri of this ScimServiceProviderConfigResponse. # noqa: E501 + :type: str + """ + + self._documentation_uri = documentation_uri + + @property + def filter(self): + """Gets the filter of this ScimServiceProviderConfigResponse. # noqa: E501 + + + :return: The filter of this ScimServiceProviderConfigResponse. # noqa: E501 + :rtype: ScimServiceProviderConfigResponseFilter + """ + return self._filter + + @filter.setter + def filter(self, filter): + """Sets the filter of this ScimServiceProviderConfigResponse. + + + :param filter: The filter of this ScimServiceProviderConfigResponse. # noqa: E501 + :type: ScimServiceProviderConfigResponseFilter + """ + + self._filter = filter + + @property + def patch(self): + """Gets the patch of this ScimServiceProviderConfigResponse. # noqa: E501 + + + :return: The patch of this ScimServiceProviderConfigResponse. # noqa: E501 + :rtype: ScimServiceProviderConfigResponsePatch + """ + return self._patch + + @patch.setter + def patch(self, patch): + """Sets the patch of this ScimServiceProviderConfigResponse. + + + :param patch: The patch of this ScimServiceProviderConfigResponse. # noqa: E501 + :type: ScimServiceProviderConfigResponsePatch + """ + + self._patch = patch + + @property + def schemas(self): + """Gets the schemas of this ScimServiceProviderConfigResponse. # noqa: E501 + + A list of SCIM schemas that define the structure and data types supported by the service provider. # noqa: E501 + + :return: The schemas of this ScimServiceProviderConfigResponse. # noqa: E501 + :rtype: list[str] + """ + return self._schemas + + @schemas.setter + def schemas(self, schemas): + """Sets the schemas of this ScimServiceProviderConfigResponse. + + A list of SCIM schemas that define the structure and data types supported by the service provider. # noqa: E501 + + :param schemas: The schemas of this ScimServiceProviderConfigResponse. # noqa: E501 + :type: list[str] + """ + + self._schemas = schemas + + @property + def sort(self): + """Gets the sort of this ScimServiceProviderConfigResponse. # noqa: E501 + + + :return: The sort of this ScimServiceProviderConfigResponse. # noqa: E501 + :rtype: ScimServiceProviderConfigResponseSort + """ + return self._sort + + @sort.setter + def sort(self, sort): + """Sets the sort of this ScimServiceProviderConfigResponse. + + + :param sort: The sort of this ScimServiceProviderConfigResponse. # noqa: E501 + :type: ScimServiceProviderConfigResponseSort + """ + + self._sort = sort + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ScimServiceProviderConfigResponse): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ScimServiceProviderConfigResponse): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/scim_service_provider_config_response_bulk.py b/talon_one/models/scim_service_provider_config_response_bulk.py new file mode 100644 index 0000000..175c1a6 --- /dev/null +++ b/talon_one/models/scim_service_provider_config_response_bulk.py @@ -0,0 +1,178 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ScimServiceProviderConfigResponseBulk(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'max_operations': 'int', + 'max_payload_size': 'int', + 'supported': 'bool' + } + + attribute_map = { + 'max_operations': 'maxOperations', + 'max_payload_size': 'maxPayloadSize', + 'supported': 'supported' + } + + def __init__(self, max_operations=None, max_payload_size=None, supported=None, local_vars_configuration=None): # noqa: E501 + """ScimServiceProviderConfigResponseBulk - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._max_operations = None + self._max_payload_size = None + self._supported = None + self.discriminator = None + + if max_operations is not None: + self.max_operations = max_operations + if max_payload_size is not None: + self.max_payload_size = max_payload_size + if supported is not None: + self.supported = supported + + @property + def max_operations(self): + """Gets the max_operations of this ScimServiceProviderConfigResponseBulk. # noqa: E501 + + The maximum number of individual operations that can be included in a single bulk request. # noqa: E501 + + :return: The max_operations of this ScimServiceProviderConfigResponseBulk. # noqa: E501 + :rtype: int + """ + return self._max_operations + + @max_operations.setter + def max_operations(self, max_operations): + """Sets the max_operations of this ScimServiceProviderConfigResponseBulk. + + The maximum number of individual operations that can be included in a single bulk request. # noqa: E501 + + :param max_operations: The max_operations of this ScimServiceProviderConfigResponseBulk. # noqa: E501 + :type: int + """ + + self._max_operations = max_operations + + @property + def max_payload_size(self): + """Gets the max_payload_size of this ScimServiceProviderConfigResponseBulk. # noqa: E501 + + The maximum size, in bytes, of the entire payload for a bulk operation request. # noqa: E501 + + :return: The max_payload_size of this ScimServiceProviderConfigResponseBulk. # noqa: E501 + :rtype: int + """ + return self._max_payload_size + + @max_payload_size.setter + def max_payload_size(self, max_payload_size): + """Sets the max_payload_size of this ScimServiceProviderConfigResponseBulk. + + The maximum size, in bytes, of the entire payload for a bulk operation request. # noqa: E501 + + :param max_payload_size: The max_payload_size of this ScimServiceProviderConfigResponseBulk. # noqa: E501 + :type: int + """ + + self._max_payload_size = max_payload_size + + @property + def supported(self): + """Gets the supported of this ScimServiceProviderConfigResponseBulk. # noqa: E501 + + Indicates whether the SCIM service provider supports bulk operations. # noqa: E501 + + :return: The supported of this ScimServiceProviderConfigResponseBulk. # noqa: E501 + :rtype: bool + """ + return self._supported + + @supported.setter + def supported(self, supported): + """Sets the supported of this ScimServiceProviderConfigResponseBulk. + + Indicates whether the SCIM service provider supports bulk operations. # noqa: E501 + + :param supported: The supported of this ScimServiceProviderConfigResponseBulk. # noqa: E501 + :type: bool + """ + + self._supported = supported + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ScimServiceProviderConfigResponseBulk): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ScimServiceProviderConfigResponseBulk): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/scim_service_provider_config_response_change_password.py b/talon_one/models/scim_service_provider_config_response_change_password.py new file mode 100644 index 0000000..7d1ea26 --- /dev/null +++ b/talon_one/models/scim_service_provider_config_response_change_password.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ScimServiceProviderConfigResponseChangePassword(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'supported': 'bool' + } + + attribute_map = { + 'supported': 'supported' + } + + def __init__(self, supported=None, local_vars_configuration=None): # noqa: E501 + """ScimServiceProviderConfigResponseChangePassword - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._supported = None + self.discriminator = None + + if supported is not None: + self.supported = supported + + @property + def supported(self): + """Gets the supported of this ScimServiceProviderConfigResponseChangePassword. # noqa: E501 + + Indicates whether the service provider supports password changes via the SCIM API. # noqa: E501 + + :return: The supported of this ScimServiceProviderConfigResponseChangePassword. # noqa: E501 + :rtype: bool + """ + return self._supported + + @supported.setter + def supported(self, supported): + """Sets the supported of this ScimServiceProviderConfigResponseChangePassword. + + Indicates whether the service provider supports password changes via the SCIM API. # noqa: E501 + + :param supported: The supported of this ScimServiceProviderConfigResponseChangePassword. # noqa: E501 + :type: bool + """ + + self._supported = supported + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ScimServiceProviderConfigResponseChangePassword): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ScimServiceProviderConfigResponseChangePassword): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/scim_service_provider_config_response_filter.py b/talon_one/models/scim_service_provider_config_response_filter.py new file mode 100644 index 0000000..118c33b --- /dev/null +++ b/talon_one/models/scim_service_provider_config_response_filter.py @@ -0,0 +1,150 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ScimServiceProviderConfigResponseFilter(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'max_results': 'int', + 'supported': 'bool' + } + + attribute_map = { + 'max_results': 'maxResults', + 'supported': 'supported' + } + + def __init__(self, max_results=None, supported=None, local_vars_configuration=None): # noqa: E501 + """ScimServiceProviderConfigResponseFilter - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._max_results = None + self._supported = None + self.discriminator = None + + if max_results is not None: + self.max_results = max_results + if supported is not None: + self.supported = supported + + @property + def max_results(self): + """Gets the max_results of this ScimServiceProviderConfigResponseFilter. # noqa: E501 + + The maximum number of resources that can be returned in a single filtered query response. # noqa: E501 + + :return: The max_results of this ScimServiceProviderConfigResponseFilter. # noqa: E501 + :rtype: int + """ + return self._max_results + + @max_results.setter + def max_results(self, max_results): + """Sets the max_results of this ScimServiceProviderConfigResponseFilter. + + The maximum number of resources that can be returned in a single filtered query response. # noqa: E501 + + :param max_results: The max_results of this ScimServiceProviderConfigResponseFilter. # noqa: E501 + :type: int + """ + + self._max_results = max_results + + @property + def supported(self): + """Gets the supported of this ScimServiceProviderConfigResponseFilter. # noqa: E501 + + Indicates whether the SCIM service provider supports filtering operations. # noqa: E501 + + :return: The supported of this ScimServiceProviderConfigResponseFilter. # noqa: E501 + :rtype: bool + """ + return self._supported + + @supported.setter + def supported(self, supported): + """Sets the supported of this ScimServiceProviderConfigResponseFilter. + + Indicates whether the SCIM service provider supports filtering operations. # noqa: E501 + + :param supported: The supported of this ScimServiceProviderConfigResponseFilter. # noqa: E501 + :type: bool + """ + + self._supported = supported + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ScimServiceProviderConfigResponseFilter): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ScimServiceProviderConfigResponseFilter): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/scim_service_provider_config_response_patch.py b/talon_one/models/scim_service_provider_config_response_patch.py new file mode 100644 index 0000000..70d870a --- /dev/null +++ b/talon_one/models/scim_service_provider_config_response_patch.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ScimServiceProviderConfigResponsePatch(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'supported': 'bool' + } + + attribute_map = { + 'supported': 'supported' + } + + def __init__(self, supported=None, local_vars_configuration=None): # noqa: E501 + """ScimServiceProviderConfigResponsePatch - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._supported = None + self.discriminator = None + + if supported is not None: + self.supported = supported + + @property + def supported(self): + """Gets the supported of this ScimServiceProviderConfigResponsePatch. # noqa: E501 + + Indicates whether the service provider supports patch operations for modifying resources. # noqa: E501 + + :return: The supported of this ScimServiceProviderConfigResponsePatch. # noqa: E501 + :rtype: bool + """ + return self._supported + + @supported.setter + def supported(self, supported): + """Sets the supported of this ScimServiceProviderConfigResponsePatch. + + Indicates whether the service provider supports patch operations for modifying resources. # noqa: E501 + + :param supported: The supported of this ScimServiceProviderConfigResponsePatch. # noqa: E501 + :type: bool + """ + + self._supported = supported + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ScimServiceProviderConfigResponsePatch): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ScimServiceProviderConfigResponsePatch): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/scim_service_provider_config_response_sort.py b/talon_one/models/scim_service_provider_config_response_sort.py new file mode 100644 index 0000000..dc45078 --- /dev/null +++ b/talon_one/models/scim_service_provider_config_response_sort.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ScimServiceProviderConfigResponseSort(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'supported': 'bool' + } + + attribute_map = { + 'supported': 'supported' + } + + def __init__(self, supported=None, local_vars_configuration=None): # noqa: E501 + """ScimServiceProviderConfigResponseSort - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._supported = None + self.discriminator = None + + if supported is not None: + self.supported = supported + + @property + def supported(self): + """Gets the supported of this ScimServiceProviderConfigResponseSort. # noqa: E501 + + Indicates whether the service provider supports sorting operations for ordered query results. # noqa: E501 + + :return: The supported of this ScimServiceProviderConfigResponseSort. # noqa: E501 + :rtype: bool + """ + return self._supported + + @supported.setter + def supported(self, supported): + """Sets the supported of this ScimServiceProviderConfigResponseSort. + + Indicates whether the service provider supports sorting operations for ordered query results. # noqa: E501 + + :param supported: The supported of this ScimServiceProviderConfigResponseSort. # noqa: E501 + :type: bool + """ + + self._supported = supported + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ScimServiceProviderConfigResponseSort): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ScimServiceProviderConfigResponseSort): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/scim_user.py b/talon_one/models/scim_user.py index c7e46dc..37b4969 100644 --- a/talon_one/models/scim_user.py +++ b/talon_one/models/scim_user.py @@ -36,6 +36,7 @@ class ScimUser(object): 'active': 'bool', 'display_name': 'str', 'user_name': 'str', + 'name': 'ScimBaseUserName', 'id': 'str' } @@ -43,10 +44,11 @@ class ScimUser(object): 'active': 'active', 'display_name': 'displayName', 'user_name': 'userName', + 'name': 'name', 'id': 'id' } - def __init__(self, active=None, display_name=None, user_name=None, id=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, active=None, display_name=None, user_name=None, name=None, id=None, local_vars_configuration=None): # noqa: E501 """ScimUser - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -55,6 +57,7 @@ def __init__(self, active=None, display_name=None, user_name=None, id=None, loca self._active = None self._display_name = None self._user_name = None + self._name = None self._id = None self.discriminator = None @@ -63,6 +66,8 @@ def __init__(self, active=None, display_name=None, user_name=None, id=None, loca if display_name is not None: self.display_name = display_name self.user_name = user_name + if name is not None: + self.name = name self.id = id @property @@ -136,6 +141,27 @@ def user_name(self, user_name): self._user_name = user_name + @property + def name(self): + """Gets the name of this ScimUser. # noqa: E501 + + + :return: The name of this ScimUser. # noqa: E501 + :rtype: ScimBaseUserName + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this ScimUser. + + + :param name: The name of this ScimUser. # noqa: E501 + :type: ScimBaseUserName + """ + + self._name = name + @property def id(self): """Gets the id of this ScimUser. # noqa: E501 diff --git a/talon_one/models/scim_users_list_response.py b/talon_one/models/scim_users_list_response.py index bacbbd2..53625a2 100644 --- a/talon_one/models/scim_users_list_response.py +++ b/talon_one/models/scim_users_list_response.py @@ -88,6 +88,7 @@ def resources(self, resources): def schemas(self): """Gets the schemas of this ScimUsersListResponse. # noqa: E501 + SCIM schema for the given resource. # noqa: E501 :return: The schemas of this ScimUsersListResponse. # noqa: E501 :rtype: list[str] @@ -98,6 +99,7 @@ def schemas(self): def schemas(self, schemas): """Sets the schemas of this ScimUsersListResponse. + SCIM schema for the given resource. # noqa: E501 :param schemas: The schemas of this ScimUsersListResponse. # noqa: E501 :type: list[str] diff --git a/talon_one/models/store.py b/talon_one/models/store.py index c51eac6..72e9d75 100644 --- a/talon_one/models/store.py +++ b/talon_one/models/store.py @@ -114,7 +114,7 @@ def id(self, id): def created(self): """Gets the created of this Store. # noqa: E501 - The time this entity was created. The time this entity was created. # noqa: E501 + The time this entity was created. # noqa: E501 :return: The created of this Store. # noqa: E501 :rtype: datetime @@ -125,7 +125,7 @@ def created(self): def created(self, created): """Sets the created of this Store. - The time this entity was created. The time this entity was created. # noqa: E501 + The time this entity was created. # noqa: E501 :param created: The created of this Store. # noqa: E501 :type: datetime diff --git a/talon_one/models/strikethrough_debug_response.py b/talon_one/models/strikethrough_debug_response.py new file mode 100644 index 0000000..29fcb00 --- /dev/null +++ b/talon_one/models/strikethrough_debug_response.py @@ -0,0 +1,150 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class StrikethroughDebugResponse(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'campaigns_i_ds': 'list[int]', + 'effects': 'list[StrikethroughEffect]' + } + + attribute_map = { + 'campaigns_i_ds': 'campaignsIDs', + 'effects': 'effects' + } + + def __init__(self, campaigns_i_ds=None, effects=None, local_vars_configuration=None): # noqa: E501 + """StrikethroughDebugResponse - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._campaigns_i_ds = None + self._effects = None + self.discriminator = None + + if campaigns_i_ds is not None: + self.campaigns_i_ds = campaigns_i_ds + if effects is not None: + self.effects = effects + + @property + def campaigns_i_ds(self): + """Gets the campaigns_i_ds of this StrikethroughDebugResponse. # noqa: E501 + + The campaign IDs that got fetched for the evaluation process. # noqa: E501 + + :return: The campaigns_i_ds of this StrikethroughDebugResponse. # noqa: E501 + :rtype: list[int] + """ + return self._campaigns_i_ds + + @campaigns_i_ds.setter + def campaigns_i_ds(self, campaigns_i_ds): + """Sets the campaigns_i_ds of this StrikethroughDebugResponse. + + The campaign IDs that got fetched for the evaluation process. # noqa: E501 + + :param campaigns_i_ds: The campaigns_i_ds of this StrikethroughDebugResponse. # noqa: E501 + :type: list[int] + """ + + self._campaigns_i_ds = campaigns_i_ds + + @property + def effects(self): + """Gets the effects of this StrikethroughDebugResponse. # noqa: E501 + + The strikethrough effects that are returned from the evaluation process. # noqa: E501 + + :return: The effects of this StrikethroughDebugResponse. # noqa: E501 + :rtype: list[StrikethroughEffect] + """ + return self._effects + + @effects.setter + def effects(self, effects): + """Sets the effects of this StrikethroughDebugResponse. + + The strikethrough effects that are returned from the evaluation process. # noqa: E501 + + :param effects: The effects of this StrikethroughDebugResponse. # noqa: E501 + :type: list[StrikethroughEffect] + """ + + self._effects = effects + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, StrikethroughDebugResponse): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, StrikethroughDebugResponse): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/summary_campaign_store_budget.py b/talon_one/models/summary_campaign_store_budget.py new file mode 100644 index 0000000..4fabd4e --- /dev/null +++ b/talon_one/models/summary_campaign_store_budget.py @@ -0,0 +1,186 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class SummaryCampaignStoreBudget(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'action': 'str', + 'period': 'str', + 'store_count': 'int' + } + + attribute_map = { + 'action': 'action', + 'period': 'period', + 'store_count': 'storeCount' + } + + def __init__(self, action=None, period=None, store_count=None, local_vars_configuration=None): # noqa: E501 + """SummaryCampaignStoreBudget - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._action = None + self._period = None + self._store_count = None + self.discriminator = None + + self.action = action + if period is not None: + self.period = period + self.store_count = store_count + + @property + def action(self): + """Gets the action of this SummaryCampaignStoreBudget. # noqa: E501 + + + :return: The action of this SummaryCampaignStoreBudget. # noqa: E501 + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """Sets the action of this SummaryCampaignStoreBudget. + + + :param action: The action of this SummaryCampaignStoreBudget. # noqa: E501 + :type: str + """ + if self.local_vars_configuration.client_side_validation and action is None: # noqa: E501 + raise ValueError("Invalid value for `action`, must not be `None`") # noqa: E501 + allowed_values = ["redeemCoupon", "redeemReferral", "setDiscount", "setDiscountEffect", "createCoupon", "createReferral", "createLoyaltyPoints", "redeemLoyaltyPoints", "customEffect", "createLoyaltyPointsEffect", "redeemLoyaltyPointsEffect", "callApi", "awardGiveaway", "addFreeItemEffect", "reserveCoupon"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and action not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `action` ({0}), must be one of {1}" # noqa: E501 + .format(action, allowed_values) + ) + + self._action = action + + @property + def period(self): + """Gets the period of this SummaryCampaignStoreBudget. # noqa: E501 + + + :return: The period of this SummaryCampaignStoreBudget. # noqa: E501 + :rtype: str + """ + return self._period + + @period.setter + def period(self, period): + """Sets the period of this SummaryCampaignStoreBudget. + + + :param period: The period of this SummaryCampaignStoreBudget. # noqa: E501 + :type: str + """ + allowed_values = ["overall", "daily", "weekly", "monthly", "yearly"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and period not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `period` ({0}), must be one of {1}" # noqa: E501 + .format(period, allowed_values) + ) + + self._period = period + + @property + def store_count(self): + """Gets the store_count of this SummaryCampaignStoreBudget. # noqa: E501 + + + :return: The store_count of this SummaryCampaignStoreBudget. # noqa: E501 + :rtype: int + """ + return self._store_count + + @store_count.setter + def store_count(self, store_count): + """Sets the store_count of this SummaryCampaignStoreBudget. + + + :param store_count: The store_count of this SummaryCampaignStoreBudget. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and store_count is None: # noqa: E501 + raise ValueError("Invalid value for `store_count`, must not be `None`") # noqa: E501 + + self._store_count = store_count + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SummaryCampaignStoreBudget): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, SummaryCampaignStoreBudget): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/template_arg_def.py b/talon_one/models/template_arg_def.py index 2f72d7d..1449afa 100644 --- a/talon_one/models/template_arg_def.py +++ b/talon_one/models/template_arg_def.py @@ -37,6 +37,7 @@ class TemplateArgDef(object): 'description': 'str', 'title': 'str', 'ui': 'object', + 'key': 'str', 'picklist_id': 'int', 'restricted_by_picklist': 'bool' } @@ -46,11 +47,12 @@ class TemplateArgDef(object): 'description': 'description', 'title': 'title', 'ui': 'ui', + 'key': 'key', 'picklist_id': 'picklistID', 'restricted_by_picklist': 'restrictedByPicklist' } - def __init__(self, type=None, description=None, title=None, ui=None, picklist_id=None, restricted_by_picklist=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, type=None, description=None, title=None, ui=None, key=None, picklist_id=None, restricted_by_picklist=None, local_vars_configuration=None): # noqa: E501 """TemplateArgDef - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -60,6 +62,7 @@ def __init__(self, type=None, description=None, title=None, ui=None, picklist_id self._description = None self._title = None self._ui = None + self._key = None self._picklist_id = None self._restricted_by_picklist = None self.discriminator = None @@ -69,6 +72,8 @@ def __init__(self, type=None, description=None, title=None, ui=None, picklist_id self.description = description self.title = title self.ui = ui + if key is not None: + self.key = key if picklist_id is not None: self.picklist_id = picklist_id if restricted_by_picklist is not None: @@ -181,6 +186,29 @@ def ui(self, ui): self._ui = ui + @property + def key(self): + """Gets the key of this TemplateArgDef. # noqa: E501 + + The identifier for the associated value within the JSON object. # noqa: E501 + + :return: The key of this TemplateArgDef. # noqa: E501 + :rtype: str + """ + return self._key + + @key.setter + def key(self, key): + """Sets the key of this TemplateArgDef. + + The identifier for the associated value within the JSON object. # noqa: E501 + + :param key: The key of this TemplateArgDef. # noqa: E501 + :type: str + """ + + self._key = key + @property def picklist_id(self): """Gets the picklist_id of this TemplateArgDef. # noqa: E501 diff --git a/talon_one/models/template_limit_config.py b/talon_one/models/template_limit_config.py index d69ffe3..f2284eb 100644 --- a/talon_one/models/template_limit_config.py +++ b/talon_one/models/template_limit_config.py @@ -168,7 +168,7 @@ def entities(self, entities): """ if self.local_vars_configuration.client_side_validation and entities is None: # noqa: E501 raise ValueError("Invalid value for `entities`, must not be `None`") # noqa: E501 - allowed_values = ["Coupon", "Referral", "Profile", "Identifier"] # noqa: E501 + allowed_values = ["Coupon", "Referral", "Profile", "Identifier", "Store", "Session"] # noqa: E501 if (self.local_vars_configuration.client_side_validation and not set(entities).issubset(set(allowed_values))): # noqa: E501 raise ValueError( diff --git a/talon_one/models/transfer_loyalty_card.py b/talon_one/models/transfer_loyalty_card.py index a9ffdf0..9a1f6e9 100644 --- a/talon_one/models/transfer_loyalty_card.py +++ b/talon_one/models/transfer_loyalty_card.py @@ -81,6 +81,9 @@ def new_card_identifier(self, new_card_identifier): if (self.local_vars_configuration.client_side_validation and new_card_identifier is not None and len(new_card_identifier) > 108): raise ValueError("Invalid value for `new_card_identifier`, length must be less than or equal to `108`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + new_card_identifier is not None and not re.search(r'^[A-Za-z0-9_-]*$', new_card_identifier)): # noqa: E501 + raise ValueError(r"Invalid value for `new_card_identifier`, must be a follow pattern or equal to `/^[A-Za-z0-9_-]*$/`") # noqa: E501 self._new_card_identifier = new_card_identifier diff --git a/talon_one/models/update_achievement.py b/talon_one/models/update_achievement.py index 997a1e2..ebc21b0 100644 --- a/talon_one/models/update_achievement.py +++ b/talon_one/models/update_achievement.py @@ -38,7 +38,11 @@ class UpdateAchievement(object): 'description': 'str', 'target': 'float', 'period': 'str', - 'period_end_override': 'TimePoint' + 'period_end_override': 'TimePoint', + 'recurrence_policy': 'str', + 'activation_policy': 'str', + 'fixed_start_date': 'datetime', + 'end_date': 'datetime' } attribute_map = { @@ -47,10 +51,14 @@ class UpdateAchievement(object): 'description': 'description', 'target': 'target', 'period': 'period', - 'period_end_override': 'periodEndOverride' + 'period_end_override': 'periodEndOverride', + 'recurrence_policy': 'recurrencePolicy', + 'activation_policy': 'activationPolicy', + 'fixed_start_date': 'fixedStartDate', + 'end_date': 'endDate' } - def __init__(self, name=None, title=None, description=None, target=None, period=None, period_end_override=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, name=None, title=None, description=None, target=None, period=None, period_end_override=None, recurrence_policy=None, activation_policy=None, fixed_start_date=None, end_date=None, local_vars_configuration=None): # noqa: E501 """UpdateAchievement - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -62,6 +70,10 @@ def __init__(self, name=None, title=None, description=None, target=None, period= self._target = None self._period = None self._period_end_override = None + self._recurrence_policy = None + self._activation_policy = None + self._fixed_start_date = None + self._end_date = None self.discriminator = None if name is not None: @@ -76,6 +88,14 @@ def __init__(self, name=None, title=None, description=None, target=None, period= self.period = period if period_end_override is not None: self.period_end_override = period_end_override + if recurrence_policy is not None: + self.recurrence_policy = recurrence_policy + if activation_policy is not None: + self.activation_policy = activation_policy + if fixed_start_date is not None: + self.fixed_start_date = fixed_start_date + if end_date is not None: + self.end_date = end_date @property def name(self): @@ -222,6 +242,110 @@ def period_end_override(self, period_end_override): self._period_end_override = period_end_override + @property + def recurrence_policy(self): + """Gets the recurrence_policy of this UpdateAchievement. # noqa: E501 + + The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. # noqa: E501 + + :return: The recurrence_policy of this UpdateAchievement. # noqa: E501 + :rtype: str + """ + return self._recurrence_policy + + @recurrence_policy.setter + def recurrence_policy(self, recurrence_policy): + """Sets the recurrence_policy of this UpdateAchievement. + + The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. # noqa: E501 + + :param recurrence_policy: The recurrence_policy of this UpdateAchievement. # noqa: E501 + :type: str + """ + allowed_values = ["no_recurrence", "on_expiration"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and recurrence_policy not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `recurrence_policy` ({0}), must be one of {1}" # noqa: E501 + .format(recurrence_policy, allowed_values) + ) + + self._recurrence_policy = recurrence_policy + + @property + def activation_policy(self): + """Gets the activation_policy of this UpdateAchievement. # noqa: E501 + + The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. # noqa: E501 + + :return: The activation_policy of this UpdateAchievement. # noqa: E501 + :rtype: str + """ + return self._activation_policy + + @activation_policy.setter + def activation_policy(self, activation_policy): + """Sets the activation_policy of this UpdateAchievement. + + The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. # noqa: E501 + + :param activation_policy: The activation_policy of this UpdateAchievement. # noqa: E501 + :type: str + """ + allowed_values = ["user_action", "fixed_schedule"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and activation_policy not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `activation_policy` ({0}), must be one of {1}" # noqa: E501 + .format(activation_policy, allowed_values) + ) + + self._activation_policy = activation_policy + + @property + def fixed_start_date(self): + """Gets the fixed_start_date of this UpdateAchievement. # noqa: E501 + + The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :return: The fixed_start_date of this UpdateAchievement. # noqa: E501 + :rtype: datetime + """ + return self._fixed_start_date + + @fixed_start_date.setter + def fixed_start_date(self, fixed_start_date): + """Sets the fixed_start_date of this UpdateAchievement. + + The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :param fixed_start_date: The fixed_start_date of this UpdateAchievement. # noqa: E501 + :type: datetime + """ + + self._fixed_start_date = fixed_start_date + + @property + def end_date(self): + """Gets the end_date of this UpdateAchievement. # noqa: E501 + + The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :return: The end_date of this UpdateAchievement. # noqa: E501 + :rtype: datetime + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this UpdateAchievement. + + The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. # noqa: E501 + + :param end_date: The end_date of this UpdateAchievement. # noqa: E501 + :type: datetime + """ + + self._end_date = end_date + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/talon_one/models/update_application.py b/talon_one/models/update_application.py index e48609a..6f62c7d 100644 --- a/talon_one/models/update_application.py +++ b/talon_one/models/update_application.py @@ -48,6 +48,7 @@ class UpdateApplication(object): 'enable_partial_discounts': 'bool', 'default_discount_additional_cost_per_item_scope': 'str', 'default_evaluation_group_id': 'int', + 'default_cart_item_filter_id': 'int', 'enable_campaign_state_management': 'bool' } @@ -67,10 +68,11 @@ class UpdateApplication(object): 'enable_partial_discounts': 'enablePartialDiscounts', 'default_discount_additional_cost_per_item_scope': 'defaultDiscountAdditionalCostPerItemScope', 'default_evaluation_group_id': 'defaultEvaluationGroupId', + 'default_cart_item_filter_id': 'defaultCartItemFilterId', 'enable_campaign_state_management': 'enableCampaignStateManagement' } - def __init__(self, name=None, description=None, timezone=None, currency=None, case_sensitivity=None, attributes=None, limits=None, default_discount_scope=None, enable_cascading_discounts=None, enable_flattened_cart_items=None, attributes_settings=None, sandbox=None, enable_partial_discounts=None, default_discount_additional_cost_per_item_scope=None, default_evaluation_group_id=None, enable_campaign_state_management=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, name=None, description=None, timezone=None, currency=None, case_sensitivity=None, attributes=None, limits=None, default_discount_scope=None, enable_cascading_discounts=None, enable_flattened_cart_items=None, attributes_settings=None, sandbox=None, enable_partial_discounts=None, default_discount_additional_cost_per_item_scope=None, default_evaluation_group_id=None, default_cart_item_filter_id=None, enable_campaign_state_management=None, local_vars_configuration=None): # noqa: E501 """UpdateApplication - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -91,6 +93,7 @@ def __init__(self, name=None, description=None, timezone=None, currency=None, ca self._enable_partial_discounts = None self._default_discount_additional_cost_per_item_scope = None self._default_evaluation_group_id = None + self._default_cart_item_filter_id = None self._enable_campaign_state_management = None self.discriminator = None @@ -121,6 +124,8 @@ def __init__(self, name=None, description=None, timezone=None, currency=None, ca self.default_discount_additional_cost_per_item_scope = default_discount_additional_cost_per_item_scope if default_evaluation_group_id is not None: self.default_evaluation_group_id = default_evaluation_group_id + if default_cart_item_filter_id is not None: + self.default_cart_item_filter_id = default_cart_item_filter_id if enable_campaign_state_management is not None: self.enable_campaign_state_management = enable_campaign_state_management @@ -500,6 +505,29 @@ def default_evaluation_group_id(self, default_evaluation_group_id): self._default_evaluation_group_id = default_evaluation_group_id + @property + def default_cart_item_filter_id(self): + """Gets the default_cart_item_filter_id of this UpdateApplication. # noqa: E501 + + The ID of the default Cart-Item-Filter for this application. # noqa: E501 + + :return: The default_cart_item_filter_id of this UpdateApplication. # noqa: E501 + :rtype: int + """ + return self._default_cart_item_filter_id + + @default_cart_item_filter_id.setter + def default_cart_item_filter_id(self, default_cart_item_filter_id): + """Sets the default_cart_item_filter_id of this UpdateApplication. + + The ID of the default Cart-Item-Filter for this application. # noqa: E501 + + :param default_cart_item_filter_id: The default_cart_item_filter_id of this UpdateApplication. # noqa: E501 + :type: int + """ + + self._default_cart_item_filter_id = default_cart_item_filter_id + @property def enable_campaign_state_management(self): """Gets the enable_campaign_state_management of this UpdateApplication. # noqa: E501 diff --git a/talon_one/models/update_application_cif.py b/talon_one/models/update_application_cif.py new file mode 100644 index 0000000..7c464cc --- /dev/null +++ b/talon_one/models/update_application_cif.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class UpdateApplicationCIF(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'description': 'str', + 'active_expression_id': 'int', + 'modified_by': 'int', + 'modified': 'datetime' + } + + attribute_map = { + 'description': 'description', + 'active_expression_id': 'activeExpressionId', + 'modified_by': 'modifiedBy', + 'modified': 'modified' + } + + def __init__(self, description=None, active_expression_id=None, modified_by=None, modified=None, local_vars_configuration=None): # noqa: E501 + """UpdateApplicationCIF - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._description = None + self._active_expression_id = None + self._modified_by = None + self._modified = None + self.discriminator = None + + if description is not None: + self.description = description + if active_expression_id is not None: + self.active_expression_id = active_expression_id + if modified_by is not None: + self.modified_by = modified_by + if modified is not None: + self.modified = modified + + @property + def description(self): + """Gets the description of this UpdateApplicationCIF. # noqa: E501 + + A short description of the Application cart item filter. # noqa: E501 + + :return: The description of this UpdateApplicationCIF. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this UpdateApplicationCIF. + + A short description of the Application cart item filter. # noqa: E501 + + :param description: The description of this UpdateApplicationCIF. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def active_expression_id(self): + """Gets the active_expression_id of this UpdateApplicationCIF. # noqa: E501 + + The ID of the expression that the Application cart item filter uses. # noqa: E501 + + :return: The active_expression_id of this UpdateApplicationCIF. # noqa: E501 + :rtype: int + """ + return self._active_expression_id + + @active_expression_id.setter + def active_expression_id(self, active_expression_id): + """Sets the active_expression_id of this UpdateApplicationCIF. + + The ID of the expression that the Application cart item filter uses. # noqa: E501 + + :param active_expression_id: The active_expression_id of this UpdateApplicationCIF. # noqa: E501 + :type: int + """ + + self._active_expression_id = active_expression_id + + @property + def modified_by(self): + """Gets the modified_by of this UpdateApplicationCIF. # noqa: E501 + + The ID of the user who last updated the Application cart item filter. # noqa: E501 + + :return: The modified_by of this UpdateApplicationCIF. # noqa: E501 + :rtype: int + """ + return self._modified_by + + @modified_by.setter + def modified_by(self, modified_by): + """Sets the modified_by of this UpdateApplicationCIF. + + The ID of the user who last updated the Application cart item filter. # noqa: E501 + + :param modified_by: The modified_by of this UpdateApplicationCIF. # noqa: E501 + :type: int + """ + + self._modified_by = modified_by + + @property + def modified(self): + """Gets the modified of this UpdateApplicationCIF. # noqa: E501 + + Timestamp of the most recent update to the Application cart item filter. # noqa: E501 + + :return: The modified of this UpdateApplicationCIF. # noqa: E501 + :rtype: datetime + """ + return self._modified + + @modified.setter + def modified(self, modified): + """Sets the modified of this UpdateApplicationCIF. + + Timestamp of the most recent update to the Application cart item filter. # noqa: E501 + + :param modified: The modified of this UpdateApplicationCIF. # noqa: E501 + :type: datetime + """ + + self._modified = modified + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdateApplicationCIF): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, UpdateApplicationCIF): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/update_campaign.py b/talon_one/models/update_campaign.py index 75d8976..1121020 100644 --- a/talon_one/models/update_campaign.py +++ b/talon_one/models/update_campaign.py @@ -499,7 +499,7 @@ def type(self, type): def linked_store_ids(self): """Gets the linked_store_ids of this UpdateCampaign. # noqa: E501 - A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. # noqa: E501 + A list of store IDs that you want to link to the campaign. **Note:** - Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty. - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file. # noqa: E501 :return: The linked_store_ids of this UpdateCampaign. # noqa: E501 :rtype: list[int] @@ -510,7 +510,7 @@ def linked_store_ids(self): def linked_store_ids(self, linked_store_ids): """Sets the linked_store_ids of this UpdateCampaign. - A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. # noqa: E501 + A list of store IDs that you want to link to the campaign. **Note:** - Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty. - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file. # noqa: E501 :param linked_store_ids: The linked_store_ids of this UpdateCampaign. # noqa: E501 :type: list[int] diff --git a/talon_one/models/update_campaign_template.py b/talon_one/models/update_campaign_template.py index 1e53171..d30f835 100644 --- a/talon_one/models/update_campaign_template.py +++ b/talon_one/models/update_campaign_template.py @@ -43,6 +43,7 @@ class UpdateCampaignTemplate(object): 'tags': 'list[str]', 'features': 'list[str]', 'coupon_settings': 'CodeGeneratorSettings', + 'coupon_reservation_settings': 'CampaignTemplateCouponReservationSettings', 'referral_settings': 'CodeGeneratorSettings', 'limits': 'list[TemplateLimitConfig]', 'template_params': 'list[CampaignTemplateParams]', @@ -63,6 +64,7 @@ class UpdateCampaignTemplate(object): 'tags': 'tags', 'features': 'features', 'coupon_settings': 'couponSettings', + 'coupon_reservation_settings': 'couponReservationSettings', 'referral_settings': 'referralSettings', 'limits': 'limits', 'template_params': 'templateParams', @@ -72,7 +74,7 @@ class UpdateCampaignTemplate(object): 'campaign_type': 'campaignType' } - def __init__(self, name=None, description=None, instructions=None, campaign_attributes=None, coupon_attributes=None, state=None, active_ruleset_id=None, tags=None, features=None, coupon_settings=None, referral_settings=None, limits=None, template_params=None, applications_ids=None, campaign_collections=None, default_campaign_group_id=None, campaign_type='advanced', local_vars_configuration=None): # noqa: E501 + def __init__(self, name=None, description=None, instructions=None, campaign_attributes=None, coupon_attributes=None, state=None, active_ruleset_id=None, tags=None, features=None, coupon_settings=None, coupon_reservation_settings=None, referral_settings=None, limits=None, template_params=None, applications_ids=None, campaign_collections=None, default_campaign_group_id=None, campaign_type='advanced', local_vars_configuration=None): # noqa: E501 """UpdateCampaignTemplate - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -88,6 +90,7 @@ def __init__(self, name=None, description=None, instructions=None, campaign_attr self._tags = None self._features = None self._coupon_settings = None + self._coupon_reservation_settings = None self._referral_settings = None self._limits = None self._template_params = None @@ -113,6 +116,8 @@ def __init__(self, name=None, description=None, instructions=None, campaign_attr self.features = features if coupon_settings is not None: self.coupon_settings = coupon_settings + if coupon_reservation_settings is not None: + self.coupon_reservation_settings = coupon_reservation_settings if referral_settings is not None: self.referral_settings = referral_settings if limits is not None: @@ -380,6 +385,27 @@ def coupon_settings(self, coupon_settings): self._coupon_settings = coupon_settings + @property + def coupon_reservation_settings(self): + """Gets the coupon_reservation_settings of this UpdateCampaignTemplate. # noqa: E501 + + + :return: The coupon_reservation_settings of this UpdateCampaignTemplate. # noqa: E501 + :rtype: CampaignTemplateCouponReservationSettings + """ + return self._coupon_reservation_settings + + @coupon_reservation_settings.setter + def coupon_reservation_settings(self, coupon_reservation_settings): + """Sets the coupon_reservation_settings of this UpdateCampaignTemplate. + + + :param coupon_reservation_settings: The coupon_reservation_settings of this UpdateCampaignTemplate. # noqa: E501 + :type: CampaignTemplateCouponReservationSettings + """ + + self._coupon_reservation_settings = coupon_reservation_settings + @property def referral_settings(self): """Gets the referral_settings of this UpdateCampaignTemplate. # noqa: E501 diff --git a/talon_one/models/update_loyalty_program.py b/talon_one/models/update_loyalty_program.py index 5647200..7dc4644 100644 --- a/talon_one/models/update_loyalty_program.py +++ b/talon_one/models/update_loyalty_program.py @@ -47,6 +47,7 @@ class UpdateLoyaltyProgram(object): 'tiers_expire_in': 'str', 'tiers_downgrade_policy': 'str', 'card_code_settings': 'CodeGeneratorSettings', + 'return_policy': 'str', 'tiers': 'list[NewLoyaltyTier]' } @@ -65,10 +66,11 @@ class UpdateLoyaltyProgram(object): 'tiers_expire_in': 'tiersExpireIn', 'tiers_downgrade_policy': 'tiersDowngradePolicy', 'card_code_settings': 'cardCodeSettings', + 'return_policy': 'returnPolicy', 'tiers': 'tiers' } - def __init__(self, title=None, description=None, subscribed_applications=None, default_validity=None, default_pending=None, allow_subledger=None, users_per_card_limit=None, sandbox=None, program_join_policy=None, tiers_expiration_policy=None, tier_cycle_start_date=None, tiers_expire_in=None, tiers_downgrade_policy=None, card_code_settings=None, tiers=None, local_vars_configuration=None): # noqa: E501 + def __init__(self, title=None, description=None, subscribed_applications=None, default_validity=None, default_pending=None, allow_subledger=None, users_per_card_limit=None, sandbox=None, program_join_policy=None, tiers_expiration_policy=None, tier_cycle_start_date=None, tiers_expire_in=None, tiers_downgrade_policy=None, card_code_settings=None, return_policy=None, tiers=None, local_vars_configuration=None): # noqa: E501 """UpdateLoyaltyProgram - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() @@ -88,6 +90,7 @@ def __init__(self, title=None, description=None, subscribed_applications=None, d self._tiers_expire_in = None self._tiers_downgrade_policy = None self._card_code_settings = None + self._return_policy = None self._tiers = None self.discriminator = None @@ -119,6 +122,8 @@ def __init__(self, title=None, description=None, subscribed_applications=None, d self.tiers_downgrade_policy = tiers_downgrade_policy if card_code_settings is not None: self.card_code_settings = card_code_settings + if return_policy is not None: + self.return_policy = return_policy if tiers is not None: self.tiers = tiers @@ -463,6 +468,35 @@ def card_code_settings(self, card_code_settings): self._card_code_settings = card_code_settings + @property + def return_policy(self): + """Gets the return_policy of this UpdateLoyaltyProgram. # noqa: E501 + + The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. # noqa: E501 + + :return: The return_policy of this UpdateLoyaltyProgram. # noqa: E501 + :rtype: str + """ + return self._return_policy + + @return_policy.setter + def return_policy(self, return_policy): + """Sets the return_policy of this UpdateLoyaltyProgram. + + The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. # noqa: E501 + + :param return_policy: The return_policy of this UpdateLoyaltyProgram. # noqa: E501 + :type: str + """ + allowed_values = ["only_pending", "within_balance"] # noqa: E501 + if self.local_vars_configuration.client_side_validation and return_policy not in allowed_values: # noqa: E501 + raise ValueError( + "Invalid value for `return_policy` ({0}), must be one of {1}" # noqa: E501 + .format(return_policy, allowed_values) + ) + + self._return_policy = return_policy + @property def tiers(self): """Gets the tiers of this UpdateLoyaltyProgram. # noqa: E501 diff --git a/talon_one/models/update_loyalty_program_tier.py b/talon_one/models/update_loyalty_program_tier.py new file mode 100644 index 0000000..f330e9e --- /dev/null +++ b/talon_one/models/update_loyalty_program_tier.py @@ -0,0 +1,185 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class UpdateLoyaltyProgramTier(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'id': 'int', + 'name': 'str', + 'min_points': 'float' + } + + attribute_map = { + 'id': 'id', + 'name': 'name', + 'min_points': 'minPoints' + } + + def __init__(self, id=None, name=None, min_points=None, local_vars_configuration=None): # noqa: E501 + """UpdateLoyaltyProgramTier - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._id = None + self._name = None + self._min_points = None + self.discriminator = None + + self.id = id + if name is not None: + self.name = name + if min_points is not None: + self.min_points = min_points + + @property + def id(self): + """Gets the id of this UpdateLoyaltyProgramTier. # noqa: E501 + + The internal ID of the tier. # noqa: E501 + + :return: The id of this UpdateLoyaltyProgramTier. # noqa: E501 + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this UpdateLoyaltyProgramTier. + + The internal ID of the tier. # noqa: E501 + + :param id: The id of this UpdateLoyaltyProgramTier. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501 + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + @property + def name(self): + """Gets the name of this UpdateLoyaltyProgramTier. # noqa: E501 + + The name of the tier. # noqa: E501 + + :return: The name of this UpdateLoyaltyProgramTier. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this UpdateLoyaltyProgramTier. + + The name of the tier. # noqa: E501 + + :param name: The name of this UpdateLoyaltyProgramTier. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def min_points(self): + """Gets the min_points of this UpdateLoyaltyProgramTier. # noqa: E501 + + The minimum amount of points required to enter the tier. # noqa: E501 + + :return: The min_points of this UpdateLoyaltyProgramTier. # noqa: E501 + :rtype: float + """ + return self._min_points + + @min_points.setter + def min_points(self, min_points): + """Sets the min_points of this UpdateLoyaltyProgramTier. + + The minimum amount of points required to enter the tier. # noqa: E501 + + :param min_points: The min_points of this UpdateLoyaltyProgramTier. # noqa: E501 + :type: float + """ + if (self.local_vars_configuration.client_side_validation and + min_points is not None and min_points > 999999999999.99): # noqa: E501 + raise ValueError("Invalid value for `min_points`, must be a value less than or equal to `999999999999.99`") # noqa: E501 + if (self.local_vars_configuration.client_side_validation and + min_points is not None and min_points < 0): # noqa: E501 + raise ValueError("Invalid value for `min_points`, must be a value greater than or equal to `0`") # noqa: E501 + + self._min_points = min_points + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdateLoyaltyProgramTier): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, UpdateLoyaltyProgramTier): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/value_map.py b/talon_one/models/value_map.py new file mode 100644 index 0000000..39c8bcd --- /dev/null +++ b/talon_one/models/value_map.py @@ -0,0 +1,204 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from talon_one.configuration import Configuration + + +class ValueMap(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'id': 'int', + 'created': 'datetime', + 'created_by': 'int', + 'campaign_id': 'int' + } + + attribute_map = { + 'id': 'id', + 'created': 'created', + 'created_by': 'createdBy', + 'campaign_id': 'campaignId' + } + + def __init__(self, id=None, created=None, created_by=None, campaign_id=None, local_vars_configuration=None): # noqa: E501 + """ValueMap - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._id = None + self._created = None + self._created_by = None + self._campaign_id = None + self.discriminator = None + + self.id = id + if created is not None: + self.created = created + if created_by is not None: + self.created_by = created_by + self.campaign_id = campaign_id + + @property + def id(self): + """Gets the id of this ValueMap. # noqa: E501 + + Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. # noqa: E501 + + :return: The id of this ValueMap. # noqa: E501 + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this ValueMap. + + Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. # noqa: E501 + + :param id: The id of this ValueMap. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501 + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + @property + def created(self): + """Gets the created of this ValueMap. # noqa: E501 + + + :return: The created of this ValueMap. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this ValueMap. + + + :param created: The created of this ValueMap. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def created_by(self): + """Gets the created_by of this ValueMap. # noqa: E501 + + The ID of the user who created the value map. # noqa: E501 + + :return: The created_by of this ValueMap. # noqa: E501 + :rtype: int + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """Sets the created_by of this ValueMap. + + The ID of the user who created the value map. # noqa: E501 + + :param created_by: The created_by of this ValueMap. # noqa: E501 + :type: int + """ + + self._created_by = created_by + + @property + def campaign_id(self): + """Gets the campaign_id of this ValueMap. # noqa: E501 + + + :return: The campaign_id of this ValueMap. # noqa: E501 + :rtype: int + """ + return self._campaign_id + + @campaign_id.setter + def campaign_id(self, campaign_id): + """Sets the campaign_id of this ValueMap. + + + :param campaign_id: The campaign_id of this ValueMap. # noqa: E501 + :type: int + """ + if self.local_vars_configuration.client_side_validation and campaign_id is None: # noqa: E501 + raise ValueError("Invalid value for `campaign_id`, must not be `None`") # noqa: E501 + + self._campaign_id = campaign_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ValueMap): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, ValueMap): + return True + + return self.to_dict() != other.to_dict() diff --git a/talon_one/models/webhook.py b/talon_one/models/webhook.py index d39fb8f..c6bca3b 100644 --- a/talon_one/models/webhook.py +++ b/talon_one/models/webhook.py @@ -176,7 +176,7 @@ def modified(self, modified): def application_ids(self): """Gets the application_ids of this Webhook. # noqa: E501 - The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity. # noqa: E501 + The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. # noqa: E501 :return: The application_ids of this Webhook. # noqa: E501 :rtype: list[int] @@ -187,7 +187,7 @@ def application_ids(self): def application_ids(self, application_ids): """Sets the application_ids of this Webhook. - The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity. # noqa: E501 + The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. # noqa: E501 :param application_ids: The application_ids of this Webhook. # noqa: E501 :type: list[int] diff --git a/talon_one/models/webhook_log_entry.py b/talon_one/models/webhook_log_entry.py index c6ac75c..92f4a28 100644 --- a/talon_one/models/webhook_log_entry.py +++ b/talon_one/models/webhook_log_entry.py @@ -193,7 +193,7 @@ def application_id(self, application_id): def url(self): """Gets the url of this WebhookLogEntry. # noqa: E501 - Target url of request # noqa: E501 + The target URL of the request. # noqa: E501 :return: The url of this WebhookLogEntry. # noqa: E501 :rtype: str @@ -204,7 +204,7 @@ def url(self): def url(self, url): """Sets the url of this WebhookLogEntry. - Target url of request # noqa: E501 + The target URL of the request. # noqa: E501 :param url: The url of this WebhookLogEntry. # noqa: E501 :type: str diff --git a/talon_one/models/webhook_with_outgoing_integration_details.py b/talon_one/models/webhook_with_outgoing_integration_details.py index 50cbf61..8e261e4 100644 --- a/talon_one/models/webhook_with_outgoing_integration_details.py +++ b/talon_one/models/webhook_with_outgoing_integration_details.py @@ -191,7 +191,7 @@ def modified(self, modified): def application_ids(self): """Gets the application_ids of this WebhookWithOutgoingIntegrationDetails. # noqa: E501 - The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity. # noqa: E501 + The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. # noqa: E501 :return: The application_ids of this WebhookWithOutgoingIntegrationDetails. # noqa: E501 :rtype: list[int] @@ -202,7 +202,7 @@ def application_ids(self): def application_ids(self, application_ids): """Sets the application_ids of this WebhookWithOutgoingIntegrationDetails. - The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity. # noqa: E501 + The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. # noqa: E501 :param application_ids: The application_ids of this WebhookWithOutgoingIntegrationDetails. # noqa: E501 :type: list[int] diff --git a/test/test_account_analytics.py b/test/test_account_analytics.py index aba4267..bdc09f0 100644 --- a/test/test_account_analytics.py +++ b/test/test_account_analytics.py @@ -55,7 +55,7 @@ def make_instance(self, include_optional): webhooks = 2, loyalty_programs = 5, live_loyalty_programs = 5, - last_updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + last_updated_at = '2022-12-12T12:12:12Z' ) else : return AccountAnalytics( @@ -78,7 +78,7 @@ def make_instance(self, include_optional): webhooks = 2, loyalty_programs = 5, live_loyalty_programs = 5, - last_updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + last_updated_at = '2022-12-12T12:12:12Z', ) def testAccountAnalytics(self): diff --git a/test/test_achievement.py b/test/test_achievement.py index 6a54bfa..8dda78e 100644 --- a/test/test_achievement.py +++ b/test/test_achievement.py @@ -44,6 +44,10 @@ def make_instance(self, include_optional): target = 50.0, period = '1Y', period_end_override = {month=11, dayOfMonth=23, hour=23, minute=59, second=59}, + recurrence_policy = 'no_recurrence', + activation_policy = 'fixed_schedule', + fixed_start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), campaign_id = 1, user_id = 1234, created_by = 'John Doe', diff --git a/test/test_achievement_progress.py b/test/test_achievement_progress.py index 691f6e6..60781a8 100644 --- a/test/test_achievement_progress.py +++ b/test/test_achievement_progress.py @@ -39,6 +39,7 @@ def make_instance(self, include_optional): achievement_id = 3, name = 'FreeCoffee10Orders', title = '50% off on 50th purchase.', + description = '50% off for every 50th purchase in a year.', campaign_id = 3, status = 'completed', target = 10.0, @@ -52,6 +53,7 @@ def make_instance(self, include_optional): achievement_id = 3, name = 'FreeCoffee10Orders', title = '50% off on 50th purchase.', + description = '50% off for every 50th purchase in a year.', campaign_id = 3, status = 'completed', progress = 10.0, diff --git a/test/test_analytics_product.py b/test/test_analytics_product.py new file mode 100644 index 0000000..88c80d0 --- /dev/null +++ b/test/test_analytics_product.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.analytics_product import AnalyticsProduct # noqa: E501 +from talon_one.rest import ApiException + +class TestAnalyticsProduct(unittest.TestCase): + """AnalyticsProduct unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test AnalyticsProduct + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.analytics_product.AnalyticsProduct() # noqa: E501 + if include_optional : + return AnalyticsProduct( + id = 1, + is_preliminary = False, + name = 'MyProduct', + catalog_id = 1 + ) + else : + return AnalyticsProduct( + id = 1, + is_preliminary = False, + name = 'MyProduct', + ) + + def testAnalyticsProduct(self): + """Test AnalyticsProduct""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_analytics_product_sku.py b/test/test_analytics_product_sku.py new file mode 100644 index 0000000..510292b --- /dev/null +++ b/test/test_analytics_product_sku.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.analytics_product_sku import AnalyticsProductSKU # noqa: E501 +from talon_one.rest import ApiException + +class TestAnalyticsProductSKU(unittest.TestCase): + """AnalyticsProductSKU unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test AnalyticsProductSKU + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.analytics_product_sku.AnalyticsProductSKU() # noqa: E501 + if include_optional : + return AnalyticsProductSKU( + id = 1, + sku = 'SKU-123', + last_updated = '2024-02-01T00:00Z' + ) + else : + return AnalyticsProductSKU( + id = 1, + sku = 'SKU-123', + last_updated = '2024-02-01T00:00Z', + ) + + def testAnalyticsProductSKU(self): + """Test AnalyticsProductSKU""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_application.py b/test/test_application.py index 23d3f48..20eef34 100644 --- a/test/test_application.py +++ b/test/test_application.py @@ -68,10 +68,11 @@ def make_instance(self, include_optional): enable_partial_discounts = False, default_discount_additional_cost_per_item_scope = 'price', default_evaluation_group_id = 3, + default_cart_item_filter_id = 3, enable_campaign_state_management = False, loyalty_programs = [ talon_one.models.loyalty_program.LoyaltyProgram( - id = 56, + id = 139, created = '2020-06-10T09:05:27.993483Z', title = 'Point collection', description = 'Customers collect 10 points per 1$ spent', @@ -89,15 +90,17 @@ def make_instance(self, include_optional): card_code_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + return_policy = 'only_pending', account_id = 1, name = 'my_program', - tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programId=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programId=139}], + tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programID=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programID=139}], timezone = 'Europe/Berlin', card_based = True, can_update_tiers = True, can_update_join_policy = True, can_update_tier_expiration_policy = True, - can_upgrade_to_advanced_tiers = True, ) + can_upgrade_to_advanced_tiers = True, + can_update_subledgers = True, ) ] ) else : @@ -111,7 +114,7 @@ def make_instance(self, include_optional): currency = 'EUR', loyalty_programs = [ talon_one.models.loyalty_program.LoyaltyProgram( - id = 56, + id = 139, created = '2020-06-10T09:05:27.993483Z', title = 'Point collection', description = 'Customers collect 10 points per 1$ spent', @@ -129,15 +132,17 @@ def make_instance(self, include_optional): card_code_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + return_policy = 'only_pending', account_id = 1, name = 'my_program', - tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programId=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programId=139}], + tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programID=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programID=139}], timezone = 'Europe/Berlin', card_based = True, can_update_tiers = True, can_update_join_policy = True, can_update_tier_expiration_policy = True, - can_upgrade_to_advanced_tiers = True, ) + can_upgrade_to_advanced_tiers = True, + can_update_subledgers = True, ) ], ) diff --git a/test/test_application_campaign_stats.py b/test/test_application_campaign_stats.py index 9e0a368..c5d7dc3 100644 --- a/test/test_application_campaign_stats.py +++ b/test/test_application_campaign_stats.py @@ -37,6 +37,7 @@ def make_instance(self, include_optional): if include_optional : return ApplicationCampaignStats( disabled = 56, + staged = 56, scheduled = 56, running = 56, expired = 56, @@ -45,6 +46,7 @@ def make_instance(self, include_optional): else : return ApplicationCampaignStats( disabled = 56, + staged = 56, scheduled = 56, running = 56, expired = 56, diff --git a/test/test_application_cif.py b/test/test_application_cif.py new file mode 100644 index 0000000..f7b4bc1 --- /dev/null +++ b/test/test_application_cif.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.application_cif import ApplicationCIF # noqa: E501 +from talon_one.rest import ApiException + +class TestApplicationCIF(unittest.TestCase): + """ApplicationCIF unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ApplicationCIF + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.application_cif.ApplicationCIF() # noqa: E501 + if include_optional : + return ApplicationCIF( + id = 6, + created = '2020-06-10T09:05:27.993483Z', + name = 'Filter items by product', + description = 'This filter allows filtering by shoes', + active_expression_id = 1, + modified_by = 334, + created_by = 216, + modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + application_id = 322 + ) + else : + return ApplicationCIF( + id = 6, + created = '2020-06-10T09:05:27.993483Z', + name = 'Filter items by product', + application_id = 322, + ) + + def testApplicationCIF(self): + """Test ApplicationCIF""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_application_cif_expression.py b/test/test_application_cif_expression.py new file mode 100644 index 0000000..271f474 --- /dev/null +++ b/test/test_application_cif_expression.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.application_cif_expression import ApplicationCIFExpression # noqa: E501 +from talon_one.rest import ApiException + +class TestApplicationCIFExpression(unittest.TestCase): + """ApplicationCIFExpression unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ApplicationCIFExpression + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.application_cif_expression.ApplicationCIFExpression() # noqa: E501 + if include_optional : + return ApplicationCIFExpression( + id = 6, + created = '2020-06-10T09:05:27.993483Z', + cart_item_filter_id = 216, + created_by = 216, + expression = {expr=[filter, [., Session, CartItems], [[Item], [catch, false, [=, [., Item, Category], Kitchen]]]]}, + application_id = 322 + ) + else : + return ApplicationCIFExpression( + id = 6, + created = '2020-06-10T09:05:27.993483Z', + application_id = 322, + ) + + def testApplicationCIFExpression(self): + """Test ApplicationCIFExpression""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_application_customer.py b/test/test_application_customer.py index 9a110ce..2012d70 100644 --- a/test/test_application_customer.py +++ b/test/test_application_customer.py @@ -36,16 +36,16 @@ def make_instance(self, include_optional): # model = talon_one.models.application_customer.ApplicationCustomer() # noqa: E501 if include_optional : return ApplicationCustomer( - id = 56, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - integration_id = '0', + id = 6, + created = '2020-02-07T08:15:22Z', + integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, - account_id = 56, + account_id = 31, closed_sessions = 3, total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -59,11 +59,11 @@ def make_instance(self, include_optional): ) else : return ApplicationCustomer( - id = 56, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - integration_id = '0', + id = 6, + created = '2020-02-07T08:15:22Z', + integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, - account_id = 56, + account_id = 31, closed_sessions = 3, total_sales = 299.99, last_activity = '2020-02-08T14:15:20Z', diff --git a/test/test_application_event.py b/test/test_application_event.py index 1b7c170..ec40161 100644 --- a/test/test_application_event.py +++ b/test/test_application_event.py @@ -57,6 +57,8 @@ def make_instance(self, include_optional): condition_index = 786, evaluation_group_id = 3, evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, props = talon_one.models.effect_props.EffectProps(), ) ], rule_failure_reasons = [ @@ -96,6 +98,8 @@ def make_instance(self, include_optional): condition_index = 786, evaluation_group_id = 3, evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, props = talon_one.models.effect_props.EffectProps(), ) ], ) diff --git a/test/test_application_session.py b/test/test_application_session.py index 0f50cbe..9d5cdab 100644 --- a/test/test_application_session.py +++ b/test/test_application_session.py @@ -37,7 +37,7 @@ def make_instance(self, include_optional): if include_optional : return ApplicationSession( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', store_integration_id = 'STORE-001', application_id = 322, @@ -76,7 +76,7 @@ def make_instance(self, include_optional): else : return ApplicationSession( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', application_id = 322, coupon = 'BKDB946', diff --git a/test/test_audience_customer.py b/test/test_audience_customer.py index ce254a1..f931aaa 100644 --- a/test/test_audience_customer.py +++ b/test/test_audience_customer.py @@ -37,7 +37,7 @@ def make_instance(self, include_optional): if include_optional : return AudienceCustomer( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -45,7 +45,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -61,7 +61,7 @@ def make_instance(self, include_optional): else : return AudienceCustomer( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, diff --git a/test/test_base_loyalty_program.py b/test/test_base_loyalty_program.py index b14861d..b9fec48 100644 --- a/test/test_base_loyalty_program.py +++ b/test/test_base_loyalty_program.py @@ -51,7 +51,8 @@ def make_instance(self, include_optional): tiers_downgrade_policy = 'one_down', card_code_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], - coupon_pattern = 'SUMMER-####-####', ) + coupon_pattern = 'SUMMER-####-####', ), + return_policy = 'only_pending' ) else : return BaseLoyaltyProgram( diff --git a/test/test_bulk_operation_on_campaigns.py b/test/test_bulk_operation_on_campaigns.py index 987ce08..57fa282 100644 --- a/test/test_bulk_operation_on_campaigns.py +++ b/test/test_bulk_operation_on_campaigns.py @@ -37,7 +37,8 @@ def make_instance(self, include_optional): if include_optional : return BulkOperationOnCampaigns( operation = 'disable', - campaign_ids = [1, 2, 3] + campaign_ids = [1, 2, 3], + activate_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') ) else : return BulkOperationOnCampaigns( diff --git a/test/test_campaign.py b/test/test_campaign.py index f7ee187..d4b6385 100644 --- a/test/test_campaign.py +++ b/test/test_campaign.py @@ -92,7 +92,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False ) else : return Campaign( diff --git a/test/test_campaign_collection_edited_notification.py b/test/test_campaign_collection_edited_notification.py index b6880f9..8058fec 100644 --- a/test/test_campaign_collection_edited_notification.py +++ b/test/test_campaign_collection_edited_notification.py @@ -93,7 +93,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), ruleset = talon_one.models.ruleset.Ruleset( id = 6, created = '2020-06-10T09:05:27.993483Z', @@ -203,7 +210,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), collection = talon_one.models.collection_without_payload.CollectionWithoutPayload( id = 6, created = '2020-06-10T09:05:27.993483Z', diff --git a/test/test_campaign_created_notification.py b/test/test_campaign_created_notification.py index 770e174..1c305f9 100644 --- a/test/test_campaign_created_notification.py +++ b/test/test_campaign_created_notification.py @@ -93,7 +93,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), ruleset = talon_one.models.ruleset.Ruleset( id = 6, created = '2020-06-10T09:05:27.993483Z', @@ -195,7 +202,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), evaluation_position = talon_one.models.campaign_evaluation_position.CampaignEvaluationPosition( group_id = 2, group_name = 'Summer campaigns', diff --git a/test/test_campaign_deleted_notification.py b/test/test_campaign_deleted_notification.py index daf63eb..04b6ac0 100644 --- a/test/test_campaign_deleted_notification.py +++ b/test/test_campaign_deleted_notification.py @@ -93,7 +93,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), deleted_at = '2022-11-10T23:00Z' ) else : @@ -155,7 +162,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), deleted_at = '2022-11-10T23:00Z', ) diff --git a/test/test_campaign_edited_notification.py b/test/test_campaign_edited_notification.py index 83ffd26..bb1636b 100644 --- a/test/test_campaign_edited_notification.py +++ b/test/test_campaign_edited_notification.py @@ -93,7 +93,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), old_campaign = talon_one.models.campaign.Campaign( id = 4, created = '2020-06-10T09:05:27.993483Z', @@ -151,7 +158,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), ruleset = talon_one.models.ruleset.Ruleset( id = 6, created = '2020-06-10T09:05:27.993483Z', @@ -249,7 +263,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), old_campaign = talon_one.models.campaign.Campaign( id = 4, created = '2020-06-10T09:05:27.993483Z', @@ -307,7 +328,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), ) def testCampaignEditedNotification(self): diff --git a/test/test_campaign_ruleset_changed_notification.py b/test/test_campaign_ruleset_changed_notification.py index 3a6b80f..222b39a 100644 --- a/test/test_campaign_ruleset_changed_notification.py +++ b/test/test_campaign_ruleset_changed_notification.py @@ -93,7 +93,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), old_ruleset = talon_one.models.ruleset.Ruleset( id = 6, created = '2020-06-10T09:05:27.993483Z', @@ -228,7 +235,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), ) def testCampaignRulesetChangedNotification(self): diff --git a/test/test_campaign_state_changed_notification.py b/test/test_campaign_state_changed_notification.py index cd338d4..ea0be62 100644 --- a/test/test_campaign_state_changed_notification.py +++ b/test/test_campaign_state_changed_notification.py @@ -93,7 +93,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), old_state = 'disabled', new_state = 'running', ruleset = talon_one.models.ruleset.Ruleset( @@ -193,7 +200,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), old_state = 'disabled', new_state = 'running', ) diff --git a/test/test_campaign_store_budget.py b/test/test_campaign_store_budget.py new file mode 100644 index 0000000..46834c2 --- /dev/null +++ b/test/test_campaign_store_budget.py @@ -0,0 +1,73 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.campaign_store_budget import CampaignStoreBudget # noqa: E501 +from talon_one.rest import ApiException + +class TestCampaignStoreBudget(unittest.TestCase): + """CampaignStoreBudget unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test CampaignStoreBudget + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.campaign_store_budget.CampaignStoreBudget() # noqa: E501 + if include_optional : + return CampaignStoreBudget( + id = 6, + created = '2020-06-10T09:05:27.993483Z', + campaign_id = 322, + store_id = 56, + limits = [ + talon_one.models.limit_config.LimitConfig( + action = 'createCoupon', + limit = 1000.0, + period = 'yearly', + entities = [Coupon], ) + ] + ) + else : + return CampaignStoreBudget( + id = 6, + created = '2020-06-10T09:05:27.993483Z', + campaign_id = 322, + store_id = 56, + limits = [ + talon_one.models.limit_config.LimitConfig( + action = 'createCoupon', + limit = 1000.0, + period = 'yearly', + entities = [Coupon], ) + ], + ) + + def testCampaignStoreBudget(self): + """Test CampaignStoreBudget""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_campaign_template.py b/test/test_campaign_template.py index bda0d20..7ed430a 100644 --- a/test/test_campaign_template.py +++ b/test/test_campaign_template.py @@ -54,6 +54,9 @@ def make_instance(self, include_optional): coupon_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + coupon_reservation_settings = talon_one.models.campaign_template_coupon_reservation_settings.CampaignTemplateCouponReservationSettings( + reservation_limit = 45, + is_reservation_mandatory = False, ), referral_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), @@ -71,9 +74,7 @@ def make_instance(self, include_optional): description = 'This is a template parameter of type `number`.', attribute_id = 42, ) ], - applications_ids = [ - 56 - ], + applications_ids = [1, 2, 3, 1, 2, 3], campaign_collections = [ talon_one.models.campaign_template_collection.CampaignTemplateCollection( name = 'My collection', @@ -95,9 +96,7 @@ def make_instance(self, include_optional): description = 'This is a template for a discount campaign.', 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.', state = 'draft', - applications_ids = [ - 56 - ], + applications_ids = [1, 2, 3, 1, 2, 3], campaign_type = 'advanced', valid_application_ids = [1, 2, 3], ) diff --git a/test/test_campaign_template_coupon_reservation_settings.py b/test/test_campaign_template_coupon_reservation_settings.py new file mode 100644 index 0000000..ff6c041 --- /dev/null +++ b/test/test_campaign_template_coupon_reservation_settings.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.campaign_template_coupon_reservation_settings import CampaignTemplateCouponReservationSettings # noqa: E501 +from talon_one.rest import ApiException + +class TestCampaignTemplateCouponReservationSettings(unittest.TestCase): + """CampaignTemplateCouponReservationSettings unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test CampaignTemplateCouponReservationSettings + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.campaign_template_coupon_reservation_settings.CampaignTemplateCouponReservationSettings() # noqa: E501 + if include_optional : + return CampaignTemplateCouponReservationSettings( + reservation_limit = 45, + is_reservation_mandatory = False + ) + else : + return CampaignTemplateCouponReservationSettings( + ) + + def testCampaignTemplateCouponReservationSettings(self): + """Test CampaignTemplateCouponReservationSettings""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_campaign_versions.py b/test/test_campaign_versions.py new file mode 100644 index 0000000..fe0b24d --- /dev/null +++ b/test/test_campaign_versions.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.campaign_versions import CampaignVersions # noqa: E501 +from talon_one.rest import ApiException + +class TestCampaignVersions(unittest.TestCase): + """CampaignVersions unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test CampaignVersions + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.campaign_versions.CampaignVersions() # noqa: E501 + if include_optional : + return CampaignVersions( + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False + ) + else : + return CampaignVersions( + ) + + def testCampaignVersions(self): + """Test CampaignVersions""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_change.py b/test/test_change.py index abb34f4..b48d406 100644 --- a/test/test_change.py +++ b/test/test_change.py @@ -41,7 +41,7 @@ def make_instance(self, include_optional): user_id = 388, application_id = 359, entity = '/v1/applications/359/campaigns/6727', - old = None, + old = {}, new = {"applicationId\"":359,"attributes\"":{},"campaignGroups\"":[],"created\"":"2022-07-08T13:04:02.972762328Z","description\"":"","features\"":["referrals","loyalty"],"id":6727}, management_key_id = 3 ) diff --git a/test/test_coupon_deletion_filters.py b/test/test_coupon_deletion_filters.py index f129279..b691749 100644 --- a/test/test_coupon_deletion_filters.py +++ b/test/test_coupon_deletion_filters.py @@ -45,7 +45,7 @@ def make_instance(self, include_optional): redeemed = True, recipient_integration_id = '0', exact_match = True, - value = 'false', + value = '0', batch_id = '0', referral_id = 56, expires_after = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), diff --git a/test/test_coupon_deletion_job.py b/test/test_coupon_deletion_job.py index 993a853..3440dc4 100644 --- a/test/test_coupon_deletion_job.py +++ b/test/test_coupon_deletion_job.py @@ -50,7 +50,7 @@ def make_instance(self, include_optional): redeemed = True, recipient_integration_id = '0', exact_match = True, - value = 'false', + value = '0', batch_id = '0', referral_id = 56, expires_after = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), @@ -81,7 +81,7 @@ def make_instance(self, include_optional): redeemed = True, recipient_integration_id = '0', exact_match = True, - value = 'false', + value = '0', batch_id = '0', referral_id = 56, expires_after = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), diff --git a/test/test_create_achievement.py b/test/test_create_achievement.py index 687b9c4..3b95dd9 100644 --- a/test/test_create_achievement.py +++ b/test/test_create_achievement.py @@ -41,7 +41,11 @@ def make_instance(self, include_optional): description = '50% off for every 50th purchase in a year.', target = 50.0, period = '1Y', - period_end_override = {month=11, dayOfMonth=23, hour=23, minute=59, second=59} + period_end_override = {month=11, dayOfMonth=23, hour=23, minute=59, second=59}, + recurrence_policy = 'no_recurrence', + activation_policy = 'fixed_schedule', + fixed_start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') ) else : return CreateAchievement( diff --git a/test/test_create_template_campaign_response.py b/test/test_create_template_campaign_response.py index c39b63e..cc1f327 100644 --- a/test/test_create_template_campaign_response.py +++ b/test/test_create_template_campaign_response.py @@ -93,7 +93,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), ruleset = talon_one.models.ruleset.Ruleset( id = 6, created = '2020-06-10T09:05:27.993483Z', @@ -206,7 +213,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ), + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ), ruleset = talon_one.models.ruleset.Ruleset( id = 6, created = '2020-06-10T09:05:27.993483Z', diff --git a/test/test_custom_effect.py b/test/test_custom_effect.py index 7c54c86..6c1923b 100644 --- a/test/test_custom_effect.py +++ b/test/test_custom_effect.py @@ -55,6 +55,7 @@ def make_instance(self, include_optional): description = '0', title = '0', ui = talon_one.models.ui.ui(), + key = '0', picklist_id = 56, restricted_by_picklist = True, ) ], diff --git a/test/test_customer_inventory.py b/test/test_customer_inventory.py index ea21b0a..0edf357 100644 --- a/test/test_customer_inventory.py +++ b/test/test_customer_inventory.py @@ -38,7 +38,7 @@ def make_instance(self, include_optional): return CustomerInventory( profile = talon_one.models.customer_profile.CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -46,7 +46,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -62,6 +62,8 @@ def make_instance(self, include_optional): id = 6, created = '2020-06-10T09:05:27.993483Z', program_id = 125, + program_name = 'Loyalty_program', + program_title = 'Loyalty program', status = 'active', block_reason = 'Current card lost. Customer needs a new card.', identifier = 'summer-loyalty-card-0543', @@ -97,7 +99,8 @@ def make_instance(self, include_optional): }, modified = '2021-09-12T10:12:42Z', old_card_identifier = 'summer-loyalty-card-0543', - new_card_identifier = 'summer-loyalty-card-0543', ) + new_card_identifier = 'summer-loyalty-card-0543', + batch_id = 'wdefpov', ) ], programs = { 'key' : talon_one.models.loyalty_program_ledgers.LoyaltyProgramLedgers( @@ -195,6 +198,7 @@ def make_instance(self, include_optional): achievement_id = 3, name = 'FreeCoffee10Orders', title = '50% off on 50th purchase.', + description = '50% off for every 50th purchase in a year.', campaign_id = 3, status = 'completed', target = 10.0, diff --git a/test/test_customer_profile.py b/test/test_customer_profile.py index 606a232..be89cdf 100644 --- a/test/test_customer_profile.py +++ b/test/test_customer_profile.py @@ -37,7 +37,7 @@ def make_instance(self, include_optional): if include_optional : return CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -45,7 +45,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -59,7 +59,7 @@ def make_instance(self, include_optional): else : return CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, diff --git a/test/test_customer_profile_integration_response_v2.py b/test/test_customer_profile_integration_response_v2.py index 0580b3e..3d80f2c 100644 --- a/test/test_customer_profile_integration_response_v2.py +++ b/test/test_customer_profile_integration_response_v2.py @@ -38,7 +38,7 @@ def make_instance(self, include_optional): return CustomerProfileIntegrationResponseV2( customer_profile = talon_one.models.customer_profile.CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -46,7 +46,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -99,6 +99,8 @@ def make_instance(self, include_optional): id = 6, created = '2020-06-10T09:05:27.993483Z', program_id = 125, + program_name = 'Loyalty_program', + program_title = 'Loyalty program', status = 'active', block_reason = 'Current card lost. Customer needs a new card.', identifier = 'summer-loyalty-card-0543', @@ -134,7 +136,8 @@ def make_instance(self, include_optional): }, modified = '2021-09-12T10:12:42Z', old_card_identifier = 'summer-loyalty-card-0543', - new_card_identifier = 'summer-loyalty-card-0543', ) + new_card_identifier = 'summer-loyalty-card-0543', + batch_id = 'wdefpov', ) ], programs = { 'key' : talon_one.models.loyalty_program_ledgers.LoyaltyProgramLedgers( @@ -219,7 +222,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ) + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ) ], rule_failure_reasons = [ talon_one.models.rule_failure_reason.RuleFailureReason( @@ -264,6 +274,8 @@ def make_instance(self, include_optional): condition_index = 786, evaluation_group_id = 3, evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, props = talon_one.models.effect_props.EffectProps(), ) ], created_coupons = [ @@ -328,6 +340,8 @@ def make_instance(self, include_optional): condition_index = 786, evaluation_group_id = 3, evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, props = talon_one.models.effect_props.EffectProps(), ) ], created_coupons = [ diff --git a/test/test_customer_profile_update_v2_response.py b/test/test_customer_profile_update_v2_response.py index 3f1aa08..08fd62d 100644 --- a/test/test_customer_profile_update_v2_response.py +++ b/test/test_customer_profile_update_v2_response.py @@ -38,7 +38,7 @@ def make_instance(self, include_optional): return CustomerProfileUpdateV2Response( customer_profile = talon_one.models.customer_profile.CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -46,7 +46,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -61,7 +61,7 @@ def make_instance(self, include_optional): return CustomerProfileUpdateV2Response( customer_profile = talon_one.models.customer_profile.CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -69,7 +69,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ diff --git a/test/test_customer_session.py b/test/test_customer_session.py index 6a4c898..62e7900 100644 --- a/test/test_customer_session.py +++ b/test/test_customer_session.py @@ -36,7 +36,7 @@ def make_instance(self, include_optional): # model = talon_one.models.customer_session.CustomerSession() # noqa: E501 if include_optional : return CustomerSession( - integration_id = '0', + integration_id = 'URNGV8294NV', created = '2020-02-07T08:15:22Z', application_id = 322, profile_id = 'URNGV8294NV', @@ -74,7 +74,7 @@ def make_instance(self, include_optional): ) else : return CustomerSession( - integration_id = '0', + integration_id = 'URNGV8294NV', created = '2020-02-07T08:15:22Z', application_id = 322, profile_id = 'URNGV8294NV', diff --git a/test/test_customer_session_v2.py b/test/test_customer_session_v2.py index 02aaba0..a0f1b9d 100644 --- a/test/test_customer_session_v2.py +++ b/test/test_customer_session_v2.py @@ -37,7 +37,7 @@ def make_instance(self, include_optional): if include_optional : return CustomerSessionV2( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', application_id = 322, profile_id = 'URNGV8294NV', @@ -68,18 +68,19 @@ def make_instance(self, include_optional): catalog_item_id = 56, ) ], additional_costs = {"shipping":{"price":9}}, - identifiers = [91.11.156.141], + identifiers = [d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea], attributes = {"ShippingCity":"Berlin"}, first_session = True, total = 119.99, cart_item_total = 99.99, additional_cost_total = 20.0, - updated = '2020-02-08T14:15:22Z' + updated = '2020-02-08T14:15:22Z', + closure_prediction = 0.283 ) else : return CustomerSessionV2( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', application_id = 322, profile_id = 'URNGV8294NV', diff --git a/test/test_effect.py b/test/test_effect.py index f06458f..b012cf0 100644 --- a/test/test_effect.py +++ b/test/test_effect.py @@ -46,6 +46,8 @@ def make_instance(self, include_optional): condition_index = 786, evaluation_group_id = 3, evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, props = talon_one.models.effect_props.EffectProps() ) else : diff --git a/test/test_effect_entity.py b/test/test_effect_entity.py index 430db6a..c73c9fa 100644 --- a/test/test_effect_entity.py +++ b/test/test_effect_entity.py @@ -45,7 +45,9 @@ def make_instance(self, include_optional): triggered_for_catalog_item = 786, condition_index = 786, evaluation_group_id = 3, - evaluation_group_mode = 'stackable' + evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5 ) else : return EffectEntity( diff --git a/test/test_environment.py b/test/test_environment.py index 3a57ab5..6c11ee2 100644 --- a/test/test_environment.py +++ b/test/test_environment.py @@ -78,6 +78,7 @@ def make_instance(self, include_optional): description = '0', title = '0', ui = talon_one.models.ui.ui(), + key = '0', picklist_id = 56, restricted_by_picklist = True, ) ], @@ -100,7 +101,7 @@ def make_instance(self, include_optional): ], loyalty_programs = [ talon_one.models.loyalty_program.LoyaltyProgram( - id = 56, + id = 139, created = '2020-06-10T09:05:27.993483Z', title = 'Point collection', description = 'Customers collect 10 points per 1$ spent', @@ -118,15 +119,17 @@ def make_instance(self, include_optional): card_code_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + return_policy = 'only_pending', account_id = 1, name = 'my_program', - tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programId=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programId=139}], + tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programID=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programID=139}], timezone = 'Europe/Berlin', card_based = True, can_update_tiers = True, can_update_join_policy = True, can_update_tier_expiration_policy = True, - can_upgrade_to_advanced_tiers = True, ) + can_upgrade_to_advanced_tiers = True, + can_update_subledgers = True, ) ], achievements = [ talon_one.models.achievement.Achievement( @@ -138,6 +141,10 @@ def make_instance(self, include_optional): target = 50.0, period = '1Y', period_end_override = {month=11, dayOfMonth=23, hour=23, minute=59, second=59}, + recurrence_policy = 'no_recurrence', + activation_policy = 'fixed_schedule', + fixed_start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), campaign_id = 1, user_id = 1234, created_by = 'John Doe', @@ -203,6 +210,18 @@ def make_instance(self, include_optional): application_id = 1, campaign_id = 7, payload = [KTL-WH-ET-1, KTL-BL-ET-1], ) + ], + application_cart_item_filters = [ + talon_one.models.application_cif.ApplicationCIF( + id = 6, + created = '2020-06-10T09:05:27.993483Z', + name = 'Filter items by product', + description = 'This filter allows filtering by shoes', + active_expression_id = 1, + modified_by = 334, + created_by = 216, + modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + application_id = 322, ) ] ) else : @@ -249,6 +268,7 @@ def make_instance(self, include_optional): description = '0', title = '0', ui = talon_one.models.ui.ui(), + key = '0', picklist_id = 56, restricted_by_picklist = True, ) ], diff --git a/test/test_feature_flag.py b/test/test_feature_flag.py index 96b28cf..fc7d752 100644 --- a/test/test_feature_flag.py +++ b/test/test_feature_flag.py @@ -39,7 +39,7 @@ def make_instance(self, include_optional): name = 'canCreateCampaignFromTemplate', value = 'true', created = '2021-09-22T12:24:14.956203Z', - modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + modified = '2021-09-25T10:34:12.956203Z' ) else : return FeatureFlag( diff --git a/test/test_generate_campaign_description.py b/test/test_generate_campaign_description.py index c6153a2..e7f4b40 100644 --- a/test/test_generate_campaign_description.py +++ b/test/test_generate_campaign_description.py @@ -36,12 +36,12 @@ def make_instance(self, include_optional): # model = talon_one.models.generate_campaign_description.GenerateCampaignDescription() # noqa: E501 if include_optional : return GenerateCampaignDescription( - campaign_id = 56, + ruleset_id = 56, currency = '0' ) else : return GenerateCampaignDescription( - campaign_id = 56, + ruleset_id = 56, currency = '0', ) diff --git a/test/test_generate_campaign_tags.py b/test/test_generate_campaign_tags.py index af9f0b8..13979a1 100644 --- a/test/test_generate_campaign_tags.py +++ b/test/test_generate_campaign_tags.py @@ -36,11 +36,11 @@ def make_instance(self, include_optional): # model = talon_one.models.generate_campaign_tags.GenerateCampaignTags() # noqa: E501 if include_optional : return GenerateCampaignTags( - campaign_id = 56 + ruleset_id = 56 ) else : return GenerateCampaignTags( - campaign_id = 56, + ruleset_id = 56, ) def testGenerateCampaignTags(self): diff --git a/test/test_generate_loyalty_card.py b/test/test_generate_loyalty_card.py index 188df96..293342d 100644 --- a/test/test_generate_loyalty_card.py +++ b/test/test_generate_loyalty_card.py @@ -37,7 +37,8 @@ def make_instance(self, include_optional): if include_optional : return GenerateLoyaltyCard( status = 'active', - customer_profile_ids = [R195412, G244519] + customer_profile_ids = [R195412, G244519], + card_identifier = 'summer-loyalty-card-0543' ) else : return GenerateLoyaltyCard( diff --git a/test/test_inline_response200.py b/test/test_inline_response200.py index 2e7f3bb..e19994a 100644 --- a/test/test_inline_response200.py +++ b/test/test_inline_response200.py @@ -40,7 +40,7 @@ def make_instance(self, include_optional): data = [ talon_one.models.customer_profile.CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -48,7 +48,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -66,7 +66,7 @@ def make_instance(self, include_optional): data = [ talon_one.models.customer_profile.CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -74,7 +74,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ diff --git a/test/test_inline_response20012.py b/test/test_inline_response20012.py index 785f4f9..c026ac6 100644 --- a/test/test_inline_response20012.py +++ b/test/test_inline_response20012.py @@ -57,6 +57,9 @@ def make_instance(self, include_optional): coupon_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + coupon_reservation_settings = talon_one.models.campaign_template_coupon_reservation_settings.CampaignTemplateCouponReservationSettings( + reservation_limit = 45, + is_reservation_mandatory = False, ), referral_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), @@ -74,9 +77,7 @@ def make_instance(self, include_optional): description = 'This is a template parameter of type `number`.', attribute_id = 42, ) ], - applications_ids = [ - 56 - ], + applications_ids = [1, 2, 3, 1, 2, 3], campaign_collections = [ talon_one.models.campaign_template_collection.CampaignTemplateCollection( name = 'My collection', @@ -112,6 +113,9 @@ def make_instance(self, include_optional): coupon_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + coupon_reservation_settings = talon_one.models.campaign_template_coupon_reservation_settings.CampaignTemplateCouponReservationSettings( + reservation_limit = 45, + is_reservation_mandatory = False, ), referral_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), @@ -129,9 +133,7 @@ def make_instance(self, include_optional): description = 'This is a template parameter of type `number`.', attribute_id = 42, ) ], - applications_ids = [ - 56 - ], + applications_ids = [1, 2, 3, 1, 2, 3], campaign_collections = [ talon_one.models.campaign_template_collection.CampaignTemplateCollection( name = 'My collection', diff --git a/test/test_inline_response20013.py b/test/test_inline_response20013.py index 43e4f27..5b246bc 100644 --- a/test/test_inline_response20013.py +++ b/test/test_inline_response20013.py @@ -39,7 +39,7 @@ def make_instance(self, include_optional): total_result_size = 1, data = [ talon_one.models.loyalty_program.LoyaltyProgram( - id = 56, + id = 139, created = '2020-06-10T09:05:27.993483Z', title = 'Point collection', description = 'Customers collect 10 points per 1$ spent', @@ -57,15 +57,17 @@ def make_instance(self, include_optional): card_code_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + return_policy = 'only_pending', account_id = 1, name = 'my_program', - tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programId=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programId=139}], + tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programID=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programID=139}], timezone = 'Europe/Berlin', card_based = True, can_update_tiers = True, can_update_join_policy = True, can_update_tier_expiration_policy = True, - can_upgrade_to_advanced_tiers = True, ) + can_upgrade_to_advanced_tiers = True, + can_update_subledgers = True, ) ] ) else : @@ -73,7 +75,7 @@ def make_instance(self, include_optional): total_result_size = 1, data = [ talon_one.models.loyalty_program.LoyaltyProgram( - id = 56, + id = 139, created = '2020-06-10T09:05:27.993483Z', title = 'Point collection', description = 'Customers collect 10 points per 1$ spent', @@ -91,15 +93,17 @@ def make_instance(self, include_optional): card_code_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + return_policy = 'only_pending', account_id = 1, name = 'my_program', - tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programId=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programId=139}], + tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programID=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programID=139}], timezone = 'Europe/Berlin', card_based = True, can_update_tiers = True, can_update_join_policy = True, can_update_tier_expiration_policy = True, - can_upgrade_to_advanced_tiers = True, ) + can_upgrade_to_advanced_tiers = True, + can_update_subledgers = True, ) ], ) diff --git a/test/test_inline_response20015.py b/test/test_inline_response20015.py index d5e01ff..ce1ad02 100644 --- a/test/test_inline_response20015.py +++ b/test/test_inline_response20015.py @@ -42,6 +42,8 @@ def make_instance(self, include_optional): id = 6, created = '2020-06-10T09:05:27.993483Z', program_id = 125, + program_name = 'Loyalty_program', + program_title = 'Loyalty program', status = 'active', block_reason = 'Current card lost. Customer needs a new card.', identifier = 'summer-loyalty-card-0543', @@ -77,7 +79,8 @@ def make_instance(self, include_optional): }, modified = '2021-09-12T10:12:42Z', old_card_identifier = 'summer-loyalty-card-0543', - new_card_identifier = 'summer-loyalty-card-0543', ) + new_card_identifier = 'summer-loyalty-card-0543', + batch_id = 'wdefpov', ) ] ) else : @@ -88,6 +91,8 @@ def make_instance(self, include_optional): id = 6, created = '2020-06-10T09:05:27.993483Z', program_id = 125, + program_name = 'Loyalty_program', + program_title = 'Loyalty program', status = 'active', block_reason = 'Current card lost. Customer needs a new card.', identifier = 'summer-loyalty-card-0543', @@ -123,7 +128,8 @@ def make_instance(self, include_optional): }, modified = '2021-09-12T10:12:42Z', old_card_identifier = 'summer-loyalty-card-0543', - new_card_identifier = 'summer-loyalty-card-0543', ) + new_card_identifier = 'summer-loyalty-card-0543', + batch_id = 'wdefpov', ) ], ) diff --git a/test/test_inline_response20020.py b/test/test_inline_response20020.py index 0980f6b..2d175c4 100644 --- a/test/test_inline_response20020.py +++ b/test/test_inline_response20020.py @@ -38,38 +38,64 @@ def make_instance(self, include_optional): return InlineResponse20020( total_result_size = 1, data = [ - talon_one.models.access_log_entry.AccessLogEntry( - uuid = '606e7d34-2d36-4d53-ac71-d4442c325985', - status = 200, - method = 'PUT', - request_uri = '/v2/customer_sessions/Session136667', - time = '2023-01-16T16:00:00.700763Z', - request_payload = '{ - "customerSession": { - "profileId": "customer123", - "state": "closed", -... -}', - response_payload = '{"coupons":[],"createdCoupons":[],...}', ) + talon_one.models.campaign_analytics.CampaignAnalytics( + date = '2021-10-12T10:12:42Z', + campaign_revenue = 3539.76, + total_campaign_revenue = 5784.63, + campaign_refund = 1.337, + total_campaign_refund = 1.337, + campaign_discount_costs = 1.337, + total_campaign_discount_costs = 1.337, + campaign_refunded_discounts = 1.337, + total_campaign_refunded_discounts = 1.337, + campaign_free_items = 56, + total_campaign_free_items = 86, + coupon_redemptions = 56, + total_coupon_redemptions = 56, + coupon_rolledback_redemptions = 56, + total_coupon_rolledback_redemptions = 56, + referral_redemptions = 56, + total_referral_redemptions = 56, + coupons_created = 56, + total_coupons_created = 56, + referrals_created = 56, + total_referrals_created = 56, + added_loyalty_points = 250.0, + total_added_loyalty_points = 340.0, + deducted_loyalty_points = 120.0, + total_deducted_loyalty_points = 220.0, ) ] ) else : return InlineResponse20020( total_result_size = 1, data = [ - talon_one.models.access_log_entry.AccessLogEntry( - uuid = '606e7d34-2d36-4d53-ac71-d4442c325985', - status = 200, - method = 'PUT', - request_uri = '/v2/customer_sessions/Session136667', - time = '2023-01-16T16:00:00.700763Z', - request_payload = '{ - "customerSession": { - "profileId": "customer123", - "state": "closed", -... -}', - response_payload = '{"coupons":[],"createdCoupons":[],...}', ) + talon_one.models.campaign_analytics.CampaignAnalytics( + date = '2021-10-12T10:12:42Z', + campaign_revenue = 3539.76, + total_campaign_revenue = 5784.63, + campaign_refund = 1.337, + total_campaign_refund = 1.337, + campaign_discount_costs = 1.337, + total_campaign_discount_costs = 1.337, + campaign_refunded_discounts = 1.337, + total_campaign_refunded_discounts = 1.337, + campaign_free_items = 56, + total_campaign_free_items = 86, + coupon_redemptions = 56, + total_coupon_redemptions = 56, + coupon_rolledback_redemptions = 56, + total_coupon_rolledback_redemptions = 56, + referral_redemptions = 56, + total_referral_redemptions = 56, + coupons_created = 56, + total_coupons_created = 56, + referrals_created = 56, + total_referrals_created = 56, + added_loyalty_points = 250.0, + total_added_loyalty_points = 340.0, + deducted_loyalty_points = 120.0, + total_deducted_loyalty_points = 220.0, ) ], ) diff --git a/test/test_inline_response20021.py b/test/test_inline_response20021.py index ef5e4a2..d5734d8 100644 --- a/test/test_inline_response20021.py +++ b/test/test_inline_response20021.py @@ -37,65 +37,55 @@ def make_instance(self, include_optional): if include_optional : return InlineResponse20021( total_result_size = 1, + has_more = True, data = [ - talon_one.models.campaign_analytics.CampaignAnalytics( - date = '2021-10-12T10:12:42Z', - campaign_revenue = 3539.76, - total_campaign_revenue = 5784.63, - campaign_refund = 1.337, - total_campaign_refund = 1.337, - campaign_discount_costs = 1.337, - total_campaign_discount_costs = 1.337, - campaign_refunded_discounts = 1.337, - total_campaign_refunded_discounts = 1.337, - campaign_free_items = 56, - total_campaign_free_items = 86, - coupon_redemptions = 56, - total_coupon_redemptions = 56, - coupon_rolledback_redemptions = 56, - total_coupon_rolledback_redemptions = 56, - referral_redemptions = 56, - total_referral_redemptions = 56, - coupons_created = 56, - total_coupons_created = 56, - referrals_created = 56, - total_referrals_created = 56, - added_loyalty_points = 250.0, - total_added_loyalty_points = 340.0, - deducted_loyalty_points = 120.0, - total_deducted_loyalty_points = 220.0, ) + talon_one.models.application_customer.ApplicationCustomer( + id = 6, + created = '2020-02-07T08:15:22Z', + integration_id = 'URNGV8294NV', + attributes = {"Language":"english","ShippingCountry":"DE"}, + account_id = 31, + closed_sessions = 3, + total_sales = 299.99, + loyalty_memberships = [ + talon_one.models.loyalty_membership.LoyaltyMembership( + joined = '2012-03-20T14:15:22Z', + loyalty_program_id = 323414846, ) + ], + audience_memberships = [ + talon_one.models.audience_membership.AudienceMembership( + id = 2, + name = 'Travel audience', ) + ], + last_activity = '2020-02-08T14:15:20Z', + sandbox = False, + advocate_integration_id = '0', ) ] ) else : return InlineResponse20021( - total_result_size = 1, data = [ - talon_one.models.campaign_analytics.CampaignAnalytics( - date = '2021-10-12T10:12:42Z', - campaign_revenue = 3539.76, - total_campaign_revenue = 5784.63, - campaign_refund = 1.337, - total_campaign_refund = 1.337, - campaign_discount_costs = 1.337, - total_campaign_discount_costs = 1.337, - campaign_refunded_discounts = 1.337, - total_campaign_refunded_discounts = 1.337, - campaign_free_items = 56, - total_campaign_free_items = 86, - coupon_redemptions = 56, - total_coupon_redemptions = 56, - coupon_rolledback_redemptions = 56, - total_coupon_rolledback_redemptions = 56, - referral_redemptions = 56, - total_referral_redemptions = 56, - coupons_created = 56, - total_coupons_created = 56, - referrals_created = 56, - total_referrals_created = 56, - added_loyalty_points = 250.0, - total_added_loyalty_points = 340.0, - deducted_loyalty_points = 120.0, - total_deducted_loyalty_points = 220.0, ) + talon_one.models.application_customer.ApplicationCustomer( + id = 6, + created = '2020-02-07T08:15:22Z', + integration_id = 'URNGV8294NV', + attributes = {"Language":"english","ShippingCountry":"DE"}, + account_id = 31, + closed_sessions = 3, + total_sales = 299.99, + loyalty_memberships = [ + talon_one.models.loyalty_membership.LoyaltyMembership( + joined = '2012-03-20T14:15:22Z', + loyalty_program_id = 323414846, ) + ], + audience_memberships = [ + talon_one.models.audience_membership.AudienceMembership( + id = 2, + name = 'Travel audience', ) + ], + last_activity = '2020-02-08T14:15:20Z', + sandbox = False, + advocate_integration_id = '0', ) ], ) diff --git a/test/test_inline_response20022.py b/test/test_inline_response20022.py index 58a4863..4822f08 100644 --- a/test/test_inline_response20022.py +++ b/test/test_inline_response20022.py @@ -36,20 +36,20 @@ def make_instance(self, include_optional): # model = talon_one.models.inline_response20022.InlineResponse20022() # noqa: E501 if include_optional : return InlineResponse20022( - total_result_size = 1, has_more = True, + total_result_size = 56, data = [ talon_one.models.application_customer.ApplicationCustomer( - id = 56, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - integration_id = '0', + id = 6, + created = '2020-02-07T08:15:22Z', + integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, - account_id = 56, + account_id = 31, closed_sessions = 3, total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -66,16 +66,16 @@ def make_instance(self, include_optional): return InlineResponse20022( data = [ talon_one.models.application_customer.ApplicationCustomer( - id = 56, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - integration_id = '0', + id = 6, + created = '2020-02-07T08:15:22Z', + integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, - account_id = 56, + account_id = 31, closed_sessions = 3, total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ diff --git a/test/test_inline_response20023.py b/test/test_inline_response20023.py index d992be0..741bd53 100644 --- a/test/test_inline_response20023.py +++ b/test/test_inline_response20023.py @@ -39,17 +39,17 @@ def make_instance(self, include_optional): has_more = True, total_result_size = 56, data = [ - talon_one.models.application_customer.ApplicationCustomer( - id = 56, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - integration_id = '0', + talon_one.models.customer_profile.CustomerProfile( + id = 6, + created = '2020-02-07T08:15:22Z', + integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, - account_id = 56, + account_id = 31, closed_sessions = 3, total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -58,24 +58,23 @@ def make_instance(self, include_optional): name = 'Travel audience', ) ], last_activity = '2020-02-08T14:15:20Z', - sandbox = False, - advocate_integration_id = '0', ) + sandbox = False, ) ] ) else : return InlineResponse20023( data = [ - talon_one.models.application_customer.ApplicationCustomer( - id = 56, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - integration_id = '0', + talon_one.models.customer_profile.CustomerProfile( + id = 6, + created = '2020-02-07T08:15:22Z', + integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, - account_id = 56, + account_id = 31, closed_sessions = 3, total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -84,8 +83,7 @@ def make_instance(self, include_optional): name = 'Travel audience', ) ], last_activity = '2020-02-08T14:15:20Z', - sandbox = False, - advocate_integration_id = '0', ) + sandbox = False, ) ], ) diff --git a/test/test_inline_response20024.py b/test/test_inline_response20024.py index f54d2f1..4860038 100644 --- a/test/test_inline_response20024.py +++ b/test/test_inline_response20024.py @@ -37,11 +37,10 @@ def make_instance(self, include_optional): if include_optional : return InlineResponse20024( has_more = True, - total_result_size = 56, data = [ talon_one.models.customer_profile.CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -49,7 +48,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -63,10 +62,11 @@ def make_instance(self, include_optional): ) else : return InlineResponse20024( + has_more = True, data = [ talon_one.models.customer_profile.CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -74,7 +74,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ diff --git a/test/test_inline_response20025.py b/test/test_inline_response20025.py index 9599d1f..417d9b8 100644 --- a/test/test_inline_response20025.py +++ b/test/test_inline_response20025.py @@ -38,52 +38,40 @@ def make_instance(self, include_optional): return InlineResponse20025( has_more = True, data = [ - talon_one.models.customer_profile.CustomerProfile( - id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + talon_one.models.customer_activity_report.CustomerActivityReport( integration_id = 'URNGV8294NV', - attributes = {"Language":"english","ShippingCountry":"DE"}, - account_id = 31, - closed_sessions = 3, - total_sales = 299.99, - loyalty_memberships = [ - talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - loyalty_program_id = 323414846, ) - ], - audience_memberships = [ - talon_one.models.audience_membership.AudienceMembership( - id = 2, - name = 'Travel audience', ) - ], - last_activity = '2020-02-08T14:15:20Z', - sandbox = False, ) + created = '2020-02-07T08:15:22Z', + name = '0', + customer_id = 56, + last_activity = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + coupon_redemptions = 56, + coupon_use_attempts = 56, + coupon_failed_attempts = 56, + accrued_discounts = 1.337, + accrued_revenue = 1.337, + total_orders = 56, + total_orders_no_coupon = 56, + campaign_name = '0', ) ] ) else : return InlineResponse20025( has_more = True, data = [ - talon_one.models.customer_profile.CustomerProfile( - id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + talon_one.models.customer_activity_report.CustomerActivityReport( integration_id = 'URNGV8294NV', - attributes = {"Language":"english","ShippingCountry":"DE"}, - account_id = 31, - closed_sessions = 3, - total_sales = 299.99, - loyalty_memberships = [ - talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - loyalty_program_id = 323414846, ) - ], - audience_memberships = [ - talon_one.models.audience_membership.AudienceMembership( - id = 2, - name = 'Travel audience', ) - ], - last_activity = '2020-02-08T14:15:20Z', - sandbox = False, ) + created = '2020-02-07T08:15:22Z', + name = '0', + customer_id = 56, + last_activity = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + coupon_redemptions = 56, + coupon_use_attempts = 56, + coupon_failed_attempts = 56, + accrued_discounts = 1.337, + accrued_revenue = 1.337, + total_orders = 56, + total_orders_no_coupon = 56, + campaign_name = '0', ) ], ) diff --git a/test/test_inline_response20026.py b/test/test_inline_response20026.py index 82bdd84..64524e1 100644 --- a/test/test_inline_response20026.py +++ b/test/test_inline_response20026.py @@ -38,40 +38,85 @@ def make_instance(self, include_optional): return InlineResponse20026( has_more = True, data = [ - talon_one.models.customer_activity_report.CustomerActivityReport( - integration_id = 'URNGV8294NV', + talon_one.models.application_session.ApplicationSession( + id = 6, created = '2020-02-07T08:15:22Z', - name = '0', - customer_id = 56, - last_activity = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - coupon_redemptions = 56, - coupon_use_attempts = 56, - coupon_failed_attempts = 56, - accrued_discounts = 1.337, - accrued_revenue = 1.337, - total_orders = 56, - total_orders_no_coupon = 56, - campaign_name = '0', ) + integration_id = 'URNGV8294NV', + store_integration_id = 'STORE-001', + application_id = 322, + profile_id = 138, + profileintegrationid = '382370BKDB946', + coupon = 'BKDB946', + referral = 'BKDB946', + state = 'closed', + cart_items = [ + talon_one.models.cart_item.CartItem( + name = 'Air Glide', + sku = 'SKU1241028', + quantity = 1, + returned_quantity = 1, + remaining_quantity = 1, + price = 99.99, + category = 'shoes', + product = talon_one.models.product.Product( + name = 'sample_product', ), + weight = 1130.0, + height = 1.337, + width = 1.337, + length = 1.337, + position = 1.337, + attributes = {"image":"11.jpeg","material":"leather"}, + additional_costs = {"shipping":{"price":9}}, + catalog_item_id = 56, ) + ], + discounts = { + 'key' : 1.337 + }, + total_discounts = 100.0, + total = 200.0, + attributes = talon_one.models.attributes.attributes(), ) ] ) else : return InlineResponse20026( - has_more = True, data = [ - talon_one.models.customer_activity_report.CustomerActivityReport( - integration_id = 'URNGV8294NV', + talon_one.models.application_session.ApplicationSession( + id = 6, created = '2020-02-07T08:15:22Z', - name = '0', - customer_id = 56, - last_activity = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - coupon_redemptions = 56, - coupon_use_attempts = 56, - coupon_failed_attempts = 56, - accrued_discounts = 1.337, - accrued_revenue = 1.337, - total_orders = 56, - total_orders_no_coupon = 56, - campaign_name = '0', ) + integration_id = 'URNGV8294NV', + store_integration_id = 'STORE-001', + application_id = 322, + profile_id = 138, + profileintegrationid = '382370BKDB946', + coupon = 'BKDB946', + referral = 'BKDB946', + state = 'closed', + cart_items = [ + talon_one.models.cart_item.CartItem( + name = 'Air Glide', + sku = 'SKU1241028', + quantity = 1, + returned_quantity = 1, + remaining_quantity = 1, + price = 99.99, + category = 'shoes', + product = talon_one.models.product.Product( + name = 'sample_product', ), + weight = 1130.0, + height = 1.337, + width = 1.337, + length = 1.337, + position = 1.337, + attributes = {"image":"11.jpeg","material":"leather"}, + additional_costs = {"shipping":{"price":9}}, + catalog_item_id = 56, ) + ], + discounts = { + 'key' : 1.337 + }, + total_discounts = 100.0, + total = 200.0, + attributes = talon_one.models.attributes.attributes(), ) ], ) diff --git a/test/test_inline_response20027.py b/test/test_inline_response20027.py index dbfb182..205e838 100644 --- a/test/test_inline_response20027.py +++ b/test/test_inline_response20027.py @@ -38,85 +38,98 @@ def make_instance(self, include_optional): return InlineResponse20027( has_more = True, data = [ - talon_one.models.application_session.ApplicationSession( + talon_one.models.application_event.ApplicationEvent( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - integration_id = 'URNGV8294NV', - store_integration_id = 'STORE-001', + created = '2020-06-10T09:05:27.993483Z', application_id = 322, profile_id = 138, - profileintegrationid = '382370BKDB946', - coupon = 'BKDB946', - referral = 'BKDB946', - state = 'closed', - cart_items = [ - talon_one.models.cart_item.CartItem( - name = 'Air Glide', - sku = 'SKU1241028', - quantity = 1, - returned_quantity = 1, - remaining_quantity = 1, - price = 99.99, - category = 'shoes', - product = talon_one.models.product.Product( - name = 'sample_product', ), - weight = 1130.0, - height = 1.337, - width = 1.337, - length = 1.337, - position = 1.337, - attributes = {"image":"11.jpeg","material":"leather"}, - additional_costs = {"shipping":{"price":9}}, - catalog_item_id = 56, ) + store_id = 56, + store_integration_id = 'STORE-001', + session_id = 56, + type = '0', + attributes = talon_one.models.attributes.attributes(), + effects = [ + talon_one.models.effect.Effect( + campaign_id = 244, + ruleset_id = 73, + rule_index = 2, + rule_name = 'Give 20% discount', + effect_type = 'rejectCoupon', + triggered_by_coupon = 4928, + triggered_for_catalog_item = 786, + condition_index = 786, + evaluation_group_id = 3, + evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, + props = talon_one.models.effect_props.EffectProps(), ) ], - discounts = { - 'key' : 1.337 - }, - total_discounts = 100.0, - total = 200.0, - attributes = talon_one.models.attributes.attributes(), ) + rule_failure_reasons = [ + talon_one.models.rule_failure_reason.RuleFailureReason( + campaign_id = 56, + campaign_name = '0', + ruleset_id = 56, + coupon_id = 4928, + coupon_value = '0', + referral_id = 56, + referral_value = '0', + rule_index = 56, + rule_name = '0', + condition_index = 56, + effect_index = 56, + details = '0', + evaluation_group_id = 3, + evaluation_group_mode = 'stackable', ) + ], ) ] ) else : return InlineResponse20027( + has_more = True, data = [ - talon_one.models.application_session.ApplicationSession( + talon_one.models.application_event.ApplicationEvent( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - integration_id = 'URNGV8294NV', - store_integration_id = 'STORE-001', + created = '2020-06-10T09:05:27.993483Z', application_id = 322, profile_id = 138, - profileintegrationid = '382370BKDB946', - coupon = 'BKDB946', - referral = 'BKDB946', - state = 'closed', - cart_items = [ - talon_one.models.cart_item.CartItem( - name = 'Air Glide', - sku = 'SKU1241028', - quantity = 1, - returned_quantity = 1, - remaining_quantity = 1, - price = 99.99, - category = 'shoes', - product = talon_one.models.product.Product( - name = 'sample_product', ), - weight = 1130.0, - height = 1.337, - width = 1.337, - length = 1.337, - position = 1.337, - attributes = {"image":"11.jpeg","material":"leather"}, - additional_costs = {"shipping":{"price":9}}, - catalog_item_id = 56, ) + store_id = 56, + store_integration_id = 'STORE-001', + session_id = 56, + type = '0', + attributes = talon_one.models.attributes.attributes(), + effects = [ + talon_one.models.effect.Effect( + campaign_id = 244, + ruleset_id = 73, + rule_index = 2, + rule_name = 'Give 20% discount', + effect_type = 'rejectCoupon', + triggered_by_coupon = 4928, + triggered_for_catalog_item = 786, + condition_index = 786, + evaluation_group_id = 3, + evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, + props = talon_one.models.effect_props.EffectProps(), ) ], - discounts = { - 'key' : 1.337 - }, - total_discounts = 100.0, - total = 200.0, - attributes = talon_one.models.attributes.attributes(), ) + rule_failure_reasons = [ + talon_one.models.rule_failure_reason.RuleFailureReason( + campaign_id = 56, + campaign_name = '0', + ruleset_id = 56, + coupon_id = 4928, + coupon_value = '0', + referral_id = 56, + referral_value = '0', + rule_index = 56, + rule_name = '0', + condition_index = 56, + effect_index = 56, + details = '0', + evaluation_group_id = 3, + evaluation_group_mode = 'stackable', ) + ], ) ], ) diff --git a/test/test_inline_response20028.py b/test/test_inline_response20028.py index 947ddce..9f76daa 100644 --- a/test/test_inline_response20028.py +++ b/test/test_inline_response20028.py @@ -36,96 +36,16 @@ def make_instance(self, include_optional): # model = talon_one.models.inline_response20028.InlineResponse20028() # noqa: E501 if include_optional : return InlineResponse20028( - has_more = True, + total_result_size = 1, data = [ - talon_one.models.application_event.ApplicationEvent( - id = 6, - created = '2020-06-10T09:05:27.993483Z', - application_id = 322, - profile_id = 138, - store_id = 56, - store_integration_id = 'STORE-001', - session_id = 56, - type = '0', - attributes = talon_one.models.attributes.attributes(), - effects = [ - talon_one.models.effect.Effect( - campaign_id = 244, - ruleset_id = 73, - rule_index = 2, - rule_name = 'Give 20% discount', - effect_type = 'rejectCoupon', - triggered_by_coupon = 4928, - triggered_for_catalog_item = 786, - condition_index = 786, - evaluation_group_id = 3, - evaluation_group_mode = 'stackable', - props = talon_one.models.effect_props.EffectProps(), ) - ], - rule_failure_reasons = [ - talon_one.models.rule_failure_reason.RuleFailureReason( - campaign_id = 56, - campaign_name = '0', - ruleset_id = 56, - coupon_id = 4928, - coupon_value = '0', - referral_id = 56, - referral_value = '0', - rule_index = 56, - rule_name = '0', - condition_index = 56, - effect_index = 56, - details = '0', - evaluation_group_id = 3, - evaluation_group_mode = 'stackable', ) - ], ) + '0' ] ) else : return InlineResponse20028( - has_more = True, + total_result_size = 1, data = [ - talon_one.models.application_event.ApplicationEvent( - id = 6, - created = '2020-06-10T09:05:27.993483Z', - application_id = 322, - profile_id = 138, - store_id = 56, - store_integration_id = 'STORE-001', - session_id = 56, - type = '0', - attributes = talon_one.models.attributes.attributes(), - effects = [ - talon_one.models.effect.Effect( - campaign_id = 244, - ruleset_id = 73, - rule_index = 2, - rule_name = 'Give 20% discount', - effect_type = 'rejectCoupon', - triggered_by_coupon = 4928, - triggered_for_catalog_item = 786, - condition_index = 786, - evaluation_group_id = 3, - evaluation_group_mode = 'stackable', - props = talon_one.models.effect_props.EffectProps(), ) - ], - rule_failure_reasons = [ - talon_one.models.rule_failure_reason.RuleFailureReason( - campaign_id = 56, - campaign_name = '0', - ruleset_id = 56, - coupon_id = 4928, - coupon_value = '0', - referral_id = 56, - referral_value = '0', - rule_index = 56, - rule_name = '0', - condition_index = 56, - effect_index = 56, - details = '0', - evaluation_group_id = 3, - evaluation_group_mode = 'stackable', ) - ], ) + '0' ], ) diff --git a/test/test_inline_response20029.py b/test/test_inline_response20029.py index cbb731d..cfb57d1 100644 --- a/test/test_inline_response20029.py +++ b/test/test_inline_response20029.py @@ -36,16 +36,36 @@ def make_instance(self, include_optional): # model = talon_one.models.inline_response20029.InlineResponse20029() # noqa: E501 if include_optional : return InlineResponse20029( + has_more = True, total_result_size = 1, data = [ - '0' + talon_one.models.audience.Audience( + account_id = 3886, + id = 6, + created = '2020-06-10T09:05:27.993483Z', + name = 'Travel audience', + sandbox = True, + description = 'Travel audience 18-27', + integration = 'mparticle', + integration_id = '382370BKDB946', + created_in3rd_party = False, + last_update = '2022-04-26T11:02:38Z', ) ] ) else : return InlineResponse20029( - total_result_size = 1, data = [ - '0' + talon_one.models.audience.Audience( + account_id = 3886, + id = 6, + created = '2020-06-10T09:05:27.993483Z', + name = 'Travel audience', + sandbox = True, + description = 'Travel audience 18-27', + integration = 'mparticle', + integration_id = '382370BKDB946', + created_in3rd_party = False, + last_update = '2022-04-26T11:02:38Z', ) ], ) diff --git a/test/test_inline_response20030.py b/test/test_inline_response20030.py index 79684e4..65a6abe 100644 --- a/test/test_inline_response20030.py +++ b/test/test_inline_response20030.py @@ -37,35 +37,18 @@ def make_instance(self, include_optional): if include_optional : return InlineResponse20030( has_more = True, - total_result_size = 1, data = [ - talon_one.models.audience.Audience( - account_id = 3886, - id = 6, - created = '2020-06-10T09:05:27.993483Z', - name = 'Travel audience', - sandbox = True, - description = 'Travel audience 18-27', - integration = 'mparticle', - integration_id = '382370BKDB946', - created_in3rd_party = False, - last_update = '2022-04-26T11:02:38Z', ) + talon_one.models.audience_analytics.AudienceAnalytics( + audience_id = 1, + members_count = 1234, ) ] ) else : return InlineResponse20030( data = [ - talon_one.models.audience.Audience( - account_id = 3886, - id = 6, - created = '2020-06-10T09:05:27.993483Z', - name = 'Travel audience', - sandbox = True, - description = 'Travel audience 18-27', - integration = 'mparticle', - integration_id = '382370BKDB946', - created_in3rd_party = False, - last_update = '2022-04-26T11:02:38Z', ) + talon_one.models.audience_analytics.AudienceAnalytics( + audience_id = 1, + members_count = 1234, ) ], ) diff --git a/test/test_inline_response20031.py b/test/test_inline_response20031.py index 67341df..1cadae6 100644 --- a/test/test_inline_response20031.py +++ b/test/test_inline_response20031.py @@ -38,17 +38,51 @@ def make_instance(self, include_optional): return InlineResponse20031( has_more = True, data = [ - talon_one.models.audience_analytics.AudienceAnalytics( - audience_id = 1, - members_count = 1234, ) + talon_one.models.customer_profile.CustomerProfile( + id = 6, + created = '2020-02-07T08:15:22Z', + integration_id = 'URNGV8294NV', + attributes = {"Language":"english","ShippingCountry":"DE"}, + account_id = 31, + closed_sessions = 3, + total_sales = 299.99, + loyalty_memberships = [ + talon_one.models.loyalty_membership.LoyaltyMembership( + joined = '2012-03-20T14:15:22Z', + loyalty_program_id = 323414846, ) + ], + audience_memberships = [ + talon_one.models.audience_membership.AudienceMembership( + id = 2, + name = 'Travel audience', ) + ], + last_activity = '2020-02-08T14:15:20Z', + sandbox = False, ) ] ) else : return InlineResponse20031( data = [ - talon_one.models.audience_analytics.AudienceAnalytics( - audience_id = 1, - members_count = 1234, ) + talon_one.models.customer_profile.CustomerProfile( + id = 6, + created = '2020-02-07T08:15:22Z', + integration_id = 'URNGV8294NV', + attributes = {"Language":"english","ShippingCountry":"DE"}, + account_id = 31, + closed_sessions = 3, + total_sales = 299.99, + loyalty_memberships = [ + talon_one.models.loyalty_membership.LoyaltyMembership( + joined = '2012-03-20T14:15:22Z', + loyalty_program_id = 323414846, ) + ], + audience_memberships = [ + talon_one.models.audience_membership.AudienceMembership( + id = 2, + name = 'Travel audience', ) + ], + last_activity = '2020-02-08T14:15:20Z', + sandbox = False, ) ], ) diff --git a/test/test_inline_response20032.py b/test/test_inline_response20032.py index d5e5094..47f9184 100644 --- a/test/test_inline_response20032.py +++ b/test/test_inline_response20032.py @@ -37,52 +37,27 @@ def make_instance(self, include_optional): if include_optional : return InlineResponse20032( has_more = True, + total_result_size = 1, data = [ - talon_one.models.customer_profile.CustomerProfile( - id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - integration_id = 'URNGV8294NV', - attributes = {"Language":"english","ShippingCountry":"DE"}, - account_id = 31, - closed_sessions = 3, - total_sales = 299.99, - loyalty_memberships = [ - talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - loyalty_program_id = 323414846, ) - ], - audience_memberships = [ - talon_one.models.audience_membership.AudienceMembership( - id = 2, - name = 'Travel audience', ) - ], - last_activity = '2020-02-08T14:15:20Z', - sandbox = False, ) + talon_one.models.application_referee.ApplicationReferee( + application_id = 322, + session_id = '0', + advocate_integration_id = '0', + friend_integration_id = '0', + code = '0', + created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) ] ) else : return InlineResponse20032( data = [ - talon_one.models.customer_profile.CustomerProfile( - id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - integration_id = 'URNGV8294NV', - attributes = {"Language":"english","ShippingCountry":"DE"}, - account_id = 31, - closed_sessions = 3, - total_sales = 299.99, - loyalty_memberships = [ - talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - loyalty_program_id = 323414846, ) - ], - audience_memberships = [ - talon_one.models.audience_membership.AudienceMembership( - id = 2, - name = 'Travel audience', ) - ], - last_activity = '2020-02-08T14:15:20Z', - sandbox = False, ) + talon_one.models.application_referee.ApplicationReferee( + application_id = 322, + session_id = '0', + advocate_integration_id = '0', + friend_integration_id = '0', + code = '0', + created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) ], ) diff --git a/test/test_inline_response20033.py b/test/test_inline_response20033.py index 693d072..38ad40f 100644 --- a/test/test_inline_response20033.py +++ b/test/test_inline_response20033.py @@ -36,28 +36,54 @@ def make_instance(self, include_optional): # model = talon_one.models.inline_response20033.InlineResponse20033() # noqa: E501 if include_optional : return InlineResponse20033( - has_more = True, total_result_size = 1, data = [ - talon_one.models.application_referee.ApplicationReferee( - application_id = 322, - session_id = '0', - advocate_integration_id = '0', - friend_integration_id = '0', - code = '0', - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) + talon_one.models.attribute.Attribute( + id = 6, + created = '2020-06-10T09:05:27.993483Z', + account_id = 3886, + entity = 'Event', + event_type = 'pageViewed', + name = 'pageViewed', + title = 'Page view event', + type = 'string', + description = 'Event triggered when a customer displays a page.', + suggestions = [ + '0' + ], + has_allowed_list = False, + restricted_by_suggestions = False, + editable = True, + subscribed_applications_ids = [1, 4, 9], + subscribed_catalogs_ids = [2, 5], + allowed_subscriptions = [application, catalog], + event_type_id = 22, ) ] ) else : return InlineResponse20033( + total_result_size = 1, data = [ - talon_one.models.application_referee.ApplicationReferee( - application_id = 322, - session_id = '0', - advocate_integration_id = '0', - friend_integration_id = '0', - code = '0', - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) + talon_one.models.attribute.Attribute( + id = 6, + created = '2020-06-10T09:05:27.993483Z', + account_id = 3886, + entity = 'Event', + event_type = 'pageViewed', + name = 'pageViewed', + title = 'Page view event', + type = 'string', + description = 'Event triggered when a customer displays a page.', + suggestions = [ + '0' + ], + has_allowed_list = False, + restricted_by_suggestions = False, + editable = True, + subscribed_applications_ids = [1, 4, 9], + subscribed_catalogs_ids = [2, 5], + allowed_subscriptions = [application, catalog], + event_type_id = 22, ) ], ) diff --git a/test/test_inline_response20034.py b/test/test_inline_response20034.py index ccd0a46..add21ce 100644 --- a/test/test_inline_response20034.py +++ b/test/test_inline_response20034.py @@ -36,54 +36,44 @@ def make_instance(self, include_optional): # model = talon_one.models.inline_response20034.InlineResponse20034() # noqa: E501 if include_optional : return InlineResponse20034( + has_more = True, total_result_size = 1, data = [ - talon_one.models.attribute.Attribute( + talon_one.models.catalog_item.CatalogItem( id = 6, created = '2020-06-10T09:05:27.993483Z', - account_id = 3886, - entity = 'Event', - event_type = 'pageViewed', - name = 'pageViewed', - title = 'Page view event', - type = 'string', - description = 'Event triggered when a customer displays a page.', - suggestions = [ - '0' + sku = 'SKU1241028', + price = 99.99, + catalogid = 6, + version = 5, + attributes = [ + talon_one.models.item_attribute.ItemAttribute( + attributeid = 6, + name = '0', + value = talon_one.models.value.value(), ) ], - has_allowed_list = False, - restricted_by_suggestions = False, - editable = True, - subscribed_applications_ids = [1, 4, 9], - subscribed_catalogs_ids = [2, 5], - allowed_subscriptions = [application, catalog], - event_type_id = 22, ) + product = talon_one.models.product.Product( + name = 'sample_product', ), ) ] ) else : return InlineResponse20034( - total_result_size = 1, data = [ - talon_one.models.attribute.Attribute( + talon_one.models.catalog_item.CatalogItem( id = 6, created = '2020-06-10T09:05:27.993483Z', - account_id = 3886, - entity = 'Event', - event_type = 'pageViewed', - name = 'pageViewed', - title = 'Page view event', - type = 'string', - description = 'Event triggered when a customer displays a page.', - suggestions = [ - '0' + sku = 'SKU1241028', + price = 99.99, + catalogid = 6, + version = 5, + attributes = [ + talon_one.models.item_attribute.ItemAttribute( + attributeid = 6, + name = '0', + value = talon_one.models.value.value(), ) ], - has_allowed_list = False, - restricted_by_suggestions = False, - editable = True, - subscribed_applications_ids = [1, 4, 9], - subscribed_catalogs_ids = [2, 5], - allowed_subscriptions = [application, catalog], - event_type_id = 22, ) + product = talon_one.models.product.Product( + name = 'sample_product', ), ) ], ) diff --git a/test/test_inline_response20035.py b/test/test_inline_response20035.py index 1acae4c..34fc5a5 100644 --- a/test/test_inline_response20035.py +++ b/test/test_inline_response20035.py @@ -36,44 +36,32 @@ def make_instance(self, include_optional): # model = talon_one.models.inline_response20035.InlineResponse20035() # noqa: E501 if include_optional : return InlineResponse20035( - has_more = True, total_result_size = 1, data = [ - talon_one.models.catalog_item.CatalogItem( + talon_one.models.account_additional_cost.AccountAdditionalCost( id = 6, created = '2020-06-10T09:05:27.993483Z', - sku = 'SKU1241028', - price = 99.99, - catalogid = 6, - version = 5, - attributes = [ - talon_one.models.item_attribute.ItemAttribute( - attributeid = 6, - name = '0', - value = talon_one.models.value.value(), ) - ], - product = talon_one.models.product.Product( - name = 'sample_product', ), ) + account_id = 3886, + name = 'shippingFee', + title = 'Shipping fee', + description = 'A shipping fee', + subscribed_applications_ids = [3, 13], + type = 'session', ) ] ) else : return InlineResponse20035( + total_result_size = 1, data = [ - talon_one.models.catalog_item.CatalogItem( + talon_one.models.account_additional_cost.AccountAdditionalCost( id = 6, created = '2020-06-10T09:05:27.993483Z', - sku = 'SKU1241028', - price = 99.99, - catalogid = 6, - version = 5, - attributes = [ - talon_one.models.item_attribute.ItemAttribute( - attributeid = 6, - name = '0', - value = talon_one.models.value.value(), ) - ], - product = talon_one.models.product.Product( - name = 'sample_product', ), ) + account_id = 3886, + name = 'shippingFee', + title = 'Shipping fee', + description = 'A shipping fee', + subscribed_applications_ids = [3, 13], + type = 'session', ) ], ) diff --git a/test/test_inline_response20036.py b/test/test_inline_response20036.py index 80d5350..4216a01 100644 --- a/test/test_inline_response20036.py +++ b/test/test_inline_response20036.py @@ -38,30 +38,52 @@ def make_instance(self, include_optional): return InlineResponse20036( total_result_size = 1, data = [ - talon_one.models.account_additional_cost.AccountAdditionalCost( + talon_one.models.webhook_with_outgoing_integration_details.WebhookWithOutgoingIntegrationDetails( id = 6, created = '2020-06-10T09:05:27.993483Z', - account_id = 3886, - name = 'shippingFee', - title = 'Shipping fee', - description = 'A shipping fee', - subscribed_applications_ids = [3, 13], - type = 'session', ) + modified = '2021-09-12T10:12:42Z', + application_ids = [ + 56 + ], + title = 'Send message', + description = 'A webhook to send a coupon to the user.', + verb = 'POST', + url = 'www.my-company.com/my-endpoint-name', + headers = [{"Authorization": "Basic bmF2ZWVua3VtYXIU="}, {"Content-Type": "application/json"}], + payload = '{ + "message": "${message}" +}', + params = [], + enabled = True, + outgoing_integration_template_id = 1, + outgoing_integration_type_id = 1, + outgoing_integration_type_name = 'Braze', ) ] ) else : return InlineResponse20036( total_result_size = 1, data = [ - talon_one.models.account_additional_cost.AccountAdditionalCost( + talon_one.models.webhook_with_outgoing_integration_details.WebhookWithOutgoingIntegrationDetails( id = 6, created = '2020-06-10T09:05:27.993483Z', - account_id = 3886, - name = 'shippingFee', - title = 'Shipping fee', - description = 'A shipping fee', - subscribed_applications_ids = [3, 13], - type = 'session', ) + modified = '2021-09-12T10:12:42Z', + application_ids = [ + 56 + ], + title = 'Send message', + description = 'A webhook to send a coupon to the user.', + verb = 'POST', + url = 'www.my-company.com/my-endpoint-name', + headers = [{"Authorization": "Basic bmF2ZWVua3VtYXIU="}, {"Content-Type": "application/json"}], + payload = '{ + "message": "${message}" +}', + params = [], + enabled = True, + outgoing_integration_template_id = 1, + outgoing_integration_type_id = 1, + outgoing_integration_type_name = 'Braze', ) ], ) diff --git a/test/test_inline_response20037.py b/test/test_inline_response20037.py index 16309c4..5bfc8b7 100644 --- a/test/test_inline_response20037.py +++ b/test/test_inline_response20037.py @@ -38,52 +38,24 @@ def make_instance(self, include_optional): return InlineResponse20037( total_result_size = 1, data = [ - talon_one.models.webhook_with_outgoing_integration_details.WebhookWithOutgoingIntegrationDetails( - id = 6, - created = '2020-06-10T09:05:27.993483Z', - modified = '2021-09-12T10:12:42Z', - application_ids = [ - 56 - ], - title = 'Send message', - description = 'A webhook to send a coupon to the user.', - verb = 'POST', - url = 'www.my-company.com/my-endpoint-name', - headers = [{"Authorization": "Basic bmF2ZWVua3VtYXIU="}, {"Content-Type": "application/json"}], - payload = '{ - "message": "${message}" -}', - params = [], - enabled = True, - outgoing_integration_template_id = 1, - outgoing_integration_type_id = 1, - outgoing_integration_type_name = 'Braze', ) + talon_one.models.webhook_activation_log_entry.WebhookActivationLogEntry( + integration_request_uuid = '6d3699cf-95bd-444a-b62f-80d6e8391dc9', + webhook_id = 1, + application_id = 13, + campaign_id = 86, + created = '2023-03-21T13:55:08.571144Z', ) ] ) else : return InlineResponse20037( total_result_size = 1, data = [ - talon_one.models.webhook_with_outgoing_integration_details.WebhookWithOutgoingIntegrationDetails( - id = 6, - created = '2020-06-10T09:05:27.993483Z', - modified = '2021-09-12T10:12:42Z', - application_ids = [ - 56 - ], - title = 'Send message', - description = 'A webhook to send a coupon to the user.', - verb = 'POST', - url = 'www.my-company.com/my-endpoint-name', - headers = [{"Authorization": "Basic bmF2ZWVua3VtYXIU="}, {"Content-Type": "application/json"}], - payload = '{ - "message": "${message}" -}', - params = [], - enabled = True, - outgoing_integration_template_id = 1, - outgoing_integration_type_id = 1, - outgoing_integration_type_name = 'Braze', ) + talon_one.models.webhook_activation_log_entry.WebhookActivationLogEntry( + integration_request_uuid = '6d3699cf-95bd-444a-b62f-80d6e8391dc9', + webhook_id = 1, + application_id = 13, + campaign_id = 86, + created = '2023-03-21T13:55:08.571144Z', ) ], ) diff --git a/test/test_inline_response20038.py b/test/test_inline_response20038.py index f87db48..28b6384 100644 --- a/test/test_inline_response20038.py +++ b/test/test_inline_response20038.py @@ -38,24 +38,40 @@ def make_instance(self, include_optional): return InlineResponse20038( total_result_size = 1, data = [ - talon_one.models.webhook_activation_log_entry.WebhookActivationLogEntry( - integration_request_uuid = '6d3699cf-95bd-444a-b62f-80d6e8391dc9', - webhook_id = 1, - application_id = 13, - campaign_id = 86, - created = '2023-03-21T13:55:08.571144Z', ) + talon_one.models.webhook_log_entry.WebhookLogEntry( + id = '2', + integration_request_uuid = '472075793', + webhook_id = 5, + application_id = 12, + url = 'www.my-company.com/my-endpoint-name', + request = '{ + mydata: "somevalue" +} +', + response = '0', + status = 204, + request_time = '2021-07-20T22:00Z', + response_time = '2021-07-20T22:00:50Z', ) ] ) else : return InlineResponse20038( total_result_size = 1, data = [ - talon_one.models.webhook_activation_log_entry.WebhookActivationLogEntry( - integration_request_uuid = '6d3699cf-95bd-444a-b62f-80d6e8391dc9', - webhook_id = 1, - application_id = 13, - campaign_id = 86, - created = '2023-03-21T13:55:08.571144Z', ) + talon_one.models.webhook_log_entry.WebhookLogEntry( + id = '2', + integration_request_uuid = '472075793', + webhook_id = 5, + application_id = 12, + url = 'www.my-company.com/my-endpoint-name', + request = '{ + mydata: "somevalue" +} +', + response = '0', + status = 204, + request_time = '2021-07-20T22:00Z', + response_time = '2021-07-20T22:00:50Z', ) ], ) diff --git a/test/test_inline_response20039.py b/test/test_inline_response20039.py index da483c9..b9946c4 100644 --- a/test/test_inline_response20039.py +++ b/test/test_inline_response20039.py @@ -38,40 +38,24 @@ def make_instance(self, include_optional): return InlineResponse20039( total_result_size = 1, data = [ - talon_one.models.webhook_log_entry.WebhookLogEntry( - id = '2', - integration_request_uuid = '472075793', - webhook_id = 5, - application_id = 12, - url = 'www.my-company.com/my-endpoint-name', - request = '{ - mydata: "somevalue" -} -', - response = '0', - status = 204, - request_time = '2021-07-20T22:00Z', - response_time = '2021-07-20T22:00:50Z', ) + talon_one.models.event_type.EventType( + id = 6, + created = '2020-06-10T09:05:27.993483Z', + title = 'Survey Completed', + name = 'surveyCompleted', + description = 'The survey was submitted by the customer.', ) ] ) else : return InlineResponse20039( total_result_size = 1, data = [ - talon_one.models.webhook_log_entry.WebhookLogEntry( - id = '2', - integration_request_uuid = '472075793', - webhook_id = 5, - application_id = 12, - url = 'www.my-company.com/my-endpoint-name', - request = '{ - mydata: "somevalue" -} -', - response = '0', - status = 204, - request_time = '2021-07-20T22:00Z', - response_time = '2021-07-20T22:00:50Z', ) + talon_one.models.event_type.EventType( + id = 6, + created = '2020-06-10T09:05:27.993483Z', + title = 'Survey Completed', + name = 'surveyCompleted', + description = 'The survey was submitted by the customer.', ) ], ) diff --git a/test/test_inline_response20040.py b/test/test_inline_response20040.py index b89ac54..3f2e18a 100644 --- a/test/test_inline_response20040.py +++ b/test/test_inline_response20040.py @@ -38,24 +38,48 @@ def make_instance(self, include_optional): return InlineResponse20040( total_result_size = 1, data = [ - talon_one.models.event_type.EventType( + talon_one.models.user.User( id = 6, created = '2020-06-10T09:05:27.993483Z', - title = 'Survey Completed', - name = 'surveyCompleted', - description = 'The survey was submitted by the customer.', ) + modified = '2021-09-12T10:12:42Z', + email = 'john.doe@example.com', + account_id = 3886, + name = 'John Doe', + state = 'invited', + invite_token = 'Gy9b8w1irmQtEPo5RmbMmSPheL5h4', + is_admin = False, + policy = {"Role":127}, + roles = [71], + auth_method = 'basic_auth', + application_notification_subscriptions = {}, + last_signed_in = '2021-09-12T10:12:42Z', + last_accessed = '2021-09-12T10:14:42Z', + latest_feed_timestamp = '2020-06-01T00:00Z', + additional_attributes = {}, ) ] ) else : return InlineResponse20040( total_result_size = 1, data = [ - talon_one.models.event_type.EventType( + talon_one.models.user.User( id = 6, created = '2020-06-10T09:05:27.993483Z', - title = 'Survey Completed', - name = 'surveyCompleted', - description = 'The survey was submitted by the customer.', ) + modified = '2021-09-12T10:12:42Z', + email = 'john.doe@example.com', + account_id = 3886, + name = 'John Doe', + state = 'invited', + invite_token = 'Gy9b8w1irmQtEPo5RmbMmSPheL5h4', + is_admin = False, + policy = {"Role":127}, + roles = [71], + auth_method = 'basic_auth', + application_notification_subscriptions = {}, + last_signed_in = '2021-09-12T10:12:42Z', + last_accessed = '2021-09-12T10:14:42Z', + latest_feed_timestamp = '2020-06-01T00:00Z', + additional_attributes = {}, ) ], ) diff --git a/test/test_inline_response20041.py b/test/test_inline_response20041.py index ea31c26..15cca65 100644 --- a/test/test_inline_response20041.py +++ b/test/test_inline_response20041.py @@ -37,49 +37,31 @@ def make_instance(self, include_optional): if include_optional : return InlineResponse20041( total_result_size = 1, + has_more = True, data = [ - talon_one.models.user.User( + talon_one.models.change.Change( id = 6, created = '2020-06-10T09:05:27.993483Z', - modified = '2021-09-12T10:12:42Z', - email = 'john.doe@example.com', - account_id = 3886, - name = 'John Doe', - state = 'invited', - invite_token = 'Gy9b8w1irmQtEPo5RmbMmSPheL5h4', - is_admin = False, - policy = {"Role":127}, - roles = [71], - auth_method = 'basic_auth', - application_notification_subscriptions = talon_one.models.application_notification_subscriptions.applicationNotificationSubscriptions(), - last_signed_in = '2021-09-12T10:12:42Z', - last_accessed = '2021-09-12T10:14:42Z', - latest_feed_timestamp = '2020-06-01T00:00Z', - additional_attributes = talon_one.models.additional_attributes.additionalAttributes(), ) + user_id = 388, + application_id = 359, + entity = '/v1/applications/359/campaigns/6727', + old = {}, + new = {"applicationId\"":359,"attributes\"":{},"campaignGroups\"":[],"created\"":"2022-07-08T13:04:02.972762328Z","description\"":"","features\"":["referrals","loyalty"],"id":6727}, + management_key_id = 3, ) ] ) else : return InlineResponse20041( - total_result_size = 1, data = [ - talon_one.models.user.User( + talon_one.models.change.Change( id = 6, created = '2020-06-10T09:05:27.993483Z', - modified = '2021-09-12T10:12:42Z', - email = 'john.doe@example.com', - account_id = 3886, - name = 'John Doe', - state = 'invited', - invite_token = 'Gy9b8w1irmQtEPo5RmbMmSPheL5h4', - is_admin = False, - policy = {"Role":127}, - roles = [71], - auth_method = 'basic_auth', - application_notification_subscriptions = talon_one.models.application_notification_subscriptions.applicationNotificationSubscriptions(), - last_signed_in = '2021-09-12T10:12:42Z', - last_accessed = '2021-09-12T10:14:42Z', - latest_feed_timestamp = '2020-06-01T00:00Z', - additional_attributes = talon_one.models.additional_attributes.additionalAttributes(), ) + user_id = 388, + application_id = 359, + entity = '/v1/applications/359/campaigns/6727', + old = {}, + new = {"applicationId\"":359,"attributes\"":{},"campaignGroups\"":[],"created\"":"2022-07-08T13:04:02.972762328Z","description\"":"","features\"":["referrals","loyalty"],"id":6727}, + management_key_id = 3, ) ], ) diff --git a/test/test_inline_response20042.py b/test/test_inline_response20042.py index df4e3f4..eee0a9c 100644 --- a/test/test_inline_response20042.py +++ b/test/test_inline_response20042.py @@ -37,31 +37,27 @@ def make_instance(self, include_optional): if include_optional : return InlineResponse20042( total_result_size = 1, - has_more = True, data = [ - talon_one.models.change.Change( + talon_one.models.export.Export( id = 6, created = '2020-06-10T09:05:27.993483Z', + account_id = 3886, user_id = 388, - application_id = 359, - entity = '/v1/applications/359/campaigns/6727', - old = talon_one.models.old.old(), - new = {"applicationId\"":359,"attributes\"":{},"campaignGroups\"":[],"created\"":"2022-07-08T13:04:02.972762328Z","description\"":"","features\"":["referrals","loyalty"],"id":6727}, - management_key_id = 3, ) + entity = 'Coupon', + filter = talon_one.models.filter.filter(), ) ] ) else : return InlineResponse20042( + total_result_size = 1, data = [ - talon_one.models.change.Change( + talon_one.models.export.Export( id = 6, created = '2020-06-10T09:05:27.993483Z', + account_id = 3886, user_id = 388, - application_id = 359, - entity = '/v1/applications/359/campaigns/6727', - old = talon_one.models.old.old(), - new = {"applicationId\"":359,"attributes\"":{},"campaignGroups\"":[],"created\"":"2022-07-08T13:04:02.972762328Z","description\"":"","features\"":["referrals","loyalty"],"id":6727}, - management_key_id = 3, ) + entity = 'Coupon', + filter = talon_one.models.filter.filter(), ) ], ) diff --git a/test/test_inline_response20043.py b/test/test_inline_response20043.py index a871eaf..812701b 100644 --- a/test/test_inline_response20043.py +++ b/test/test_inline_response20043.py @@ -38,26 +38,40 @@ def make_instance(self, include_optional): return InlineResponse20043( total_result_size = 1, data = [ - talon_one.models.export.Export( + talon_one.models.role_v2.RoleV2( id = 6, created = '2020-06-10T09:05:27.993483Z', + modified = '2021-09-12T10:12:42Z', account_id = 3886, - user_id = 388, - entity = 'Coupon', - filter = talon_one.models.filter.filter(), ) + name = 'Campaign and campaign access group manager', + description = 'Allows you to create and edit campaigns for specific Applications, delete specific campaign access groups, and view loyalty programs.', + permissions = talon_one.models.role_v2_permissions.RoleV2Permissions( + permission_sets = [{name=Application permission set, logicalOperations=[getApplicationOperations, editApplicationOperations]}, {name=Campaign manager permission set, logicalOperations=[getCampaignOperations, createCampaignOperations, updateCampaignOperations]}, {name=Campaign read-only permission set, logicalOperations=[getCampaignOperations]}, {name=Loyalty program read-only permission set, logicalOperations=[getLoyaltyProgramOperations]}, {name=Campaign access group manager permission set, logicalOperations=[getCampaignAccessGroupOperations, updateCampaignAccessGroupOperations, deleteCampaignAccessGroupOperations]}], + roles = talon_one.models.role_v2_roles_group.RoleV2RolesGroup( + applications = {1={application=Application permission set}, 3={campaign=Campaign manager permission set}, 4={draftCampaign=Campaign read-only permission set}, 5={tools=Tools permission set}}, + loyalty_programs = {10=Loyalty program manager permission set}, + campaign_access_groups = {5=Campaign access group manager permission set}, ), ), + members = [10, 12], ) ] ) else : return InlineResponse20043( total_result_size = 1, data = [ - talon_one.models.export.Export( + talon_one.models.role_v2.RoleV2( id = 6, created = '2020-06-10T09:05:27.993483Z', + modified = '2021-09-12T10:12:42Z', account_id = 3886, - user_id = 388, - entity = 'Coupon', - filter = talon_one.models.filter.filter(), ) + name = 'Campaign and campaign access group manager', + description = 'Allows you to create and edit campaigns for specific Applications, delete specific campaign access groups, and view loyalty programs.', + permissions = talon_one.models.role_v2_permissions.RoleV2Permissions( + permission_sets = [{name=Application permission set, logicalOperations=[getApplicationOperations, editApplicationOperations]}, {name=Campaign manager permission set, logicalOperations=[getCampaignOperations, createCampaignOperations, updateCampaignOperations]}, {name=Campaign read-only permission set, logicalOperations=[getCampaignOperations]}, {name=Loyalty program read-only permission set, logicalOperations=[getLoyaltyProgramOperations]}, {name=Campaign access group manager permission set, logicalOperations=[getCampaignAccessGroupOperations, updateCampaignAccessGroupOperations, deleteCampaignAccessGroupOperations]}], + roles = talon_one.models.role_v2_roles_group.RoleV2RolesGroup( + applications = {1={application=Application permission set}, 3={campaign=Campaign manager permission set}, 4={draftCampaign=Campaign read-only permission set}, 5={tools=Tools permission set}}, + loyalty_programs = {10=Loyalty program manager permission set}, + campaign_access_groups = {5=Campaign access group manager permission set}, ), ), + members = [10, 12], ) ], ) diff --git a/test/test_inline_response20044.py b/test/test_inline_response20044.py index abf1a5b..652cd36 100644 --- a/test/test_inline_response20044.py +++ b/test/test_inline_response20044.py @@ -36,42 +36,34 @@ def make_instance(self, include_optional): # model = talon_one.models.inline_response20044.InlineResponse20044() # noqa: E501 if include_optional : return InlineResponse20044( + has_more = True, total_result_size = 1, data = [ - talon_one.models.role_v2.RoleV2( + talon_one.models.store.Store( id = 6, - created = '2020-06-10T09:05:27.993483Z', - modified = '2021-09-12T10:12:42Z', - account_id = 3886, - name = 'Campaign and campaign access group manager', - description = 'Allows you to create and edit campaigns for specific Applications, delete specific campaign access groups, and view loyalty programs.', - permissions = talon_one.models.role_v2_permissions.RoleV2Permissions( - permission_sets = [{name=Application permission set, logicalOperations=[getApplicationOperations, editApplicationOperations]}, {name=Campaign manager permission set, logicalOperations=[getCampaignOperations, createCampaignOperations, updateCampaignOperations]}, {name=Campaign read-only permission set, logicalOperations=[getCampaignOperations]}, {name=Loyalty program read-only permission set, logicalOperations=[getLoyaltyProgramOperations]}, {name=Campaign access group manager permission set, logicalOperations=[getCampaignAccessGroupOperations, updateCampaignAccessGroupOperations, deleteCampaignAccessGroupOperations]}], - roles = talon_one.models.role_v2_roles_group.RoleV2RolesGroup( - applications = {1={application=Application permission set}, 3={campaign=Campaign manager permission set}, 4={draftCampaign=Campaign read-only permission set}, 5={tools=Tools permission set}}, - loyalty_programs = {10=Loyalty program manager permission set}, - campaign_access_groups = {5=Campaign access group manager permission set}, ), ), - members = [10, 12], ) + created = '2020-02-07T08:15:22Z', + name = 'South US store', + description = 'This is the description of the store in south US.', + attributes = {"country":"USA","code":1234}, + integration_id = 'STORE-001', + application_id = 322, + updated = '2021-09-23T10:12:42Z', + linked_campaign_ids = [4, 6, 8], ) ] ) else : return InlineResponse20044( - total_result_size = 1, data = [ - talon_one.models.role_v2.RoleV2( + talon_one.models.store.Store( id = 6, - created = '2020-06-10T09:05:27.993483Z', - modified = '2021-09-12T10:12:42Z', - account_id = 3886, - name = 'Campaign and campaign access group manager', - description = 'Allows you to create and edit campaigns for specific Applications, delete specific campaign access groups, and view loyalty programs.', - permissions = talon_one.models.role_v2_permissions.RoleV2Permissions( - permission_sets = [{name=Application permission set, logicalOperations=[getApplicationOperations, editApplicationOperations]}, {name=Campaign manager permission set, logicalOperations=[getCampaignOperations, createCampaignOperations, updateCampaignOperations]}, {name=Campaign read-only permission set, logicalOperations=[getCampaignOperations]}, {name=Loyalty program read-only permission set, logicalOperations=[getLoyaltyProgramOperations]}, {name=Campaign access group manager permission set, logicalOperations=[getCampaignAccessGroupOperations, updateCampaignAccessGroupOperations, deleteCampaignAccessGroupOperations]}], - roles = talon_one.models.role_v2_roles_group.RoleV2RolesGroup( - applications = {1={application=Application permission set}, 3={campaign=Campaign manager permission set}, 4={draftCampaign=Campaign read-only permission set}, 5={tools=Tools permission set}}, - loyalty_programs = {10=Loyalty program manager permission set}, - campaign_access_groups = {5=Campaign access group manager permission set}, ), ), - members = [10, 12], ) + created = '2020-02-07T08:15:22Z', + name = 'South US store', + description = 'This is the description of the store in south US.', + attributes = {"country":"USA","code":1234}, + integration_id = 'STORE-001', + application_id = 322, + updated = '2021-09-23T10:12:42Z', + linked_campaign_ids = [4, 6, 8], ) ], ) diff --git a/test/test_inline_response20045.py b/test/test_inline_response20045.py index 3de8272..c35e2a1 100644 --- a/test/test_inline_response20045.py +++ b/test/test_inline_response20045.py @@ -37,33 +37,46 @@ def make_instance(self, include_optional): if include_optional : return InlineResponse20045( has_more = True, - total_result_size = 1, data = [ - talon_one.models.store.Store( + talon_one.models.achievement.Achievement( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - name = 'South US store', - description = 'This is the description of the store in south US.', - attributes = {"country":"USA","code":1234}, - integration_id = 'STORE-001', - application_id = 322, - updated = '2021-09-23T10:12:42Z', - linked_campaign_ids = [4, 6, 8], ) + created = '2020-06-10T09:05:27.993483Z', + name = 'Order50Discount', + title = '50% off on 50th purchase.', + description = '50% off for every 50th purchase in a year.', + target = 50.0, + period = '1Y', + period_end_override = {month=11, dayOfMonth=23, hour=23, minute=59, second=59}, + recurrence_policy = 'no_recurrence', + activation_policy = 'fixed_schedule', + fixed_start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + campaign_id = 1, + user_id = 1234, + created_by = 'John Doe', + has_progress = True, ) ] ) else : return InlineResponse20045( data = [ - talon_one.models.store.Store( + talon_one.models.achievement.Achievement( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), - name = 'South US store', - description = 'This is the description of the store in south US.', - attributes = {"country":"USA","code":1234}, - integration_id = 'STORE-001', - application_id = 322, - updated = '2021-09-23T10:12:42Z', - linked_campaign_ids = [4, 6, 8], ) + created = '2020-06-10T09:05:27.993483Z', + name = 'Order50Discount', + title = '50% off on 50th purchase.', + description = '50% off for every 50th purchase in a year.', + target = 50.0, + period = '1Y', + period_end_override = {month=11, dayOfMonth=23, hour=23, minute=59, second=59}, + recurrence_policy = 'no_recurrence', + activation_policy = 'fixed_schedule', + fixed_start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + campaign_id = 1, + user_id = 1234, + created_by = 'John Doe', + has_progress = True, ) ], ) diff --git a/test/test_inline_response20046.py b/test/test_inline_response20046.py index f286440..a774541 100644 --- a/test/test_inline_response20046.py +++ b/test/test_inline_response20046.py @@ -38,37 +38,36 @@ def make_instance(self, include_optional): return InlineResponse20046( has_more = True, data = [ - talon_one.models.achievement.Achievement( - id = 6, - created = '2020-06-10T09:05:27.993483Z', - name = 'Order50Discount', + talon_one.models.achievement_progress.AchievementProgress( + achievement_id = 3, + name = 'FreeCoffee10Orders', title = '50% off on 50th purchase.', description = '50% off for every 50th purchase in a year.', - target = 50.0, - period = '1Y', - period_end_override = {month=11, dayOfMonth=23, hour=23, minute=59, second=59}, - campaign_id = 1, - user_id = 1234, - created_by = 'John Doe', - has_progress = True, ) + campaign_id = 3, + status = 'completed', + target = 10.0, + progress = 10.0, + start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + completion_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) ] ) else : return InlineResponse20046( + has_more = True, data = [ - talon_one.models.achievement.Achievement( - id = 6, - created = '2020-06-10T09:05:27.993483Z', - name = 'Order50Discount', + talon_one.models.achievement_progress.AchievementProgress( + achievement_id = 3, + name = 'FreeCoffee10Orders', title = '50% off on 50th purchase.', description = '50% off for every 50th purchase in a year.', - target = 50.0, - period = '1Y', - period_end_override = {month=11, dayOfMonth=23, hour=23, minute=59, second=59}, - campaign_id = 1, - user_id = 1234, - created_by = 'John Doe', - has_progress = True, ) + campaign_id = 3, + status = 'completed', + target = 10.0, + progress = 10.0, + start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + completion_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ) ], ) diff --git a/test/test_inline_response2005.py b/test/test_inline_response2005.py index 8b94ad4..b6b9394 100644 --- a/test/test_inline_response2005.py +++ b/test/test_inline_response2005.py @@ -71,10 +71,11 @@ def make_instance(self, include_optional): enable_partial_discounts = False, default_discount_additional_cost_per_item_scope = 'price', default_evaluation_group_id = 3, + default_cart_item_filter_id = 3, enable_campaign_state_management = False, loyalty_programs = [ talon_one.models.loyalty_program.LoyaltyProgram( - id = 56, + id = 139, created = '2020-06-10T09:05:27.993483Z', title = 'Point collection', description = 'Customers collect 10 points per 1$ spent', @@ -92,15 +93,17 @@ def make_instance(self, include_optional): card_code_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + return_policy = 'only_pending', account_id = 1, name = 'my_program', - tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programId=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programId=139}], + tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programID=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programID=139}], timezone = 'Europe/Berlin', card_based = True, can_update_tiers = True, can_update_join_policy = True, can_update_tier_expiration_policy = True, - can_upgrade_to_advanced_tiers = True, ) + can_upgrade_to_advanced_tiers = True, + can_update_subledgers = True, ) ], ) ] ) @@ -141,10 +144,11 @@ def make_instance(self, include_optional): enable_partial_discounts = False, default_discount_additional_cost_per_item_scope = 'price', default_evaluation_group_id = 3, + default_cart_item_filter_id = 3, enable_campaign_state_management = False, loyalty_programs = [ talon_one.models.loyalty_program.LoyaltyProgram( - id = 56, + id = 139, created = '2020-06-10T09:05:27.993483Z', title = 'Point collection', description = 'Customers collect 10 points per 1$ spent', @@ -162,15 +166,17 @@ def make_instance(self, include_optional): card_code_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + return_policy = 'only_pending', account_id = 1, name = 'my_program', - tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programId=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programId=139}], + tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programID=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programID=139}], timezone = 'Europe/Berlin', card_based = True, can_update_tiers = True, can_update_join_policy = True, can_update_tier_expiration_policy = True, - can_upgrade_to_advanced_tiers = True, ) + can_upgrade_to_advanced_tiers = True, + can_update_subledgers = True, ) ], ) ], ) diff --git a/test/test_inline_response2006.py b/test/test_inline_response2006.py index 8d7bfbd..9f0a26c 100644 --- a/test/test_inline_response2006.py +++ b/test/test_inline_response2006.py @@ -95,7 +95,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ) + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ) ] ) else : @@ -159,7 +166,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ) + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ) ], ) diff --git a/test/test_integration_api.py b/test/test_integration_api.py index dae02cd..0dcd314 100644 --- a/test/test_integration_api.py +++ b/test/test_integration_api.py @@ -108,7 +108,7 @@ def test_get_customer_session(self): def test_get_loyalty_balances(self): """Test case for get_loyalty_balances - Get customer's loyalty points # noqa: E501 + Get customer's loyalty balances # noqa: E501 """ pass diff --git a/test/test_integration_customer_session_response.py b/test/test_integration_customer_session_response.py index 4be1b3f..2874400 100644 --- a/test/test_integration_customer_session_response.py +++ b/test/test_integration_customer_session_response.py @@ -38,7 +38,7 @@ def make_instance(self, include_optional): return IntegrationCustomerSessionResponse( customer_session = talon_one.models.customer_session_v2.CustomerSessionV2( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', application_id = 322, profile_id = 'URNGV8294NV', @@ -69,13 +69,14 @@ def make_instance(self, include_optional): catalog_item_id = 56, ) ], additional_costs = {"shipping":{"price":9}}, - identifiers = [91.11.156.141], + identifiers = [d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea], attributes = {"ShippingCity":"Berlin"}, first_session = True, total = 119.99, cart_item_total = 99.99, additional_cost_total = 20.0, - updated = '2020-02-08T14:15:22Z', ), + updated = '2020-02-08T14:15:22Z', + closure_prediction = 0.283, ), effects = [ talon_one.models.effect.Effect( campaign_id = 244, @@ -88,6 +89,8 @@ def make_instance(self, include_optional): condition_index = 786, evaluation_group_id = 3, evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, props = talon_one.models.effect_props.EffectProps(), ) ] ) diff --git a/test/test_integration_request.py b/test/test_integration_request.py index 3ab86b2..899503e 100644 --- a/test/test_integration_request.py +++ b/test/test_integration_request.py @@ -65,7 +65,7 @@ def make_instance(self, include_optional): catalog_item_id = 56, ) ], additional_costs = {"shipping":{"price":9}}, - identifiers = [91.11.156.141], + identifiers = [d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea], attributes = {"ShippingCity":"Berlin"}, ), response_content = [customerSession, customerProfile] ) @@ -100,7 +100,7 @@ def make_instance(self, include_optional): catalog_item_id = 56, ) ], additional_costs = {"shipping":{"price":9}}, - identifiers = [91.11.156.141], + identifiers = [d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea], attributes = {"ShippingCity":"Berlin"}, ), ) diff --git a/test/test_integration_state.py b/test/test_integration_state.py index 450fe02..b5856af 100644 --- a/test/test_integration_state.py +++ b/test/test_integration_state.py @@ -37,7 +37,7 @@ def make_instance(self, include_optional): if include_optional : return IntegrationState( session = talon_one.models.customer_session.CustomerSession( - integration_id = '0', + integration_id = 'URNGV8294NV', created = '2020-02-07T08:15:22Z', application_id = 322, profile_id = 'URNGV8294NV', @@ -74,7 +74,7 @@ def make_instance(self, include_optional): updated = '2021-09-12T10:12:42Z', ), profile = talon_one.models.customer_profile.CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -82,7 +82,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -135,6 +135,8 @@ def make_instance(self, include_optional): id = 6, created = '2020-06-10T09:05:27.993483Z', program_id = 125, + program_name = 'Loyalty_program', + program_title = 'Loyalty program', status = 'active', block_reason = 'Current card lost. Customer needs a new card.', identifier = 'summer-loyalty-card-0543', @@ -170,7 +172,8 @@ def make_instance(self, include_optional): }, modified = '2021-09-12T10:12:42Z', old_card_identifier = 'summer-loyalty-card-0543', - new_card_identifier = 'summer-loyalty-card-0543', ) + new_card_identifier = 'summer-loyalty-card-0543', + batch_id = 'wdefpov', ) ], programs = { 'key' : talon_one.models.loyalty_program_ledgers.LoyaltyProgramLedgers( @@ -230,7 +233,7 @@ def make_instance(self, include_optional): else : return IntegrationState( session = talon_one.models.customer_session.CustomerSession( - integration_id = '0', + integration_id = 'URNGV8294NV', created = '2020-02-07T08:15:22Z', application_id = 322, profile_id = 'URNGV8294NV', @@ -267,7 +270,7 @@ def make_instance(self, include_optional): updated = '2021-09-12T10:12:42Z', ), profile = talon_one.models.customer_profile.CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -275,7 +278,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ diff --git a/test/test_integration_state_v2.py b/test/test_integration_state_v2.py index 2bb51cf..c142839 100644 --- a/test/test_integration_state_v2.py +++ b/test/test_integration_state_v2.py @@ -38,7 +38,7 @@ def make_instance(self, include_optional): return IntegrationStateV2( customer_session = talon_one.models.customer_session_v2.CustomerSessionV2( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', application_id = 322, profile_id = 'URNGV8294NV', @@ -69,16 +69,17 @@ def make_instance(self, include_optional): catalog_item_id = 56, ) ], additional_costs = {"shipping":{"price":9}}, - identifiers = [91.11.156.141], + identifiers = [d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea], attributes = {"ShippingCity":"Berlin"}, first_session = True, total = 119.99, cart_item_total = 99.99, additional_cost_total = 20.0, - updated = '2020-02-08T14:15:22Z', ), + updated = '2020-02-08T14:15:22Z', + closure_prediction = 0.283, ), customer_profile = talon_one.models.customer_profile.CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -86,7 +87,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -139,6 +140,8 @@ def make_instance(self, include_optional): id = 6, created = '2020-06-10T09:05:27.993483Z', program_id = 125, + program_name = 'Loyalty_program', + program_title = 'Loyalty program', status = 'active', block_reason = 'Current card lost. Customer needs a new card.', identifier = 'summer-loyalty-card-0543', @@ -174,7 +177,8 @@ def make_instance(self, include_optional): }, modified = '2021-09-12T10:12:42Z', old_card_identifier = 'summer-loyalty-card-0543', - new_card_identifier = 'summer-loyalty-card-0543', ) + new_card_identifier = 'summer-loyalty-card-0543', + batch_id = 'wdefpov', ) ], programs = { 'key' : talon_one.models.loyalty_program_ledgers.LoyaltyProgramLedgers( @@ -308,7 +312,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ) + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ) ], effects = [ talon_one.models.effect.Effect( @@ -322,6 +333,8 @@ def make_instance(self, include_optional): condition_index = 786, evaluation_group_id = 3, evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, props = talon_one.models.effect_props.EffectProps(), ) ], rule_failure_reasons = [ @@ -451,6 +464,8 @@ def make_instance(self, include_optional): condition_index = 786, evaluation_group_id = 3, evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, props = talon_one.models.effect_props.EffectProps(), ) ], created_coupons = [ diff --git a/test/test_list_campaign_store_budgets.py b/test/test_list_campaign_store_budgets.py new file mode 100644 index 0000000..82dd738 --- /dev/null +++ b/test/test_list_campaign_store_budgets.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.list_campaign_store_budgets import ListCampaignStoreBudgets # noqa: E501 +from talon_one.rest import ApiException + +class TestListCampaignStoreBudgets(unittest.TestCase): + """ListCampaignStoreBudgets unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ListCampaignStoreBudgets + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.list_campaign_store_budgets.ListCampaignStoreBudgets() # noqa: E501 + if include_optional : + return ListCampaignStoreBudgets( + store = talon_one.models.list_campaign_store_budgets_store.ListCampaignStoreBudgetsStore( + id = 56, + integration_id = '0', + name = '0', ), + limit = 56, + action = '0', + period = '0' + ) + else : + return ListCampaignStoreBudgets( + store = talon_one.models.list_campaign_store_budgets_store.ListCampaignStoreBudgetsStore( + id = 56, + integration_id = '0', + name = '0', ), + limit = 56, + action = '0', + ) + + def testListCampaignStoreBudgets(self): + """Test ListCampaignStoreBudgets""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_list_campaign_store_budgets_store.py b/test/test_list_campaign_store_budgets_store.py new file mode 100644 index 0000000..d49ac19 --- /dev/null +++ b/test/test_list_campaign_store_budgets_store.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.list_campaign_store_budgets_store import ListCampaignStoreBudgetsStore # noqa: E501 +from talon_one.rest import ApiException + +class TestListCampaignStoreBudgetsStore(unittest.TestCase): + """ListCampaignStoreBudgetsStore unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ListCampaignStoreBudgetsStore + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.list_campaign_store_budgets_store.ListCampaignStoreBudgetsStore() # noqa: E501 + if include_optional : + return ListCampaignStoreBudgetsStore( + id = 56, + integration_id = '0', + name = '0' + ) + else : + return ListCampaignStoreBudgetsStore( + id = 56, + integration_id = '0', + name = '0', + ) + + def testListCampaignStoreBudgetsStore(self): + """Test ListCampaignStoreBudgetsStore""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_loyalty.py b/test/test_loyalty.py index 0f13bfd..5eba21b 100644 --- a/test/test_loyalty.py +++ b/test/test_loyalty.py @@ -41,6 +41,8 @@ def make_instance(self, include_optional): id = 6, created = '2020-06-10T09:05:27.993483Z', program_id = 125, + program_name = 'Loyalty_program', + program_title = 'Loyalty program', status = 'active', block_reason = 'Current card lost. Customer needs a new card.', identifier = 'summer-loyalty-card-0543', @@ -76,7 +78,8 @@ def make_instance(self, include_optional): }, modified = '2021-09-12T10:12:42Z', old_card_identifier = 'summer-loyalty-card-0543', - new_card_identifier = 'summer-loyalty-card-0543', ) + new_card_identifier = 'summer-loyalty-card-0543', + batch_id = 'wdefpov', ) ], programs = { 'key' : talon_one.models.loyalty_program_ledgers.LoyaltyProgramLedgers( diff --git a/test/test_loyalty_card.py b/test/test_loyalty_card.py index c297dc0..caa022e 100644 --- a/test/test_loyalty_card.py +++ b/test/test_loyalty_card.py @@ -39,6 +39,8 @@ def make_instance(self, include_optional): id = 6, created = '2020-06-10T09:05:27.993483Z', program_id = 125, + program_name = 'Loyalty_program', + program_title = 'Loyalty program', status = 'active', block_reason = 'Current card lost. Customer needs a new card.', identifier = 'summer-loyalty-card-0543', @@ -80,7 +82,8 @@ def make_instance(self, include_optional): }, modified = '2021-09-12T10:12:42Z', old_card_identifier = 'summer-loyalty-card-0543', - new_card_identifier = 'summer-loyalty-card-0543' + new_card_identifier = 'summer-loyalty-card-0543', + batch_id = 'wdefpov' ) else : return LoyaltyCard( diff --git a/test/test_loyalty_card_batch.py b/test/test_loyalty_card_batch.py new file mode 100644 index 0000000..72a42ba --- /dev/null +++ b/test/test_loyalty_card_batch.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.loyalty_card_batch import LoyaltyCardBatch # noqa: E501 +from talon_one.rest import ApiException + +class TestLoyaltyCardBatch(unittest.TestCase): + """LoyaltyCardBatch unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test LoyaltyCardBatch + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.loyalty_card_batch.LoyaltyCardBatch() # noqa: E501 + if include_optional : + return LoyaltyCardBatch( + number_of_cards = 5000, + batch_id = 'hwernpjz', + status = 'active', + card_code_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( + valid_characters = [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], + coupon_pattern = 'SUMMER-####-####', ) + ) + else : + return LoyaltyCardBatch( + number_of_cards = 5000, + ) + + def testLoyaltyCardBatch(self): + """Test LoyaltyCardBatch""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_loyalty_card_batch_response.py b/test/test_loyalty_card_batch_response.py new file mode 100644 index 0000000..33d5c1f --- /dev/null +++ b/test/test_loyalty_card_batch_response.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.loyalty_card_batch_response import LoyaltyCardBatchResponse # noqa: E501 +from talon_one.rest import ApiException + +class TestLoyaltyCardBatchResponse(unittest.TestCase): + """LoyaltyCardBatchResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test LoyaltyCardBatchResponse + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.loyalty_card_batch_response.LoyaltyCardBatchResponse() # noqa: E501 + if include_optional : + return LoyaltyCardBatchResponse( + number_of_cards_generated = 5000, + batch_id = 'hwernpjz' + ) + else : + return LoyaltyCardBatchResponse( + number_of_cards_generated = 5000, + batch_id = 'hwernpjz', + ) + + def testLoyaltyCardBatchResponse(self): + """Test LoyaltyCardBatchResponse""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_loyalty_ledger.py b/test/test_loyalty_ledger.py index 886d253..7ba0fdc 100644 --- a/test/test_loyalty_ledger.py +++ b/test/test_loyalty_ledger.py @@ -133,7 +133,7 @@ def make_instance(self, include_optional): start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), expiry_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), downgrade_policy = 'one_down', ), ), - sub_ledgers = {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25}} + sub_ledgers = {"mysubledger":{"total":0,"totalActivePoints":286,"totalPendingPoints":50,"totalSpentPoints":150,"totalExpiredPoints":25}} ) else : return LoyaltyLedger( diff --git a/test/test_loyalty_membership.py b/test/test_loyalty_membership.py index 31234f2..307e3a4 100644 --- a/test/test_loyalty_membership.py +++ b/test/test_loyalty_membership.py @@ -36,7 +36,7 @@ def make_instance(self, include_optional): # model = talon_one.models.loyalty_membership.LoyaltyMembership() # noqa: E501 if include_optional : return LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846 ) else : diff --git a/test/test_loyalty_program.py b/test/test_loyalty_program.py index 8c2b2db..32b5522 100644 --- a/test/test_loyalty_program.py +++ b/test/test_loyalty_program.py @@ -36,7 +36,7 @@ def make_instance(self, include_optional): # model = talon_one.models.loyalty_program.LoyaltyProgram() # noqa: E501 if include_optional : return LoyaltyProgram( - id = 56, + id = 139, created = '2020-06-10T09:05:27.993483Z', title = 'Point collection', description = 'Customers collect 10 points per 1$ spent', @@ -54,19 +54,21 @@ def make_instance(self, include_optional): card_code_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + return_policy = 'only_pending', account_id = 1, name = 'my_program', - tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programId=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programId=139}], + tiers = [{name=Gold, minPoints=300, id=3, created=2021-06-10T09:05:27.993483Z, programID=139}, {name=Silver, minPoints=200, id=2, created=2021-06-10T09:04:59.355258Z, programID=139}, {name=Bronze, minPoints=100, id=1, created=2021-06-10T09:04:39.355258Z, programID=139}], timezone = 'Europe/Berlin', card_based = True, can_update_tiers = True, can_update_join_policy = True, can_update_tier_expiration_policy = True, - can_upgrade_to_advanced_tiers = True + can_upgrade_to_advanced_tiers = True, + can_update_subledgers = True ) else : return LoyaltyProgram( - id = 56, + id = 139, created = '2020-06-10T09:05:27.993483Z', title = 'Point collection', description = 'Customers collect 10 points per 1$ spent', diff --git a/test/test_loyalty_program_entity.py b/test/test_loyalty_program_entity.py index beaecbd..d4e20b3 100644 --- a/test/test_loyalty_program_entity.py +++ b/test/test_loyalty_program_entity.py @@ -36,7 +36,9 @@ def make_instance(self, include_optional): # model = talon_one.models.loyalty_program_entity.LoyaltyProgramEntity() # noqa: E501 if include_optional : return LoyaltyProgramEntity( - program_id = 125 + program_id = 125, + program_name = 'Loyalty_program', + program_title = 'Loyalty program' ) else : return LoyaltyProgramEntity( diff --git a/test/test_loyalty_tier.py b/test/test_loyalty_tier.py index a794b53..cce2317 100644 --- a/test/test_loyalty_tier.py +++ b/test/test_loyalty_tier.py @@ -39,6 +39,8 @@ def make_instance(self, include_optional): id = 6, created = '2020-06-10T09:05:27.993483Z', program_id = 125, + program_name = 'Loyalty_program', + program_title = 'Loyalty program', name = 'Gold', min_points = 300.0 ) diff --git a/test/test_management_api.py b/test/test_management_api.py index 40d6eb3..0cb51fb 100644 --- a/test/test_management_api.py +++ b/test/test_management_api.py @@ -84,6 +84,13 @@ def test_create_attribute(self): """ pass + def test_create_batch_loyalty_cards(self): + """Test case for create_batch_loyalty_cards + + Create loyalty cards # noqa: E501 + """ + pass + def test_create_campaign_from_template(self): """Test case for create_campaign_from_template @@ -357,6 +364,13 @@ def test_export_loyalty_card_ledger(self): """ pass + def test_export_loyalty_cards(self): + """Test case for export_loyalty_cards + + Export loyalty cards # noqa: E501 + """ + pass + def test_export_loyalty_ledger(self): """Test case for export_loyalty_ledger @@ -427,13 +441,6 @@ def test_get_additional_costs(self): """ pass - def test_get_all_access_logs(self): - """Test case for get_all_access_logs - - List access logs # noqa: E501 - """ - pass - def test_get_application(self): """Test case for get_application @@ -1032,7 +1039,7 @@ def test_scim_get_schemas(self): def test_scim_get_service_provider_config(self): """Test case for scim_get_service_provider_config - Service config endpoint for SCIM provisioning protocol # noqa: E501 + Get SCIM service provider configuration # noqa: E501 """ pass diff --git a/test/test_message_log_entries.py b/test/test_message_log_entries.py index 7556f3f..98b808e 100644 --- a/test/test_message_log_entries.py +++ b/test/test_message_log_entries.py @@ -44,6 +44,8 @@ def make_instance(self, include_optional): change_type = 'Update', notification_id = 101, notification_name = 'My campaign notification', + webhook_id = 101, + webhook_name = 'My webhook', request = talon_one.models.message_log_request.MessageLogRequest( created_at = '2021-07-20T21:59Z', request = 'SGVsbG8sIHdvcmxkIQ==', ), @@ -52,8 +54,10 @@ def make_instance(self, include_optional): status = 200, ), created_at = '2021-07-20T22:00Z', entity_type = 'loyalty_program', + url = 'www.my-company.com/my-endpoint-name', application_id = 5, - loyalty_program_id = 2, ) + loyalty_program_id = 2, + campaign_id = 2, ) ] ) else : @@ -65,6 +69,8 @@ def make_instance(self, include_optional): change_type = 'Update', notification_id = 101, notification_name = 'My campaign notification', + webhook_id = 101, + webhook_name = 'My webhook', request = talon_one.models.message_log_request.MessageLogRequest( created_at = '2021-07-20T21:59Z', request = 'SGVsbG8sIHdvcmxkIQ==', ), @@ -73,8 +79,10 @@ def make_instance(self, include_optional): status = 200, ), created_at = '2021-07-20T22:00Z', entity_type = 'loyalty_program', + url = 'www.my-company.com/my-endpoint-name', application_id = 5, - loyalty_program_id = 2, ) + loyalty_program_id = 2, + campaign_id = 2, ) ], ) diff --git a/test/test_message_log_entry.py b/test/test_message_log_entry.py index 1e11e9c..a4c5a49 100644 --- a/test/test_message_log_entry.py +++ b/test/test_message_log_entry.py @@ -41,6 +41,8 @@ def make_instance(self, include_optional): change_type = 'Update', notification_id = 101, notification_name = 'My campaign notification', + webhook_id = 101, + webhook_name = 'My webhook', request = talon_one.models.message_log_request.MessageLogRequest( created_at = '2021-07-20T21:59Z', request = 'SGVsbG8sIHdvcmxkIQ==', ), @@ -49,14 +51,17 @@ def make_instance(self, include_optional): status = 200, ), created_at = '2021-07-20T22:00Z', entity_type = 'loyalty_program', + url = 'www.my-company.com/my-endpoint-name', application_id = 5, - loyalty_program_id = 2 + loyalty_program_id = 2, + campaign_id = 2 ) else : return MessageLogEntry( id = '123e4567-e89b-12d3-a456-426614174000', service = 'NotificationService', created_at = '2021-07-20T22:00Z', + entity_type = 'loyalty_program', ) def testMessageLogEntry(self): diff --git a/test/test_multiple_customer_profile_integration_response_v2.py b/test/test_multiple_customer_profile_integration_response_v2.py index de65c15..b5a7315 100644 --- a/test/test_multiple_customer_profile_integration_response_v2.py +++ b/test/test_multiple_customer_profile_integration_response_v2.py @@ -40,7 +40,7 @@ def make_instance(self, include_optional): talon_one.models.customer_profile_update_v2_response.CustomerProfileUpdateV2Response( customer_profile = talon_one.models.customer_profile.CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -48,7 +48,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ diff --git a/test/test_new_app_wide_coupon_deletion_job.py b/test/test_new_app_wide_coupon_deletion_job.py index 2e29e19..2b04061 100644 --- a/test/test_new_app_wide_coupon_deletion_job.py +++ b/test/test_new_app_wide_coupon_deletion_job.py @@ -46,7 +46,7 @@ def make_instance(self, include_optional): redeemed = True, recipient_integration_id = '0', exact_match = True, - value = 'false', + value = '0', batch_id = '0', referral_id = 56, expires_after = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), @@ -67,7 +67,7 @@ def make_instance(self, include_optional): redeemed = True, recipient_integration_id = '0', exact_match = True, - value = 'false', + value = '0', batch_id = '0', referral_id = 56, expires_after = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), diff --git a/test/test_new_application_cif.py b/test/test_new_application_cif.py new file mode 100644 index 0000000..6288eca --- /dev/null +++ b/test/test_new_application_cif.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.new_application_cif import NewApplicationCIF # noqa: E501 +from talon_one.rest import ApiException + +class TestNewApplicationCIF(unittest.TestCase): + """NewApplicationCIF unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test NewApplicationCIF + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.new_application_cif.NewApplicationCIF() # noqa: E501 + if include_optional : + return NewApplicationCIF( + name = 'Filter items by product', + description = 'This filter allows filtering by shoes', + active_expression_id = 1, + modified_by = 334, + created_by = 216, + modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else : + return NewApplicationCIF( + name = 'Filter items by product', + ) + + def testNewApplicationCIF(self): + """Test NewApplicationCIF""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_new_application_cif_expression.py b/test/test_new_application_cif_expression.py new file mode 100644 index 0000000..a385ec2 --- /dev/null +++ b/test/test_new_application_cif_expression.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.new_application_cif_expression import NewApplicationCIFExpression # noqa: E501 +from talon_one.rest import ApiException + +class TestNewApplicationCIFExpression(unittest.TestCase): + """NewApplicationCIFExpression unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test NewApplicationCIFExpression + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.new_application_cif_expression.NewApplicationCIFExpression() # noqa: E501 + if include_optional : + return NewApplicationCIFExpression( + cart_item_filter_id = 216, + created_by = 216, + expression = {expr=[filter, [., Session, CartItems], [[Item], [catch, false, [=, [., Item, Category], Kitchen]]]]} + ) + else : + return NewApplicationCIFExpression( + ) + + def testNewApplicationCIFExpression(self): + """Test NewApplicationCIFExpression""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_new_campaign_store_budget.py b/test/test_new_campaign_store_budget.py new file mode 100644 index 0000000..72ea54c --- /dev/null +++ b/test/test_new_campaign_store_budget.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.new_campaign_store_budget import NewCampaignStoreBudget # noqa: E501 +from talon_one.rest import ApiException + +class TestNewCampaignStoreBudget(unittest.TestCase): + """NewCampaignStoreBudget unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test NewCampaignStoreBudget + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.new_campaign_store_budget.NewCampaignStoreBudget() # noqa: E501 + if include_optional : + return NewCampaignStoreBudget( + action = 'setDiscount', + store_limits = [ + talon_one.models.new_campaign_store_budget_store_limit.NewCampaignStoreBudgetStoreLimit( + store_id = 17, + limit = 1000.0, ) + ], + period = 'daily' + ) + else : + return NewCampaignStoreBudget( + action = 'setDiscount', + store_limits = [ + talon_one.models.new_campaign_store_budget_store_limit.NewCampaignStoreBudgetStoreLimit( + store_id = 17, + limit = 1000.0, ) + ], + ) + + def testNewCampaignStoreBudget(self): + """Test NewCampaignStoreBudget""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_new_campaign_store_budget_store_limit.py b/test/test_new_campaign_store_budget_store_limit.py new file mode 100644 index 0000000..5c96fdb --- /dev/null +++ b/test/test_new_campaign_store_budget_store_limit.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.new_campaign_store_budget_store_limit import NewCampaignStoreBudgetStoreLimit # noqa: E501 +from talon_one.rest import ApiException + +class TestNewCampaignStoreBudgetStoreLimit(unittest.TestCase): + """NewCampaignStoreBudgetStoreLimit unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test NewCampaignStoreBudgetStoreLimit + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.new_campaign_store_budget_store_limit.NewCampaignStoreBudgetStoreLimit() # noqa: E501 + if include_optional : + return NewCampaignStoreBudgetStoreLimit( + store_id = 17, + limit = 1000.0 + ) + else : + return NewCampaignStoreBudgetStoreLimit( + store_id = 17, + limit = 1000.0, + ) + + def testNewCampaignStoreBudgetStoreLimit(self): + """Test NewCampaignStoreBudgetStoreLimit""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_new_campaign_template.py b/test/test_new_campaign_template.py index 2cd2562..7689f1f 100644 --- a/test/test_new_campaign_template.py +++ b/test/test_new_campaign_template.py @@ -51,6 +51,9 @@ def make_instance(self, include_optional): coupon_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + coupon_reservation_settings = talon_one.models.campaign_template_coupon_reservation_settings.CampaignTemplateCouponReservationSettings( + reservation_limit = 45, + is_reservation_mandatory = False, ), referral_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), diff --git a/test/test_new_coupon_deletion_job.py b/test/test_new_coupon_deletion_job.py index 49ccb9a..44e1455 100644 --- a/test/test_new_coupon_deletion_job.py +++ b/test/test_new_coupon_deletion_job.py @@ -46,7 +46,7 @@ def make_instance(self, include_optional): redeemed = True, recipient_integration_id = '0', exact_match = True, - value = 'false', + value = '0', batch_id = '0', referral_id = 56, expires_after = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), @@ -64,7 +64,7 @@ def make_instance(self, include_optional): redeemed = True, recipient_integration_id = '0', exact_match = True, - value = 'false', + value = '0', batch_id = '0', referral_id = 56, expires_after = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), diff --git a/test/test_new_custom_effect.py b/test/test_new_custom_effect.py index b64129c..afddfe0 100644 --- a/test/test_new_custom_effect.py +++ b/test/test_new_custom_effect.py @@ -51,6 +51,7 @@ def make_instance(self, include_optional): description = '0', title = '0', ui = talon_one.models.ui.ui(), + key = '0', picklist_id = 56, restricted_by_picklist = True, ) ] diff --git a/test/test_new_customer_session_v2.py b/test/test_new_customer_session_v2.py index 62d5db6..860ed40 100644 --- a/test/test_new_customer_session_v2.py +++ b/test/test_new_customer_session_v2.py @@ -64,7 +64,7 @@ def make_instance(self, include_optional): catalog_item_id = 56, ) ], additional_costs = {"shipping":{"price":9}}, - identifiers = [91.11.156.141], + identifiers = [d41306257915f83fe01e54092ae470f631161ea16fcf4415842eed41470386ea], attributes = {"ShippingCity":"Berlin"} ) else : diff --git a/test/test_new_invitation.py b/test/test_new_invitation.py index d9132bf..8a77089 100644 --- a/test/test_new_invitation.py +++ b/test/test_new_invitation.py @@ -40,7 +40,7 @@ def make_instance(self, include_optional): email = 'john.doe@example.com', is_admin = False, roles = [ - 56 + 13 ], acl = '0' ) diff --git a/test/test_new_loyalty_program.py b/test/test_new_loyalty_program.py index 438bdce..daa7ae8 100644 --- a/test/test_new_loyalty_program.py +++ b/test/test_new_loyalty_program.py @@ -52,6 +52,7 @@ def make_instance(self, include_optional): card_code_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + return_policy = 'only_pending', name = 'GeneralPointCollection', tiers = [ talon_one.models.new_loyalty_tier.NewLoyaltyTier( diff --git a/test/test_new_picklist.py b/test/test_new_picklist.py index 8ea047a..d759c62 100644 --- a/test/test_new_picklist.py +++ b/test/test_new_picklist.py @@ -36,12 +36,12 @@ def make_instance(self, include_optional): # model = talon_one.models.new_picklist.NewPicklist() # noqa: E501 if include_optional : return NewPicklist( - type = '2012-11-01T22:08:41+00:00', + type = 'string', values = [Jeans, Shirt, Coat] ) else : return NewPicklist( - type = '2012-11-01T22:08:41+00:00', + type = 'string', values = [Jeans, Shirt, Coat], ) diff --git a/test/test_new_revision_version.py b/test/test_new_revision_version.py new file mode 100644 index 0000000..10ca2ea --- /dev/null +++ b/test/test_new_revision_version.py @@ -0,0 +1,76 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.new_revision_version import NewRevisionVersion # noqa: E501 +from talon_one.rest import ApiException + +class TestNewRevisionVersion(unittest.TestCase): + """NewRevisionVersion unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test NewRevisionVersion + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.new_revision_version.NewRevisionVersion() # noqa: E501 + if include_optional : + return NewRevisionVersion( + name = 'Summer promotions', + start_time = '2021-07-20T22:00Z', + end_time = '2021-09-22T22:00Z', + attributes = None, + description = 'Campaign for all summer 2021 promotions', + active_ruleset_id = 5, + tags = [ + '0' + ], + coupon_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( + valid_characters = [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], + coupon_pattern = 'SUMMER-####-####', ), + referral_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( + valid_characters = [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], + coupon_pattern = 'SUMMER-####-####', ), + limits = [ + talon_one.models.limit_config.LimitConfig( + action = 'createCoupon', + limit = 1000.0, + period = 'yearly', + entities = [Coupon], ) + ], + features = [ + 'coupons' + ] + ) + else : + return NewRevisionVersion( + ) + + def testNewRevisionVersion(self): + """Test NewRevisionVersion""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_new_template_def.py b/test/test_new_template_def.py index a2d71df..547fe17 100644 --- a/test/test_new_template_def.py +++ b/test/test_new_template_def.py @@ -49,6 +49,7 @@ def make_instance(self, include_optional): description = '0', title = '0', ui = talon_one.models.ui.ui(), + key = '0', picklist_id = 56, restricted_by_picklist = True, ) ], @@ -67,6 +68,7 @@ def make_instance(self, include_optional): description = '0', title = '0', ui = talon_one.models.ui.ui(), + key = '0', picklist_id = 56, restricted_by_picklist = True, ) ], diff --git a/test/test_picklist.py b/test/test_picklist.py index b726f9a..295924a 100644 --- a/test/test_picklist.py +++ b/test/test_picklist.py @@ -38,7 +38,7 @@ def make_instance(self, include_optional): return Picklist( id = 6, created = '2020-06-10T09:05:27.993483Z', - type = '2012-11-01T22:08:41+00:00', + type = 'string', values = [Jeans, Shirt, Coat], modified_by = 124, created_by = 134, @@ -49,7 +49,7 @@ def make_instance(self, include_optional): return Picklist( id = 6, created = '2020-06-10T09:05:27.993483Z', - type = '2012-11-01T22:08:41+00:00', + type = 'string', values = [Jeans, Shirt, Coat], created_by = 134, ) diff --git a/test/test_product_search_match.py b/test/test_product_search_match.py new file mode 100644 index 0000000..a23abfd --- /dev/null +++ b/test/test_product_search_match.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.product_search_match import ProductSearchMatch # noqa: E501 +from talon_one.rest import ApiException + +class TestProductSearchMatch(unittest.TestCase): + """ProductSearchMatch unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ProductSearchMatch + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.product_search_match.ProductSearchMatch() # noqa: E501 + if include_optional : + return ProductSearchMatch( + product_id = 1, + value = 'MyProduct', + product_sku_id = 1 + ) + else : + return ProductSearchMatch( + product_id = 1, + value = 'MyProduct', + ) + + def testProductSearchMatch(self): + """Test ProductSearchMatch""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_product_sku_unit_analytics.py b/test/test_product_sku_unit_analytics.py new file mode 100644 index 0000000..54448da --- /dev/null +++ b/test/test_product_sku_unit_analytics.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.product_sku_unit_analytics import ProductSkuUnitAnalytics # noqa: E501 +from talon_one.rest import ApiException + +class TestProductSkuUnitAnalytics(unittest.TestCase): + """ProductSkuUnitAnalytics unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ProductSkuUnitAnalytics + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.product_sku_unit_analytics.ProductSkuUnitAnalytics() # noqa: E501 + if include_optional : + return ProductSkuUnitAnalytics( + start_time = '2024-02-01T00:00Z', + end_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + purchased_units = talon_one.models.analytics_data_point_with_trend.AnalyticsDataPointWithTrend( + value = 12.0, + trend = 3.25, ), + sku = 'SKU-123' + ) + else : + return ProductSkuUnitAnalytics( + start_time = '2024-02-01T00:00Z', + end_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + purchased_units = talon_one.models.analytics_data_point_with_trend.AnalyticsDataPointWithTrend( + value = 12.0, + trend = 3.25, ), + sku = 'SKU-123', + ) + + def testProductSkuUnitAnalytics(self): + """Test ProductSkuUnitAnalytics""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_product_unit_analytics.py b/test/test_product_unit_analytics.py new file mode 100644 index 0000000..f6971f3 --- /dev/null +++ b/test/test_product_unit_analytics.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.product_unit_analytics import ProductUnitAnalytics # noqa: E501 +from talon_one.rest import ApiException + +class TestProductUnitAnalytics(unittest.TestCase): + """ProductUnitAnalytics unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ProductUnitAnalytics + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.product_unit_analytics.ProductUnitAnalytics() # noqa: E501 + if include_optional : + return ProductUnitAnalytics( + start_time = '2024-02-01T00:00Z', + end_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + purchased_units = talon_one.models.analytics_data_point_with_trend.AnalyticsDataPointWithTrend( + value = 12.0, + trend = 3.25, ), + product_id = 1, + product_name = 'MyProduct' + ) + else : + return ProductUnitAnalytics( + start_time = '2024-02-01T00:00Z', + end_time = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + purchased_units = talon_one.models.analytics_data_point_with_trend.AnalyticsDataPointWithTrend( + value = 12.0, + trend = 3.25, ), + product_id = 1, + product_name = 'MyProduct', + ) + + def testProductUnitAnalytics(self): + """Test ProductUnitAnalytics""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_reopen_session_response.py b/test/test_reopen_session_response.py index fd68b06..20a4ac0 100644 --- a/test/test_reopen_session_response.py +++ b/test/test_reopen_session_response.py @@ -48,6 +48,8 @@ def make_instance(self, include_optional): condition_index = 786, evaluation_group_id = 3, evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, props = talon_one.models.effect_props.EffectProps(), ) ] ) @@ -65,6 +67,8 @@ def make_instance(self, include_optional): condition_index = 786, evaluation_group_id = 3, evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, props = talon_one.models.effect_props.EffectProps(), ) ], ) diff --git a/test/test_revision.py b/test/test_revision.py new file mode 100644 index 0000000..55dacd5 --- /dev/null +++ b/test/test_revision.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.revision import Revision # noqa: E501 +from talon_one.rest import ApiException + +class TestRevision(unittest.TestCase): + """Revision unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test Revision + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.revision.Revision() # noqa: E501 + if include_optional : + return Revision( + id = 6, + activate_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + account_id = 56, + application_id = 56, + campaign_id = 56, + created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created_by = 56, + activated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + activated_by = 56, + current_version = talon_one.models.revision_version.RevisionVersion( + id = 6, + account_id = 56, + application_id = 56, + campaign_id = 56, + created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created_by = 56, + revision_id = 56, + version = 56, + name = 'Summer promotions', + start_time = '2021-07-20T22:00Z', + end_time = '2021-09-22T22:00Z', + attributes = talon_one.models.attributes.attributes(), + description = 'Campaign for all summer 2021 promotions', + active_ruleset_id = 5, + tags = [ + '0' + ], + coupon_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( + valid_characters = [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], + coupon_pattern = 'SUMMER-####-####', ), + referral_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( + valid_characters = [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], + coupon_pattern = 'SUMMER-####-####', ), + limits = [ + talon_one.models.limit_config.LimitConfig( + action = 'createCoupon', + limit = 1000.0, + period = 'yearly', + entities = [Coupon], ) + ], + features = [ + 'coupons' + ], ) + ) + else : + return Revision( + id = 6, + account_id = 56, + application_id = 56, + campaign_id = 56, + created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created_by = 56, + ) + + def testRevision(self): + """Test Revision""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_revision_activation.py b/test/test_revision_activation.py new file mode 100644 index 0000000..d6e2c65 --- /dev/null +++ b/test/test_revision_activation.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.revision_activation import RevisionActivation # noqa: E501 +from talon_one.rest import ApiException + +class TestRevisionActivation(unittest.TestCase): + """RevisionActivation unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test RevisionActivation + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.revision_activation.RevisionActivation() # noqa: E501 + if include_optional : + return RevisionActivation( + activate_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else : + return RevisionActivation( + ) + + def testRevisionActivation(self): + """Test RevisionActivation""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_revision_version.py b/test/test_revision_version.py new file mode 100644 index 0000000..19abbdc --- /dev/null +++ b/test/test_revision_version.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.revision_version import RevisionVersion # noqa: E501 +from talon_one.rest import ApiException + +class TestRevisionVersion(unittest.TestCase): + """RevisionVersion unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test RevisionVersion + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.revision_version.RevisionVersion() # noqa: E501 + if include_optional : + return RevisionVersion( + id = 6, + account_id = 56, + application_id = 56, + campaign_id = 56, + created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created_by = 56, + revision_id = 56, + version = 56, + name = 'Summer promotions', + start_time = '2021-07-20T22:00Z', + end_time = '2021-09-22T22:00Z', + attributes = talon_one.models.attributes.attributes(), + description = 'Campaign for all summer 2021 promotions', + active_ruleset_id = 5, + tags = [ + '0' + ], + coupon_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( + valid_characters = [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], + coupon_pattern = 'SUMMER-####-####', ), + referral_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( + valid_characters = [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], + coupon_pattern = 'SUMMER-####-####', ), + limits = [ + talon_one.models.limit_config.LimitConfig( + action = 'createCoupon', + limit = 1000.0, + period = 'yearly', + entities = [Coupon], ) + ], + features = [ + 'coupons' + ] + ) + else : + return RevisionVersion( + id = 6, + account_id = 56, + application_id = 56, + campaign_id = 56, + created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created_by = 56, + revision_id = 56, + version = 56, + ) + + def testRevisionVersion(self): + """Test RevisionVersion""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scim_base_user.py b/test/test_scim_base_user.py new file mode 100644 index 0000000..febdbab --- /dev/null +++ b/test/test_scim_base_user.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.scim_base_user import ScimBaseUser # noqa: E501 +from talon_one.rest import ApiException + +class TestScimBaseUser(unittest.TestCase): + """ScimBaseUser unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ScimBaseUser + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.scim_base_user.ScimBaseUser() # noqa: E501 + if include_optional : + return ScimBaseUser( + active = True, + display_name = 'John Doe', + user_name = 'john.doe@example.com', + name = talon_one.models.scim_base_user_name.ScimBaseUser_name( + formatted = 'Mr. John J Doe', ) + ) + else : + return ScimBaseUser( + ) + + def testScimBaseUser(self): + """Test ScimBaseUser""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scim_base_user_name.py b/test/test_scim_base_user_name.py new file mode 100644 index 0000000..d986873 --- /dev/null +++ b/test/test_scim_base_user_name.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.scim_base_user_name import ScimBaseUserName # noqa: E501 +from talon_one.rest import ApiException + +class TestScimBaseUserName(unittest.TestCase): + """ScimBaseUserName unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ScimBaseUserName + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.scim_base_user_name.ScimBaseUserName() # noqa: E501 + if include_optional : + return ScimBaseUserName( + formatted = 'Mr. John J Doe' + ) + else : + return ScimBaseUserName( + ) + + def testScimBaseUserName(self): + """Test ScimBaseUserName""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scim_new_user.py b/test/test_scim_new_user.py index 3a254e8..1ef3caa 100644 --- a/test/test_scim_new_user.py +++ b/test/test_scim_new_user.py @@ -38,7 +38,9 @@ def make_instance(self, include_optional): return ScimNewUser( active = True, display_name = 'John Doe', - user_name = 'john.doe@example.com' + user_name = 'john.doe@example.com', + name = talon_one.models.scim_base_user_name.ScimBaseUser_name( + formatted = 'Mr. John J Doe', ) ) else : return ScimNewUser( diff --git a/test/test_scim_patch_operation.py b/test/test_scim_patch_operation.py new file mode 100644 index 0000000..ca053f2 --- /dev/null +++ b/test/test_scim_patch_operation.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.scim_patch_operation import ScimPatchOperation # noqa: E501 +from talon_one.rest import ApiException + +class TestScimPatchOperation(unittest.TestCase): + """ScimPatchOperation unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ScimPatchOperation + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.scim_patch_operation.ScimPatchOperation() # noqa: E501 + if include_optional : + return ScimPatchOperation( + op = 'add', + path = '0', + value = '0' + ) + else : + return ScimPatchOperation( + op = 'add', + ) + + def testScimPatchOperation(self): + """Test ScimPatchOperation""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scim_patch_request.py b/test/test_scim_patch_request.py new file mode 100644 index 0000000..7c83bf2 --- /dev/null +++ b/test/test_scim_patch_request.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.scim_patch_request import ScimPatchRequest # noqa: E501 +from talon_one.rest import ApiException + +class TestScimPatchRequest(unittest.TestCase): + """ScimPatchRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ScimPatchRequest + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.scim_patch_request.ScimPatchRequest() # noqa: E501 + if include_optional : + return ScimPatchRequest( + schemas = [ + 'urn:ietf:params:scim:api:messages:2.0:PatchOp' + ], + operations = [ + {op=add, path=nickName, value=John} + ] + ) + else : + return ScimPatchRequest( + operations = [ + {op=add, path=nickName, value=John} + ], + ) + + def testScimPatchRequest(self): + """Test ScimPatchRequest""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scim_resource.py b/test/test_scim_resource.py index 4e9e9ad..c44fe48 100644 --- a/test/test_scim_resource.py +++ b/test/test_scim_resource.py @@ -37,7 +37,8 @@ def make_instance(self, include_optional): if include_optional : return ScimResource( id = '0', - name = '0' + name = '0', + description = '0' ) else : return ScimResource( diff --git a/test/test_scim_resource_types_list_response.py b/test/test_scim_resource_types_list_response.py index 7e2b98a..d94c7e7 100644 --- a/test/test_scim_resource_types_list_response.py +++ b/test/test_scim_resource_types_list_response.py @@ -37,13 +37,13 @@ def make_instance(self, include_optional): if include_optional : return ScimResourceTypesListResponse( resources = [ - {id=User, name=User} + {id=User, name=User, description=User Account} ] ) else : return ScimResourceTypesListResponse( resources = [ - {id=User, name=User} + {id=User, name=User, description=User Account} ], ) diff --git a/test/test_scim_schema_resource.py b/test/test_scim_schema_resource.py new file mode 100644 index 0000000..0f92899 --- /dev/null +++ b/test/test_scim_schema_resource.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.scim_schema_resource import ScimSchemaResource # noqa: E501 +from talon_one.rest import ApiException + +class TestScimSchemaResource(unittest.TestCase): + """ScimSchemaResource unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ScimSchemaResource + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.scim_schema_resource.ScimSchemaResource() # noqa: E501 + if include_optional : + return ScimSchemaResource( + id = '0', + name = '0', + description = '0', + attributes = [ + None + ] + ) + else : + return ScimSchemaResource( + ) + + def testScimSchemaResource(self): + """Test ScimSchemaResource""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scim_schemas_list_response.py b/test/test_scim_schemas_list_response.py new file mode 100644 index 0000000..077ab21 --- /dev/null +++ b/test/test_scim_schemas_list_response.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.scim_schemas_list_response import ScimSchemasListResponse # noqa: E501 +from talon_one.rest import ApiException + +class TestScimSchemasListResponse(unittest.TestCase): + """ScimSchemasListResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ScimSchemasListResponse + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.scim_schemas_list_response.ScimSchemasListResponse() # noqa: E501 + if include_optional : + return ScimSchemasListResponse( + resources = [ + {id=urn:ietf:params:scim:schemas:core:2.0:User, name=User, description=User Account, attributes=[{name=userName, required=true, mutability=readWrite}, {name=profileUrl, required=false, mutability=readWrite}]} + ], + schemas = [ + 'urn:ietf:params:scim:api:messages:2.0:ListResponse' + ], + total_results = 56 + ) + else : + return ScimSchemasListResponse( + resources = [ + {id=urn:ietf:params:scim:schemas:core:2.0:User, name=User, description=User Account, attributes=[{name=userName, required=true, mutability=readWrite}, {name=profileUrl, required=false, mutability=readWrite}]} + ], + ) + + def testScimSchemasListResponse(self): + """Test ScimSchemasListResponse""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scim_service_provider_config_response.py b/test/test_scim_service_provider_config_response.py new file mode 100644 index 0000000..65c738f --- /dev/null +++ b/test/test_scim_service_provider_config_response.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.scim_service_provider_config_response import ScimServiceProviderConfigResponse # noqa: E501 +from talon_one.rest import ApiException + +class TestScimServiceProviderConfigResponse(unittest.TestCase): + """ScimServiceProviderConfigResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ScimServiceProviderConfigResponse + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.scim_service_provider_config_response.ScimServiceProviderConfigResponse() # noqa: E501 + if include_optional : + return ScimServiceProviderConfigResponse( + bulk = talon_one.models.scim_service_provider_config_response_bulk.ScimServiceProviderConfigResponse_bulk( + max_operations = 56, + max_payload_size = 56, + supported = True, ), + change_password = talon_one.models.scim_service_provider_config_response_change_password.ScimServiceProviderConfigResponse_changePassword( + supported = True, ), + documentation_uri = '0', + filter = talon_one.models.scim_service_provider_config_response_filter.ScimServiceProviderConfigResponse_filter( + max_results = 56, + supported = True, ), + patch = talon_one.models.scim_service_provider_config_response_patch.ScimServiceProviderConfigResponse_patch( + supported = True, ), + schemas = [ + '0' + ], + sort = talon_one.models.scim_service_provider_config_response_sort.ScimServiceProviderConfigResponse_sort( + supported = True, ) + ) + else : + return ScimServiceProviderConfigResponse( + ) + + def testScimServiceProviderConfigResponse(self): + """Test ScimServiceProviderConfigResponse""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scim_service_provider_config_response_bulk.py b/test/test_scim_service_provider_config_response_bulk.py new file mode 100644 index 0000000..ededce2 --- /dev/null +++ b/test/test_scim_service_provider_config_response_bulk.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.scim_service_provider_config_response_bulk import ScimServiceProviderConfigResponseBulk # noqa: E501 +from talon_one.rest import ApiException + +class TestScimServiceProviderConfigResponseBulk(unittest.TestCase): + """ScimServiceProviderConfigResponseBulk unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ScimServiceProviderConfigResponseBulk + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.scim_service_provider_config_response_bulk.ScimServiceProviderConfigResponseBulk() # noqa: E501 + if include_optional : + return ScimServiceProviderConfigResponseBulk( + max_operations = 56, + max_payload_size = 56, + supported = True + ) + else : + return ScimServiceProviderConfigResponseBulk( + ) + + def testScimServiceProviderConfigResponseBulk(self): + """Test ScimServiceProviderConfigResponseBulk""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scim_service_provider_config_response_change_password.py b/test/test_scim_service_provider_config_response_change_password.py new file mode 100644 index 0000000..dd8c114 --- /dev/null +++ b/test/test_scim_service_provider_config_response_change_password.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.scim_service_provider_config_response_change_password import ScimServiceProviderConfigResponseChangePassword # noqa: E501 +from talon_one.rest import ApiException + +class TestScimServiceProviderConfigResponseChangePassword(unittest.TestCase): + """ScimServiceProviderConfigResponseChangePassword unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ScimServiceProviderConfigResponseChangePassword + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.scim_service_provider_config_response_change_password.ScimServiceProviderConfigResponseChangePassword() # noqa: E501 + if include_optional : + return ScimServiceProviderConfigResponseChangePassword( + supported = True + ) + else : + return ScimServiceProviderConfigResponseChangePassword( + ) + + def testScimServiceProviderConfigResponseChangePassword(self): + """Test ScimServiceProviderConfigResponseChangePassword""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scim_service_provider_config_response_filter.py b/test/test_scim_service_provider_config_response_filter.py new file mode 100644 index 0000000..eacaa86 --- /dev/null +++ b/test/test_scim_service_provider_config_response_filter.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.scim_service_provider_config_response_filter import ScimServiceProviderConfigResponseFilter # noqa: E501 +from talon_one.rest import ApiException + +class TestScimServiceProviderConfigResponseFilter(unittest.TestCase): + """ScimServiceProviderConfigResponseFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ScimServiceProviderConfigResponseFilter + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.scim_service_provider_config_response_filter.ScimServiceProviderConfigResponseFilter() # noqa: E501 + if include_optional : + return ScimServiceProviderConfigResponseFilter( + max_results = 56, + supported = True + ) + else : + return ScimServiceProviderConfigResponseFilter( + ) + + def testScimServiceProviderConfigResponseFilter(self): + """Test ScimServiceProviderConfigResponseFilter""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scim_service_provider_config_response_patch.py b/test/test_scim_service_provider_config_response_patch.py new file mode 100644 index 0000000..92ac410 --- /dev/null +++ b/test/test_scim_service_provider_config_response_patch.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.scim_service_provider_config_response_patch import ScimServiceProviderConfigResponsePatch # noqa: E501 +from talon_one.rest import ApiException + +class TestScimServiceProviderConfigResponsePatch(unittest.TestCase): + """ScimServiceProviderConfigResponsePatch unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ScimServiceProviderConfigResponsePatch + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.scim_service_provider_config_response_patch.ScimServiceProviderConfigResponsePatch() # noqa: E501 + if include_optional : + return ScimServiceProviderConfigResponsePatch( + supported = True + ) + else : + return ScimServiceProviderConfigResponsePatch( + ) + + def testScimServiceProviderConfigResponsePatch(self): + """Test ScimServiceProviderConfigResponsePatch""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scim_service_provider_config_response_sort.py b/test/test_scim_service_provider_config_response_sort.py new file mode 100644 index 0000000..9def724 --- /dev/null +++ b/test/test_scim_service_provider_config_response_sort.py @@ -0,0 +1,52 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.scim_service_provider_config_response_sort import ScimServiceProviderConfigResponseSort # noqa: E501 +from talon_one.rest import ApiException + +class TestScimServiceProviderConfigResponseSort(unittest.TestCase): + """ScimServiceProviderConfigResponseSort unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ScimServiceProviderConfigResponseSort + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.scim_service_provider_config_response_sort.ScimServiceProviderConfigResponseSort() # noqa: E501 + if include_optional : + return ScimServiceProviderConfigResponseSort( + supported = True + ) + else : + return ScimServiceProviderConfigResponseSort( + ) + + def testScimServiceProviderConfigResponseSort(self): + """Test ScimServiceProviderConfigResponseSort""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_scim_user.py b/test/test_scim_user.py index 2fd0de1..497102a 100644 --- a/test/test_scim_user.py +++ b/test/test_scim_user.py @@ -39,6 +39,8 @@ def make_instance(self, include_optional): active = True, display_name = 'John Doe', user_name = 'john.doe@example.com', + name = talon_one.models.scim_base_user_name.ScimBaseUser_name( + formatted = 'Mr. John J Doe', ), id = '359' ) else : diff --git a/test/test_scim_users_list_response.py b/test/test_scim_users_list_response.py index f412fac..760a407 100644 --- a/test/test_scim_users_list_response.py +++ b/test/test_scim_users_list_response.py @@ -41,6 +41,8 @@ def make_instance(self, include_optional): active = True, display_name = 'John Doe', user_name = 'john.doe@example.com', + name = talon_one.models.scim_base_user_name.ScimBaseUser_name( + formatted = 'Mr. John J Doe', ), id = '359', ) ], schemas = [ @@ -55,6 +57,8 @@ def make_instance(self, include_optional): active = True, display_name = 'John Doe', user_name = 'john.doe@example.com', + name = talon_one.models.scim_base_user_name.ScimBaseUser_name( + formatted = 'Mr. John J Doe', ), id = '359', ) ], ) diff --git a/test/test_store.py b/test/test_store.py index c79615e..3e35141 100644 --- a/test/test_store.py +++ b/test/test_store.py @@ -37,7 +37,7 @@ def make_instance(self, include_optional): if include_optional : return Store( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', name = 'South US store', description = 'This is the description of the store in south US.', attributes = {"country":"USA","code":1234}, @@ -49,7 +49,7 @@ def make_instance(self, include_optional): else : return Store( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', name = 'South US store', description = 'This is the description of the store in south US.', integration_id = 'STORE-001', diff --git a/test/test_strikethrough_debug_response.py b/test/test_strikethrough_debug_response.py new file mode 100644 index 0000000..cddb13b --- /dev/null +++ b/test/test_strikethrough_debug_response.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.strikethrough_debug_response import StrikethroughDebugResponse # noqa: E501 +from talon_one.rest import ApiException + +class TestStrikethroughDebugResponse(unittest.TestCase): + """StrikethroughDebugResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test StrikethroughDebugResponse + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.strikethrough_debug_response.StrikethroughDebugResponse() # noqa: E501 + if include_optional : + return StrikethroughDebugResponse( + campaigns_i_ds = [ + 56 + ], + effects = [ + talon_one.models.strikethrough_effect.StrikethroughEffect( + campaign_id = 3, + ruleset_id = 11, + rule_index = 2, + rule_name = 'Add 2 points', + type = 'setDiscountPerItem', + props = talon_one.models.strikethrough_effect_props.StrikethroughEffectProps(), ) + ] + ) + else : + return StrikethroughDebugResponse( + ) + + def testStrikethroughDebugResponse(self): + """Test StrikethroughDebugResponse""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_summary_campaign_store_budget.py b/test/test_summary_campaign_store_budget.py new file mode 100644 index 0000000..30dc1b0 --- /dev/null +++ b/test/test_summary_campaign_store_budget.py @@ -0,0 +1,56 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.summary_campaign_store_budget import SummaryCampaignStoreBudget # noqa: E501 +from talon_one.rest import ApiException + +class TestSummaryCampaignStoreBudget(unittest.TestCase): + """SummaryCampaignStoreBudget unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test SummaryCampaignStoreBudget + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.summary_campaign_store_budget.SummaryCampaignStoreBudget() # noqa: E501 + if include_optional : + return SummaryCampaignStoreBudget( + action = 'redeemCoupon', + period = 'overall', + store_count = 56 + ) + else : + return SummaryCampaignStoreBudget( + action = 'redeemCoupon', + store_count = 56, + ) + + def testSummaryCampaignStoreBudget(self): + """Test SummaryCampaignStoreBudget""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_template_arg_def.py b/test/test_template_arg_def.py index 80a02e3..0ff056d 100644 --- a/test/test_template_arg_def.py +++ b/test/test_template_arg_def.py @@ -40,6 +40,7 @@ def make_instance(self, include_optional): description = '0', title = '0', ui = talon_one.models.ui.ui(), + key = '0', picklist_id = 56, restricted_by_picklist = True ) diff --git a/test/test_template_def.py b/test/test_template_def.py index e21c02c..1bbad9c 100644 --- a/test/test_template_def.py +++ b/test/test_template_def.py @@ -52,6 +52,7 @@ def make_instance(self, include_optional): description = '0', title = '0', ui = talon_one.models.ui.ui(), + key = '0', picklist_id = 56, restricted_by_picklist = True, ) ], @@ -76,6 +77,7 @@ def make_instance(self, include_optional): description = '0', title = '0', ui = talon_one.models.ui.ui(), + key = '0', picklist_id = 56, restricted_by_picklist = True, ) ], diff --git a/test/test_track_event_v2_response.py b/test/test_track_event_v2_response.py index 06bcf6b..e705d51 100644 --- a/test/test_track_event_v2_response.py +++ b/test/test_track_event_v2_response.py @@ -38,7 +38,7 @@ def make_instance(self, include_optional): return TrackEventV2Response( customer_profile = talon_one.models.customer_profile.CustomerProfile( id = 6, - created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + created = '2020-02-07T08:15:22Z', integration_id = 'URNGV8294NV', attributes = {"Language":"english","ShippingCountry":"DE"}, account_id = 31, @@ -46,7 +46,7 @@ def make_instance(self, include_optional): total_sales = 299.99, loyalty_memberships = [ talon_one.models.loyalty_membership.LoyaltyMembership( - joined = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + joined = '2012-03-20T14:15:22Z', loyalty_program_id = 323414846, ) ], audience_memberships = [ @@ -99,6 +99,8 @@ def make_instance(self, include_optional): id = 6, created = '2020-06-10T09:05:27.993483Z', program_id = 125, + program_name = 'Loyalty_program', + program_title = 'Loyalty program', status = 'active', block_reason = 'Current card lost. Customer needs a new card.', identifier = 'summer-loyalty-card-0543', @@ -134,7 +136,8 @@ def make_instance(self, include_optional): }, modified = '2021-09-12T10:12:42Z', old_card_identifier = 'summer-loyalty-card-0543', - new_card_identifier = 'summer-loyalty-card-0543', ) + new_card_identifier = 'summer-loyalty-card-0543', + batch_id = 'wdefpov', ) ], programs = { 'key' : talon_one.models.loyalty_program_ledgers.LoyaltyProgramLedgers( @@ -219,7 +222,14 @@ def make_instance(self, include_optional): updated_by = 'Jane Doe', template_id = 3, frontend_state = 'running', - stores_imported = True, ) + stores_imported = True, + revision_frontend_state = 'revised', + active_revision_id = 6, + active_revision_version_id = 6, + version = 6, + current_revision_id = 6, + current_revision_version_id = 6, + stage_revision = False, ) ], rule_failure_reasons = [ talon_one.models.rule_failure_reason.RuleFailureReason( @@ -264,6 +274,8 @@ def make_instance(self, include_optional): condition_index = 786, evaluation_group_id = 3, evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, props = talon_one.models.effect_props.EffectProps(), ) ], created_coupons = [ @@ -328,6 +340,8 @@ def make_instance(self, include_optional): condition_index = 786, evaluation_group_id = 3, evaluation_group_mode = 'stackable', + campaign_revision_id = 1, + campaign_revision_version_id = 5, props = talon_one.models.effect_props.EffectProps(), ) ], created_coupons = [ diff --git a/test/test_update_achievement.py b/test/test_update_achievement.py index 23c91e5..b07ed87 100644 --- a/test/test_update_achievement.py +++ b/test/test_update_achievement.py @@ -41,7 +41,11 @@ def make_instance(self, include_optional): description = '50% off for every 50th purchase in a year.', target = 50.0, period = '1Y', - period_end_override = {month=11, dayOfMonth=23, hour=23, minute=59, second=59} + period_end_override = {month=11, dayOfMonth=23, hour=23, minute=59, second=59}, + recurrence_policy = 'no_recurrence', + activation_policy = 'fixed_schedule', + fixed_start_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), + end_date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') ) else : return UpdateAchievement( diff --git a/test/test_update_application.py b/test/test_update_application.py index c87775d..470d681 100644 --- a/test/test_update_application.py +++ b/test/test_update_application.py @@ -64,6 +64,7 @@ def make_instance(self, include_optional): enable_partial_discounts = False, default_discount_additional_cost_per_item_scope = 'price', default_evaluation_group_id = 3, + default_cart_item_filter_id = 3, enable_campaign_state_management = False ) else : diff --git a/test/test_update_application_cif.py b/test/test_update_application_cif.py new file mode 100644 index 0000000..b66396f --- /dev/null +++ b/test/test_update_application_cif.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.update_application_cif import UpdateApplicationCIF # noqa: E501 +from talon_one.rest import ApiException + +class TestUpdateApplicationCIF(unittest.TestCase): + """UpdateApplicationCIF unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test UpdateApplicationCIF + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.update_application_cif.UpdateApplicationCIF() # noqa: E501 + if include_optional : + return UpdateApplicationCIF( + description = 'This filter allows filtering by shoes', + active_expression_id = 1, + modified_by = 334, + modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f') + ) + else : + return UpdateApplicationCIF( + ) + + def testUpdateApplicationCIF(self): + """Test UpdateApplicationCIF""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_campaign_template.py b/test/test_update_campaign_template.py index 34f04d7..676f655 100644 --- a/test/test_update_campaign_template.py +++ b/test/test_update_campaign_template.py @@ -50,6 +50,9 @@ def make_instance(self, include_optional): coupon_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + coupon_reservation_settings = talon_one.models.campaign_template_coupon_reservation_settings.CampaignTemplateCouponReservationSettings( + reservation_limit = 45, + is_reservation_mandatory = False, ), referral_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), diff --git a/test/test_update_loyalty_program.py b/test/test_update_loyalty_program.py index 8bfe511..6c4ea6a 100644 --- a/test/test_update_loyalty_program.py +++ b/test/test_update_loyalty_program.py @@ -52,6 +52,7 @@ def make_instance(self, include_optional): card_code_settings = talon_one.models.code_generator_settings.CodeGeneratorSettings( valid_characters = [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], coupon_pattern = 'SUMMER-####-####', ), + return_policy = 'only_pending', tiers = [ talon_one.models.new_loyalty_tier.NewLoyaltyTier( name = 'Gold', diff --git a/test/test_update_loyalty_program_tier.py b/test/test_update_loyalty_program_tier.py new file mode 100644 index 0000000..17e6ba2 --- /dev/null +++ b/test/test_update_loyalty_program_tier.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.update_loyalty_program_tier import UpdateLoyaltyProgramTier # noqa: E501 +from talon_one.rest import ApiException + +class TestUpdateLoyaltyProgramTier(unittest.TestCase): + """UpdateLoyaltyProgramTier unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test UpdateLoyaltyProgramTier + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.update_loyalty_program_tier.UpdateLoyaltyProgramTier() # noqa: E501 + if include_optional : + return UpdateLoyaltyProgramTier( + id = 6, + name = 'Gold', + min_points = 300.0 + ) + else : + return UpdateLoyaltyProgramTier( + id = 6, + ) + + def testUpdateLoyaltyProgramTier(self): + """Test UpdateLoyaltyProgramTier""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_picklist.py b/test/test_update_picklist.py index 27f59e1..5dc9713 100644 --- a/test/test_update_picklist.py +++ b/test/test_update_picklist.py @@ -36,12 +36,12 @@ def make_instance(self, include_optional): # model = talon_one.models.update_picklist.UpdatePicklist() # noqa: E501 if include_optional : return UpdatePicklist( - type = '2012-11-01T22:08:41+00:00', + type = 'string', values = [Jeans, Shirt, Coat] ) else : return UpdatePicklist( - type = '2012-11-01T22:08:41+00:00', + type = 'string', values = [Jeans, Shirt, Coat], ) diff --git a/test/test_user.py b/test/test_user.py index ec01789..0941761 100644 --- a/test/test_user.py +++ b/test/test_user.py @@ -48,11 +48,11 @@ def make_instance(self, include_optional): policy = {"Role":127}, roles = [71], auth_method = 'basic_auth', - application_notification_subscriptions = None, + application_notification_subscriptions = {}, last_signed_in = '2021-09-12T10:12:42Z', last_accessed = '2021-09-12T10:14:42Z', latest_feed_timestamp = '2020-06-01T00:00Z', - additional_attributes = None + additional_attributes = {} ) else : return User( diff --git a/test/test_value_map.py b/test/test_value_map.py new file mode 100644 index 0000000..4a7e7ba --- /dev/null +++ b/test/test_value_map.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Talon.One API + + Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` # noqa: E501 + + The version of the OpenAPI document: + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import talon_one +from talon_one.models.value_map import ValueMap # noqa: E501 +from talon_one.rest import ApiException + +class TestValueMap(unittest.TestCase): + """ValueMap unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test ValueMap + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = talon_one.models.value_map.ValueMap() # noqa: E501 + if include_optional : + return ValueMap( + id = 6, + created = '2021-07-20T22:00Z', + created_by = 216, + campaign_id = 244 + ) + else : + return ValueMap( + id = 6, + campaign_id = 244, + ) + + def testValueMap(self): + """Test ValueMap""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main()