Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 57 additions & 18 deletions .openapi-generator/FILES

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.19.0
7.20.0
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The legacy version of this SDK is available [here](https://github.com/talon-one/

This SDK supports all of the operations of Talon.One's Integration API and Management API.

## Migrating from legacy SDKs
## Migrating from the legacy SDK

See our [migration guide](MIGRATION.md).

Expand Down Expand Up @@ -362,7 +362,7 @@ Class | Method | HTTP request | Description
*ManagementApi* | [**update_collection**](docs/ManagementApi.md#update_collection) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Update campaign-level collection's description
*ManagementApi* | [**update_coupon**](docs/ManagementApi.md#update_coupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update coupon
*ManagementApi* | [**update_coupon_batch**](docs/ManagementApi.md#update_coupon_batch) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update coupons
*ManagementApi* | [**update_loyalty_card**](docs/ManagementApi.md#update_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Update loyalty card status
*ManagementApi* | [**update_loyalty_card**](docs/ManagementApi.md#update_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Update loyalty card
*ManagementApi* | [**update_referral**](docs/ManagementApi.md#update_referral) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update referral
*ManagementApi* | [**update_role_v2**](docs/ManagementApi.md#update_role_v2) | **PUT** /v2/roles/{roleId} | Update role
*ManagementApi* | [**update_store**](docs/ManagementApi.md#update_store) | **PUT** /v1/applications/{applicationId}/stores/{storeId} | Update store
Expand Down Expand Up @@ -457,6 +457,7 @@ Class | Method | HTTP request | Description
- [BestPriorPriceRequest](docs/BestPriorPriceRequest.md)
- [BestPriorTarget](docs/BestPriorTarget.md)
- [Binding](docs/Binding.md)
- [Blueprint](docs/Blueprint.md)
- [BulkApplicationNotification](docs/BulkApplicationNotification.md)
- [BulkOperationOnCampaigns](docs/BulkOperationOnCampaigns.md)
- [Campaign](docs/Campaign.md)
Expand Down Expand Up @@ -528,7 +529,6 @@ Class | Method | HTTP request | Description
- [Collection](docs/Collection.md)
- [CollectionItem](docs/CollectionItem.md)
- [CollectionWithoutPayload](docs/CollectionWithoutPayload.md)
- [CollectionsCatalog](docs/CollectionsCatalog.md)
- [Coupon](docs/Coupon.md)
- [CouponConstraints](docs/CouponConstraints.md)
- [CouponCreatedEffectProps](docs/CouponCreatedEffectProps.md)
Expand All @@ -542,6 +542,7 @@ Class | Method | HTTP request | Description
- [CouponReservations](docs/CouponReservations.md)
- [CouponSearch](docs/CouponSearch.md)
- [CouponValue](docs/CouponValue.md)
- [CouponWithApplication](docs/CouponWithApplication.md)
- [CouponsNotificationData](docs/CouponsNotificationData.md)
- [CouponsNotificationPolicy](docs/CouponsNotificationPolicy.md)
- [CreateAchievement](docs/CreateAchievement.md)
Expand Down Expand Up @@ -586,6 +587,7 @@ Class | Method | HTTP request | Description
- [ErrorSource](docs/ErrorSource.md)
- [EvaluableCampaignIds](docs/EvaluableCampaignIds.md)
- [Event](docs/Event.md)
- [EventAttributesEntity](docs/EventAttributesEntity.md)
- [EventType](docs/EventType.md)
- [EventV2](docs/EventV2.md)
- [EventV3](docs/EventV3.md)
Expand Down Expand Up @@ -681,11 +683,13 @@ Class | Method | HTTP request | Description
- [IntegrationEntity](docs/IntegrationEntity.md)
- [IntegrationEvent](docs/IntegrationEvent.md)
- [IntegrationEventV2Request](docs/IntegrationEventV2Request.md)
- [IntegrationEventV2Response](docs/IntegrationEventV2Response.md)
- [IntegrationEventV3Request](docs/IntegrationEventV3Request.md)
- [IntegrationEventV3Response](docs/IntegrationEventV3Response.md)
- [IntegrationProfileEntity](docs/IntegrationProfileEntity.md)
- [IntegrationProfileEntityV3](docs/IntegrationProfileEntityV3.md)
- [IntegrationRequest](docs/IntegrationRequest.md)
- [IntegrationResponse](docs/IntegrationResponse.md)
- [IntegrationState](docs/IntegrationState.md)
- [IntegrationStateV2](docs/IntegrationStateV2.md)
- [IntegrationStoreEntity](docs/IntegrationStoreEntity.md)
Expand Down Expand Up @@ -767,6 +771,7 @@ Class | Method | HTTP request | Description
- [NewAttribute](docs/NewAttribute.md)
- [NewAudience](docs/NewAudience.md)
- [NewBaseNotification](docs/NewBaseNotification.md)
- [NewBlueprint](docs/NewBlueprint.md)
- [NewCampaign](docs/NewCampaign.md)
- [NewCampaignCollection](docs/NewCampaignCollection.md)
- [NewCampaignEvaluationGroup](docs/NewCampaignEvaluationGroup.md)
Expand All @@ -777,7 +782,6 @@ Class | Method | HTTP request | Description
- [NewCampaignTemplate](docs/NewCampaignTemplate.md)
- [NewCatalog](docs/NewCatalog.md)
- [NewCollection](docs/NewCollection.md)
- [NewCollectionsCatalog](docs/NewCollectionsCatalog.md)
- [NewCouponCreationJob](docs/NewCouponCreationJob.md)
- [NewCouponDeletionJob](docs/NewCouponDeletionJob.md)
- [NewCoupons](docs/NewCoupons.md)
Expand Down Expand Up @@ -845,17 +849,24 @@ Class | Method | HTTP request | Description
- [PendingActivePointsNotification](docs/PendingActivePointsNotification.md)
- [PendingPointsNotificationPolicy](docs/PendingPointsNotificationPolicy.md)
- [Picklist](docs/Picklist.md)
- [PlaceholderDetails](docs/PlaceholderDetails.md)
- [PriceDetail](docs/PriceDetail.md)
- [PriceType](docs/PriceType.md)
- [PriceTypeReferenceDetail](docs/PriceTypeReferenceDetail.md)
- [PriceTypeReferences](docs/PriceTypeReferences.md)
- [PrismaticConfig](docs/PrismaticConfig.md)
- [PrismaticEventPayloadCouponBasedNotifications](docs/PrismaticEventPayloadCouponBasedNotifications.md)
- [PrismaticEventPayloadCouponBasedNotificationsLimits](docs/PrismaticEventPayloadCouponBasedNotificationsLimits.md)
- [PrismaticEventPayloadLoyaltyProfileBasedNotifications](docs/PrismaticEventPayloadLoyaltyProfileBasedNotifications.md)
- [PrismaticEventPayloadLoyaltyProfileBasedNotificationsAction](docs/PrismaticEventPayloadLoyaltyProfileBasedNotificationsAction.md)
- [PrismaticEventPayloadLoyaltyProfileBasedNotification](docs/PrismaticEventPayloadLoyaltyProfileBasedNotification.md)
- [PrismaticEventPayloadLoyaltyProfileBasedPointsChangedNotification](docs/PrismaticEventPayloadLoyaltyProfileBasedPointsChangedNotification.md)
- [PrismaticEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction](docs/PrismaticEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.md)
- [PrismaticEventPayloadLoyaltyProfileBasedTierDowngradeNotification](docs/PrismaticEventPayloadLoyaltyProfileBasedTierDowngradeNotification.md)
- [PrismaticEventPayloadLoyaltyProfileBasedTierUpgradeNotification](docs/PrismaticEventPayloadLoyaltyProfileBasedTierUpgradeNotification.md)
- [PrismaticEventRecord](docs/PrismaticEventRecord.md)
- [PrismaticFlow](docs/PrismaticFlow.md)
- [PrismaticFlowConfig](docs/PrismaticFlowConfig.md)
- [PrismaticFlowConfigResponse](docs/PrismaticFlowConfigResponse.md)
- [PrismaticFlowResponse](docs/PrismaticFlowResponse.md)
- [PrismaticFlowWithConfig](docs/PrismaticFlowWithConfig.md)
- [PrismaticPaginatedEventPayload](docs/PrismaticPaginatedEventPayload.md)
- [Product](docs/Product.md)
Expand All @@ -877,6 +888,7 @@ Class | Method | HTTP request | Description
- [RemoveManyItemsCatalogAction](docs/RemoveManyItemsCatalogAction.md)
- [ReopenSessionResponse](docs/ReopenSessionResponse.md)
- [ReserveCouponEffectProps](docs/ReserveCouponEffectProps.md)
- [ResponseContentObject](docs/ResponseContentObject.md)
- [ReturnIntegrationRequest](docs/ReturnIntegrationRequest.md)
- [ReturnedCartItem](docs/ReturnedCartItem.md)
- [Revision](docs/Revision.md)
Expand Down Expand Up @@ -968,7 +980,6 @@ Class | Method | HTTP request | Description
- [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)
Expand All @@ -979,14 +990,14 @@ Class | Method | HTTP request | Description
- [UpdateApplicationCIF](docs/UpdateApplicationCIF.md)
- [UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md)
- [UpdateAudience](docs/UpdateAudience.md)
- [UpdateBlueprint](docs/UpdateBlueprint.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)
- [UpdateCollectionsCatalog](docs/UpdateCollectionsCatalog.md)
- [UpdateCoupon](docs/UpdateCoupon.md)
- [UpdateCouponBatch](docs/UpdateCouponBatch.md)
- [UpdateCouponsData](docs/UpdateCouponsData.md)
Expand All @@ -996,7 +1007,9 @@ Class | Method | HTTP request | Description
- [UpdateExperiment](docs/UpdateExperiment.md)
- [UpdateExperimentVariant](docs/UpdateExperimentVariant.md)
- [UpdateExperimentVariantArray](docs/UpdateExperimentVariantArray.md)
- [UpdateExperimentVariantName](docs/UpdateExperimentVariantName.md)
- [UpdateLoyaltyCard](docs/UpdateLoyaltyCard.md)
- [UpdateLoyaltyCardRequest](docs/UpdateLoyaltyCardRequest.md)
- [UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md)
- [UpdateLoyaltyProgramTier](docs/UpdateLoyaltyProgramTier.md)
- [UpdatePicklist](docs/UpdatePicklist.md)
Expand Down
41 changes: 41 additions & 0 deletions docs/Blueprint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Blueprint


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | The internal ID of this blueprint. |
**account_id** | **int** | The ID of the account that owns this blueprint. |
**application_id** | **int** | The ID of the Application that owns this blueprint. |
**title** | **str** | A short description of the blueprint. |
**description** | **str** | A longer, more detailed description of the blueprint. | [optional]
**category** | **str** | Category used to group blueprints. |
**source** | **str** | Indicates whether the blueprint is custom or shipped by Talon.One. |
**rules** | [**List[CatalogRule]**](CatalogRule.md) | Array of rule templates in this blueprint. Rules only contain title (no description, as description is at the blueprint level). |
**cart_item_filters** | [**List[CartItemFilterTemplate]**](CartItemFilterTemplate.md) | Array of cart item filter templates in this blueprint. Cart item filters only contain name (no description, as description is at the blueprint level). |
**created** | **datetime** | Timestamp when the blueprint was created. |
**created_by** | **int** | ID of the user who created the blueprint. |
**modified** | **datetime** | Timestamp when the blueprint was last updated. | [optional]
**modified_by** | **int** | ID of the user who last updated the blueprint. | [optional]

## Example

```python
from talon_one.models.blueprint import Blueprint

# TODO update the JSON string below
json = "{}"
# create an instance of Blueprint from a JSON string
blueprint_instance = Blueprint.from_json(json)
# print the JSON string representation of the object
print(Blueprint.to_json())

# convert the object into a dict
blueprint_dict = blueprint_instance.to_dict()
# create an instance of Blueprint from a dict
blueprint_from_dict = Blueprint.from_dict(blueprint_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


7 changes: 4 additions & 3 deletions docs/CampaignCollectionEditedNotificationItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event** | **str** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
**campaign** | **object** | The current campaign. |
**ruleset** | **object** | The current ruleset. | [optional]
**collection** | **object** | The collection that was edited. |
**campaign** | [**Campaign**](Campaign.md) | The current campaign. |
**ruleset** | [**Ruleset**](Ruleset.md) | The current ruleset. | [optional]
**placeholders** | [**List[PlaceholderDetails]**](PlaceholderDetails.md) | The current details of the [placeholders](https://docs.talon.one/docs/product/campaigns/templates/create-templates#use-placeholders) in the campaign. | [optional]
**collection** | [**CollectionWithoutPayload**](CollectionWithoutPayload.md) | The collection that was edited. |

## Example

Expand Down
7 changes: 4 additions & 3 deletions docs/CampaignCreatedNotificationItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event** | **str** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
**campaign** | **object** | The campaign whose state changed. |
**ruleset** | **object** | The current ruleset. | [optional]
**evaluation_position** | **object** | The campaign position within the evaluation tree. |
**campaign** | [**Campaign**](Campaign.md) | The campaign whose state changed. |
**ruleset** | [**Ruleset**](Ruleset.md) | The current ruleset. | [optional]
**placeholders** | [**List[PlaceholderDetails]**](PlaceholderDetails.md) | The current details of the [placeholders](https://docs.talon.one/docs/product/campaigns/templates/create-templates#use-placeholders) in the campaign. | [optional]
**evaluation_position** | [**CampaignEvaluationPosition**](CampaignEvaluationPosition.md) | The campaign position within the evaluation tree. |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/CampaignDeletedNotificationItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event** | **str** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
**campaign** | **object** | The campaign whose state changed. |
**campaign** | [**Campaign**](Campaign.md) | The campaign whose state changed. |
**deleted_at** | **datetime** | Time when the campaign was deleted. |

## Example
Expand Down
7 changes: 4 additions & 3 deletions docs/CampaignEditedNotificationItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event** | **str** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
**campaign** | **object** | The campaign whose state changed. |
**old_campaign** | **object** | The campaign before the change. |
**ruleset** | **object** | The current ruleset. | [optional]
**campaign** | [**Campaign**](Campaign.md) | The campaign whose state changed. |
**old_campaign** | [**Campaign**](Campaign.md) | The campaign before the change. |
**ruleset** | [**Ruleset**](Ruleset.md) | The current ruleset. | [optional]
**placeholders** | [**List[PlaceholderDetails]**](PlaceholderDetails.md) | The current details of the [placeholders](https://docs.talon.one/docs/product/campaigns/templates/create-templates#use-placeholders) in the campaign. | [optional]

## Example

Expand Down
4 changes: 3 additions & 1 deletion docs/CampaignRulesetChangedNotificationItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event** | **str** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
**campaign** | **object** | The campaign whose state changed. |
**campaign** | [**Campaign**](Campaign.md) | The campaign whose state changed. |
**old_ruleset** | [**Ruleset**](Ruleset.md) | The old ruleset, if the ruleset was changed. | [optional]
**old_placeholders** | [**List[PlaceholderDetails]**](PlaceholderDetails.md) | The previous details of the placeholders before the ruleset was changed. | [optional]
**ruleset** | [**Ruleset**](Ruleset.md) | The current ruleset. | [optional]
**placeholders** | [**List[PlaceholderDetails]**](PlaceholderDetails.md) | The current details of the [placeholders](https://docs.talon.one/docs/product/campaigns/templates/create-templates#use-placeholders) in the campaign. | [optional]

## Example

Expand Down
5 changes: 3 additions & 2 deletions docs/CampaignStateChangedNotificationItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event** | **str** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted'] |
**campaign** | **object** | The campaign whose state changed. |
**campaign** | [**Campaign**](Campaign.md) | The campaign whose state changed. |
**old_state** | **str** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] |
**new_state** | **str** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] |
**ruleset** | **object** | The current ruleset. | [optional]
**ruleset** | [**Ruleset**](Ruleset.md) | The current ruleset. | [optional]
**placeholders** | [**List[PlaceholderDetails]**](PlaceholderDetails.md) | The current details of the [placeholders](https://docs.talon.one/docs/product/campaigns/templates/create-templates#use-placeholders) in the campaign. | [optional]

## Example

Expand Down
41 changes: 0 additions & 41 deletions docs/CollectionsCatalog.md

This file was deleted.

Loading