diff --git a/README.md b/README.md index 9a908ebd..6a129e05 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ The API is available at the same hostname as these docs. For example, if you are This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. - API version: 1.0.0 -- Package version: 2.1.1 +- Package version: 2.2.0 - Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen ## Installation @@ -343,9 +343,11 @@ Class | Method | HTTP request | Description *IntegrationApi* | [**GetCustomerInventory**](docs/IntegrationApi.md#getcustomerinventory) | **Get** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile. *IntegrationApi* | [**GetReservedCustomers**](docs/IntegrationApi.md#getreservedcustomers) | **Get** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved *IntegrationApi* | [**TrackEvent**](docs/IntegrationApi.md#trackevent) | **Post** /v1/events | Track an Event -*IntegrationApi* | [**UpdateCustomerProfile**](docs/IntegrationApi.md#updatecustomerprofile) | **Put** /v1/customer_profiles/{integrationId} | Update a Customer Profile -*IntegrationApi* | [**UpdateCustomerProfileV2**](docs/IntegrationApi.md#updatecustomerprofilev2) | **Put** /v2/customer_profiles/{customerProfileId} | Update a Customer Profile -*IntegrationApi* | [**UpdateCustomerSession**](docs/IntegrationApi.md#updatecustomersession) | **Put** /v1/customer_sessions/{customerSessionId} | Update a Customer Session +*IntegrationApi* | [**UpdateCustomerProfile**](docs/IntegrationApi.md#updatecustomerprofile) | **Put** /v1/customer_profiles/{integrationId} | Update a Customer Profile V1 +*IntegrationApi* | [**UpdateCustomerProfileAudiences**](docs/IntegrationApi.md#updatecustomerprofileaudiences) | **Post** /v2/customer_audiences | Update a Customer Profile Audiences +*IntegrationApi* | [**UpdateCustomerProfileV2**](docs/IntegrationApi.md#updatecustomerprofilev2) | **Put** /v2/customer_profiles/{integrationId} | Update a Customer Profile +*IntegrationApi* | [**UpdateCustomerProfilesV2**](docs/IntegrationApi.md#updatecustomerprofilesv2) | **Put** /v2/customer_profiles | Update multiple Customer Profiles +*IntegrationApi* | [**UpdateCustomerSession**](docs/IntegrationApi.md#updatecustomersession) | **Put** /v1/customer_sessions/{customerSessionId} | Update a Customer Session V1 *IntegrationApi* | [**UpdateCustomerSessionV2**](docs/IntegrationApi.md#updatecustomersessionv2) | **Put** /v2/customer_sessions/{customerSessionId} | Update a Customer Session *ManagementApi* | [**AddLoyaltyPoints**](docs/ManagementApi.md#addloyaltypoints) | **Put** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in a certain loyalty program for the specified customer *ManagementApi* | [**CopyCampaignToApplications**](docs/ManagementApi.md#copycampaigntoapplications) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application @@ -404,6 +406,7 @@ Class | Method | HTTP request | Description *ManagementApi* | [**GetLoyaltyPoints**](docs/ManagementApi.md#getloyaltypoints) | **Get** /v1/loyalty_programs/{programID}/profile/{integrationID} | get the Loyalty Ledger for this integrationID *ManagementApi* | [**GetLoyaltyProgram**](docs/ManagementApi.md#getloyaltyprogram) | **Get** /v1/loyalty_programs/{programID} | Get a loyalty program *ManagementApi* | [**GetLoyaltyPrograms**](docs/ManagementApi.md#getloyaltyprograms) | **Get** /v1/loyalty_programs | List all loyalty Programs +*ManagementApi* | [**GetLoyaltyStatistics**](docs/ManagementApi.md#getloyaltystatistics) | **Get** /v1/loyalty_programs/{programID}/statistics | Get loyalty program statistics by loyalty program ID *ManagementApi* | [**GetReferrals**](docs/ManagementApi.md#getreferrals) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals (with total count) *ManagementApi* | [**GetReferralsWithoutTotalCount**](docs/ManagementApi.md#getreferralswithouttotalcount) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List Referrals *ManagementApi* | [**GetRole**](docs/ManagementApi.md#getrole) | **Get** /v1/roles/{roleId} | Get information for the specified role. @@ -456,12 +459,16 @@ Class | Method | HTTP request | Description - [Attribute](docs/Attribute.md) - [AttributesMandatory](docs/AttributesMandatory.md) - [AttributesSettings](docs/AttributesSettings.md) + - [Audience](docs/Audience.md) + - [AudienceMembership](docs/AudienceMembership.md) - [BaseSamlConnection](docs/BaseSamlConnection.md) - [Binding](docs/Binding.md) - [Campaign](docs/Campaign.md) - [CampaignAnalytics](docs/CampaignAnalytics.md) - [CampaignCopy](docs/CampaignCopy.md) - [CampaignEntity](docs/CampaignEntity.md) + - [CampaignGroup](docs/CampaignGroup.md) + - [CampaignGroupEntity](docs/CampaignGroupEntity.md) - [CampaignSearch](docs/CampaignSearch.md) - [CampaignSet](docs/CampaignSet.md) - [CampaignSetBranchNode](docs/CampaignSetBranchNode.md) @@ -484,8 +491,10 @@ Class | Method | HTTP request | Description - [CustomerAnalytics](docs/CustomerAnalytics.md) - [CustomerInventory](docs/CustomerInventory.md) - [CustomerProfile](docs/CustomerProfile.md) + - [CustomerProfileAudienceRequest](docs/CustomerProfileAudienceRequest.md) + - [CustomerProfileAudienceRequestItem](docs/CustomerProfileAudienceRequestItem.md) + - [CustomerProfileIntegrationRequestV2](docs/CustomerProfileIntegrationRequestV2.md) - [CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md) - - [CustomerProfileUpdate](docs/CustomerProfileUpdate.md) - [CustomerSession](docs/CustomerSession.md) - [CustomerSessionV2](docs/CustomerSessionV2.md) - [DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md) @@ -493,6 +502,7 @@ Class | Method | HTTP request | Description - [EffectEntity](docs/EffectEntity.md) - [EmailEntity](docs/EmailEntity.md) - [Entity](docs/Entity.md) + - [EntityWithTalangVisibleId](docs/EntityWithTalangVisibleId.md) - [Environment](docs/Environment.md) - [ErrorEffectProps](docs/ErrorEffectProps.md) - [ErrorResponse](docs/ErrorResponse.md) @@ -503,6 +513,7 @@ Class | Method | HTTP request | Description - [FeatureFlag](docs/FeatureFlag.md) - [FeatureFlags](docs/FeatureFlags.md) - [FeaturesFeed](docs/FeaturesFeed.md) + - [FeedNotification](docs/FeedNotification.md) - [FuncArgDef](docs/FuncArgDef.md) - [FunctionDef](docs/FunctionDef.md) - [Import](docs/Import.md) @@ -556,11 +567,14 @@ Class | Method | HTTP request | Description - [LoyaltyProgram](docs/LoyaltyProgram.md) - [LoyaltyProgramBalance](docs/LoyaltyProgramBalance.md) - [LoyaltyProgramLedgers](docs/LoyaltyProgramLedgers.md) + - [LoyaltyStatistics](docs/LoyaltyStatistics.md) - [LoyaltySubLedger](docs/LoyaltySubLedger.md) - [ManagerConfig](docs/ManagerConfig.md) - [Meta](docs/Meta.md) - - [MiscUpdateUserLatestFeature](docs/MiscUpdateUserLatestFeature.md) - [MultiApplicationEntity](docs/MultiApplicationEntity.md) + - [MultipleCustomerProfileIntegrationRequest](docs/MultipleCustomerProfileIntegrationRequest.md) + - [MultipleCustomerProfileIntegrationRequestItem](docs/MultipleCustomerProfileIntegrationRequestItem.md) + - [MultipleCustomerProfileIntegrationResponseV2](docs/MultipleCustomerProfileIntegrationResponseV2.md) - [MutableEntity](docs/MutableEntity.md) - [NewAccount](docs/NewAccount.md) - [NewAccountSignUp](docs/NewAccountSignUp.md) @@ -568,7 +582,9 @@ Class | Method | HTTP request | Description - [NewApplication](docs/NewApplication.md) - [NewApplicationApiKey](docs/NewApplicationApiKey.md) - [NewAttribute](docs/NewAttribute.md) + - [NewAudience](docs/NewAudience.md) - [NewCampaign](docs/NewCampaign.md) + - [NewCampaignGroup](docs/NewCampaignGroup.md) - [NewCampaignSet](docs/NewCampaignSet.md) - [NewCoupons](docs/NewCoupons.md) - [NewCustomerProfile](docs/NewCustomerProfile.md) @@ -619,14 +635,18 @@ Class | Method | HTTP request | Description - [UpdateAccount](docs/UpdateAccount.md) - [UpdateApplication](docs/UpdateApplication.md) - [UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md) + - [UpdateAudience](docs/UpdateAudience.md) - [UpdateCampaign](docs/UpdateCampaign.md) + - [UpdateCampaignGroup](docs/UpdateCampaignGroup.md) - [UpdateCoupon](docs/UpdateCoupon.md) - [UpdateCouponBatch](docs/UpdateCouponBatch.md) - [UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md) - [UpdateRole](docs/UpdateRole.md) - [UpdateUser](docs/UpdateUser.md) + - [UpdateUserLatestFeedTimestamp](docs/UpdateUserLatestFeedTimestamp.md) - [User](docs/User.md) - [UserEntity](docs/UserEntity.md) + - [UserFeedNotifications](docs/UserFeedNotifications.md) - [Webhook](docs/Webhook.md) - [WebhookActivationLogEntry](docs/WebhookActivationLogEntry.md) - [WebhookLogEntry](docs/WebhookLogEntry.md) diff --git a/api/openapi.yaml b/api/openapi.yaml index 5c42f872..b7105f04 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -53,9 +53,164 @@ tags: Operations for updating account information such as billing email addresses, inviting users, etc. name: Accounts & Users paths: + /v2/customer_sessions/{customerSessionId}: + put: + description: | + Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. + + The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. + + The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`""`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. + + Updating a customer profile will return a response with the requested integration state. This includes the effects that were generated due to triggered campaigns, the created coupons and referral objects, as well as any entity that was requested in the request parameter "responseContent". + + The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. + + [Customer Session]: /Getting-Started/entities#customer-session + operationId: updateCustomerSessionV2 + parameters: + - description: Flag to indicate whether to skip persisting the changes or not + (Will not persist if set to 'true'). + in: query + name: dry + schema: + type: boolean + - description: The custom identifier for this session, must be unique within + the account. + in: path + name: customerSessionId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IntegrationRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/IntegrationStateV2' + description: OK + security: + - api_key_v1: [] + summary: Update a Customer Session + tags: + - integration + x-codegen-request-body-name: body + /v2/customer_profiles: + put: + description: | + Update (or create) up to 1000 [Customer Profiles][] in 1 request. + + The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. + + [Customer Profiles]: /Getting-Started/entities#customer-profile + operationId: updateCustomerProfilesV2 + parameters: + - description: If set to 'yes', response will be an empty 204, otherwise a list + of the IntegrationStateV2 generated. + in: query + name: silent + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MultipleCustomerProfileIntegrationRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/MultipleCustomerProfileIntegrationResponseV2' + description: OK + security: + - api_key_v1: [] + summary: Update multiple Customer Profiles + tags: + - integration + x-codegen-request-body-name: body + /v2/customer_profiles/{integrationId}: + put: + description: | + Update (or create) a [Customer Profile][]. + + The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. + + [Customer Profile]: /Getting-Started/entities#customer-profile + operationId: updateCustomerProfileV2 + parameters: + - description: The custom identifier for this profile, must be unique within + the account. + in: path + name: integrationId + required: true + schema: + type: string + - description: Flag to indicate whether to run the rule engine (Defaults to + false). + in: query + name: runRuleEngine + schema: + type: boolean + - description: Flag to indicate whether to skip persisting the changes or not + (Will not persist if set to 'true'. Only used when 'runRuleEngine' is set + to 'true'). + in: query + name: dry + schema: + type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerProfileIntegrationRequestV2' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/IntegrationStateV2' + description: OK + security: + - api_key_v1: [] + summary: Update a Customer Profile + tags: + - integration + x-codegen-request-body-name: body + /v2/customer_audiences: + post: + description: | + Update one ore multiple Customer Profiles with the specified Audiences + operationId: updateCustomerProfileAudiences + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerProfileAudienceRequest' + required: true + responses: + "204": + content: {} + description: No Content + security: + - api_key_v1: [] + summary: Update a Customer Profile Audiences + tags: + - integration + x-codegen-request-body-name: body /v1/customer_profiles/{integrationId}: put: description: | + ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2). + Update (or create) a [Customer Profile][]. This profile information can then be matched and/or updated by campaign [Rules][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. @@ -95,13 +250,15 @@ paths: security: - api_key_v1: [] - integration_auth: [] - summary: Update a Customer Profile + summary: Update a Customer Profile V1 tags: - integration x-codegen-request-body-name: body /v1/customer_sessions/{customerSessionId}: put: description: | + ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2). + Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. @@ -144,7 +301,7 @@ paths: security: - api_key_v1: [] - integration_auth: [] - summary: Update a Customer Session + summary: Update a Customer Session V1 tags: - integration x-codegen-request-body-name: body @@ -352,104 +509,25 @@ paths: name: coupons schema: type: boolean - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CustomerInventory' - description: OK - security: - - api_key_v1: [] - - integration_auth: [] - summary: Get an inventory of all data associated with a specific customer profile. - tags: - - integration - /v2/customer_sessions/{customerSessionId}: - put: - description: | - Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. - - The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. - - The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`""`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. - - Updating a customer profile will return a response with the requested integration state. This includes the effects that were generated due to triggered campaigns, the created coupons and referral objects, as well as any entity that was requested in the request parameter "responseContent". - - The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. - - [Customer Session]: /Getting-Started/entities#customer-session - operationId: updateCustomerSessionV2 - parameters: - - description: Flag to indicate whether to skip persisting the changes or not - (Will not persist if set to 'true'). + - description: optional flag to decide if you would like loyalty information + in the response in: query - name: dry + name: loyalty schema: type: boolean - - description: The custom identifier for this session, must be unique within - the account. - in: path - name: customerSessionId - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/IntegrationRequest' - required: true - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/IntegrationStateV2' - description: OK - security: - - api_key_v1: [] - summary: Update a Customer Session - tags: - - integration - x-codegen-request-body-name: body - /v2/customer_profiles/{customerProfileId}: - put: - description: "Update (or create) a [Customer Profile][]. \n\nThe `integrationId`\ - \ may be any identifier that will remain stable for the customer. For example,\ - \ you might use a database ID, an email, or a phone number as the `integrationId`.\ - \ It is vital that this ID **not** change over time, so **don't** use any\ - \ identifier that the customer can update themselves. E.g. if your application\ - \ allows a customer to update their e-mail address, you should instead use\ - \ a database ID.\n\n[Customer Profile]: /Getting-Started/entities#customer-profile\n" - operationId: updateCustomerProfileV2 - parameters: - - description: The custom identifier for this profile, must be unique within - the account. - in: path - name: customerProfileId - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/NewCustomerProfile' - required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/CustomerProfileUpdate' + $ref: '#/components/schemas/CustomerInventory' description: OK security: - api_key_v1: [] - summary: Update a Customer Profile + - integration_auth: [] + summary: Get an inventory of all data associated with a specific customer profile. tags: - integration - x-codegen-request-body-name: body /v1/applications: get: description: List all application in the current account. @@ -571,6 +649,12 @@ paths: schema: format: date-time type: string + - description: Filter results to campaigns owned by the specified campaign group + ID. + in: query + name: campaignGroupId + schema: + type: integer responses: "200": content: @@ -2477,6 +2561,25 @@ paths: tags: - management x-codegen-request-body-name: body + /v1/loyalty_programs/{programID}/statistics: + get: + operationId: getLoyaltyStatistics + parameters: + - in: path + name: programID + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/LoyaltyStatistics' + description: OK + summary: Get loyalty program statistics by loyalty program ID + tags: + - management /v1/applications/{applicationId}/health_report: get: operationId: getApplicationApiHealth @@ -2793,30 +2896,56 @@ paths: required: true schema: type: integer - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/inline_response_200_12' - description: OK - summary: List Application Customers - tags: - - management - /v1/customer_search/no_total: - post: - description: | - Gets a list of all the customer profiles for the account that exactly match a set of attributes. - - The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. - - [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile - operationId: getCustomersByAttributes - parameters: - - description: The number of items to include in this response. When omitted, - the maximum value of 1000 will be used. + - description: Filter results performing an exact matching against the profile + integration identifier. in: query - name: pageSize + name: integrationId + schema: + type: string + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. + in: query + name: pageSize + schema: + type: integer + - description: Skips the given number of items when paging through large result + sets. + in: query + name: skip + schema: + type: integer + - description: | + When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. + With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. + With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query. + in: query + name: withTotalResultSize + schema: + type: boolean + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_12' + description: OK + summary: List Application Customers + tags: + - management + /v1/customer_search/no_total: + post: + description: | + Gets a list of all the customer profiles for the account that exactly match a set of attributes. + + The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request. + + [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile + operationId: getCustomersByAttributes + parameters: + - description: The number of items to include in this response. When omitted, + the maximum value of 1000 will be used. + in: query + name: pageSize schema: type: integer - description: Skips the given number of items when paging through large result @@ -2846,11 +2975,6 @@ paths: get: operationId: getCustomerProfile parameters: - - in: path - name: applicationId - required: true - schema: - type: integer - in: path name: customerId required: true @@ -3234,6 +3358,18 @@ paths: - closed - cancelled type: string + - description: Only return events created before this date + in: query + name: createdBefore + schema: + format: date-time + type: string + - description: Only return events created after this date + in: query + name: createdAfter + schema: + format: date-time + type: string - description: Filter by sessions with this coupon. Must be exact match. in: query name: coupon @@ -3249,11 +3385,6 @@ paths: name: integrationId schema: type: string - - description: Filter by integration ID of the customer for the session - in: query - name: customerId - schema: - type: string - in: path name: applicationId required: true @@ -4339,11 +4470,6 @@ paths: - management components: schemas: - MiscUpdateUserLatestFeature: - properties: - latestFeature: - type: string - type: object ErrorResponse: properties: message: @@ -4454,6 +4580,19 @@ components: - created - id type: object + EntityWithTalangVisibleID: + properties: + id: + description: Unique ID for this entity. + type: integer + created: + description: The exact moment this entity was created. + format: date-time + type: string + required: + - created + - id + type: object MutableEntity: properties: modified: @@ -4496,6 +4635,14 @@ components: required: - applicationId type: object + CampaignGroupEntity: + properties: + campaignGroups: + description: The IDs of the campaign groups that own this entity. + items: + type: integer + type: array + type: object MultiApplicationEntity: properties: applicationIds: @@ -4534,7 +4681,8 @@ components: IntegrationEntity: properties: integrationId: - description: The ID used for this entity in the application system. + description: The integration ID for this entity sent to and used in the + Talon.One system. format: string type: string created: @@ -4716,14 +4864,34 @@ components: type: array campaignPriority: description: Default priority for campaigns created in this application, - can be one of (universal, stackable, exclusive) + can be one of (universal, stackable, exclusive). If no value is provided, + this is set to "universal" enum: - universal - stackable - exclusive type: string + exclusiveCampaignsStrategy: + description: The strategy used when choosing exclusive campaigns for evaluation, + can be one of (listOrder, lowestDiscount, highestDiscount). If no value + is provided, this is set to "listOrder" + enum: + - listOrder + - lowestDiscount + - highestDiscount + type: string + enableCascadingDiscounts: + description: Flag indicating if discounts should cascade for this application + type: boolean + enableFlattenedCartItems: + description: Flag indicating if cart items of quantity larger than one should + be separated into different items of quantity one + type: boolean attributesSettings: $ref: '#/components/schemas/AttributesSettings' + sandbox: + description: Flag indicating if this is a live or sandbox application + type: boolean required: - currency - name @@ -4766,14 +4934,34 @@ components: type: array campaignPriority: description: Default priority for campaigns created in this application, - can be one of (universal, stackable, exclusive) + can be one of (universal, stackable, exclusive). If no value is provided, + this is set to "universal" enum: - universal - stackable - exclusive type: string + exclusiveCampaignsStrategy: + description: The strategy used when choosing exclusive campaigns for evaluation, + can be one of (listOrder, lowestDiscount, highestDiscount). If no value + is provided, this is set to "listOrder" + enum: + - listOrder + - lowestDiscount + - highestDiscount + type: string + enableCascadingDiscounts: + description: Flag indicating if discounts should cascade for this application + type: boolean + enableFlattenedCartItems: + description: Flag indicating if cart items of quantity larger than one should + be separated into different items of quantity one + type: boolean attributesSettings: $ref: '#/components/schemas/AttributesSettings' + sandbox: + description: Flag indicating if this is a live or sandbox application + type: boolean key: description: Hex key for HMAC-signing API calls as coming from this application (16 hex digits) @@ -4787,8 +4975,10 @@ components: Application: description: "" example: + enableFlattenedCartItems: true created: 2000-01-23T04:56:07.000+00:00 timezone: timezone + sandbox: true description: description attributesSettings: mandatory: @@ -4800,10 +4990,12 @@ components: - coupons caseSensitivity: sensitive accountId: 1 + enableCascadingDiscounts: true campaignPriority: universal loyaltyPrograms: - accountID: 5 defaultValidity: defaultValidity + defaultPending: defaultPending allowSubledger: true name: name description: description @@ -4814,6 +5006,7 @@ components: - 2 - accountID: 5 defaultValidity: defaultValidity + defaultPending: defaultPending allowSubledger: true name: name description: description @@ -4823,6 +5016,7 @@ components: - 2 - 2 name: name + exclusiveCampaignsStrategy: listOrder modified: 2000-01-23T04:56:07.000+00:00 currency: currency attributes: '{}' @@ -4831,12 +5025,12 @@ components: - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon properties: id: @@ -4887,14 +5081,34 @@ components: type: array campaignPriority: description: Default priority for campaigns created in this application, - can be one of (universal, stackable, exclusive) + can be one of (universal, stackable, exclusive). If no value is provided, + this is set to "universal" enum: - universal - stackable - exclusive type: string + exclusiveCampaignsStrategy: + description: The strategy used when choosing exclusive campaigns for evaluation, + can be one of (listOrder, lowestDiscount, highestDiscount). If no value + is provided, this is set to "listOrder" + enum: + - listOrder + - lowestDiscount + - highestDiscount + type: string + enableCascadingDiscounts: + description: Flag indicating if discounts should cascade for this application + type: boolean + enableFlattenedCartItems: + description: Flag indicating if cart items of quantity larger than one should + be separated into different items of quantity one + type: boolean attributesSettings: $ref: '#/components/schemas/AttributesSettings' + sandbox: + description: Flag indicating if this is a live or sandbox application + type: boolean loyaltyPrograms: description: An array containing all the loyalty programs to which this application is subscribed @@ -4911,9 +5125,111 @@ components: - name - timezone type: object + NewCampaignGroup: + properties: + name: + description: The name of this campaign group. + minLength: 1 + type: string + description: + description: A longer description of the campaign group. + type: string + subscribedApplicationsIds: + description: A list of the IDs of the applications that this campaign group + is enabled for + items: + type: integer + type: array + campaignIds: + description: A list of the IDs of the campaigns that this campaign group + owns + items: + type: integer + type: array + required: + - name + type: object + CampaignGroup: + description: "" + properties: + id: + description: Unique ID for this entity. + type: integer + created: + description: The exact moment this entity was created. + format: date-time + type: string + modified: + description: The exact moment this entity was last modified. + format: date-time + type: string + accountId: + description: The ID of the account that owns this entity. + type: integer + name: + description: The name of this campaign group. + minLength: 1 + type: string + description: + description: A longer description of the campaign group. + type: string + subscribedApplicationsIds: + description: A list of the IDs of the applications that this campaign group + is enabled for + items: + type: integer + type: array + campaignIds: + description: A list of the IDs of the campaigns that this campaign group + owns + items: + type: integer + type: array + required: + - accountId + - created + - id + - modified + - name + type: object + UpdateCampaignGroup: + description: "" + properties: + name: + description: The name of this campaign group. + minLength: 1 + type: string + description: + description: A longer description of the campaign group. + type: string + subscribedApplicationsIds: + description: A list of the IDs of the applications that this campaign group + is enabled for + items: + type: integer + type: array + campaignIds: + description: A list of the IDs of the campaigns that this campaign group + owns + items: + type: integer + type: array + required: + - name + type: object NewCampaign: example: activeRulesetId: 0 + description: description + campaignGroups: + - 6 + - 6 + tags: + - tags + - tags + - tags + - tags + - tags features: - coupons - coupons @@ -4924,7 +5240,6 @@ components: validCharacters: - validCharacters - validCharacters - description: description couponSettings: couponPattern: couponPattern validCharacters: @@ -4938,19 +5253,13 @@ components: - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - tags: - - tags - - tags - - tags - - tags - - tags properties: name: description: A friendly name for this campaign. @@ -5013,6 +5322,11 @@ components: items: $ref: '#/components/schemas/LimitConfig' type: array + campaignGroups: + description: The IDs of the campaign groups that own this entity. + items: + type: integer + type: array required: - features - limits @@ -5023,6 +5337,16 @@ components: UpdateCampaign: example: activeRulesetId: 0 + description: description + campaignGroups: + - 6 + - 6 + tags: + - tags + - tags + - tags + - tags + - tags features: - coupons - coupons @@ -5033,7 +5357,6 @@ components: validCharacters: - validCharacters - validCharacters - description: description couponSettings: couponPattern: couponPattern validCharacters: @@ -5047,19 +5370,13 @@ components: - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - tags: - - tags - - tags - - tags - - tags - - tags properties: name: description: A friendly name for this campaign. @@ -5122,6 +5439,11 @@ components: items: $ref: '#/components/schemas/LimitConfig' type: array + campaignGroups: + description: The IDs of the campaign groups that own this entity. + items: + type: integer + type: array required: - features - limits @@ -5131,7 +5453,7 @@ components: Campaign: description: "" example: - discountCount: 1 + discountCount: 4 description: description features: - coupons @@ -5143,32 +5465,35 @@ components: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + id: 7 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - activeRulesetId: 3 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 couponRedemptionCount: 4 - userId: 9 - couponCreationCount: 1 + userId: 3 + couponCreationCount: 9 + campaignGroups: + - 6 + - 6 tags: - tags - tags - tags - tags - tags - discountEffectCount: 1 + discountEffectCount: 7 createdBy: createdBy name: name referralSettings: @@ -5179,8 +5504,8 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 7 - referralRedemptionCount: 7 + applicationId: 5 + referralRedemptionCount: 1 updated: 2000-01-23T04:56:07.000+00:00 properties: id: @@ -5257,6 +5582,11 @@ components: items: $ref: '#/components/schemas/LimitConfig' type: array + campaignGroups: + description: The IDs of the campaign groups that own this entity. + items: + type: integer + type: array couponRedemptionCount: description: Number of coupons redeemed in the campaign. type: integer @@ -5555,7 +5885,7 @@ components: entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon properties: action: @@ -5720,10 +6050,10 @@ components: code: code friendProfileIntegrationId: friendProfileIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 + campaignId: 3 usageLimit: 0 - id: 0 - usageCounter: 1 + id: 6 + usageCounter: 3 advocateProfileIntegrationId: advocateProfileIntegrationId startDate: 2000-01-23T04:56:07.000+00:00 properties: @@ -5816,8 +6146,8 @@ components: startTime: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 applicationIds: - - applicationIds - - applicationIds + - 0 + - 0 tags: - tags - tags @@ -5833,7 +6163,7 @@ components: description: Application IDs of the applications to which a campaign should be copied to items: - type: string + type: integer type: array description: description: A detailed description of the campaign. @@ -6015,21 +6345,21 @@ components: example: recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 - usageLimit: 594488 - referralId: 0 - usageCounter: 3 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 batchId: batchId - discountCounter: 3.0937452626664474 + discountCounter: 8.969578798196912 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 7 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 670401.2593930737 + discountLimit: 10263.643742455395 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 7.143538047012306 + discountRemainder: 7.740351818741173 properties: id: description: Unique ID for this entity. @@ -6126,23 +6456,27 @@ components: couponRolledbackRedemptions: 1 totalCouponRolledbackRedemptions: 1 campaignRefundedDiscounts: 9.301444243932576 - campaignFreeItems: 2 - totalCampaignFreeItems: 4 - totalCampaignRefundedDiscounts: 3.616076749251911 + totalDeductedLoyaltyPoints: 9.018348186070783 couponRedemptions: 7 totalCampaignDiscountCosts: 7.061401241503109 referralRedemptions: 6 totalCampaignRevenue: 1.4658129805029452 campaignRevenue: 6.027456183070403 campaignDiscountCosts: 2.3021358869347655 + totalReferralRedemptions: 7 + couponsCreated: 1 + addedLoyaltyPoints: 9.369310271410669 + campaignRefund: 5.962133916683182 + campaignFreeItems: 2 + totalAddedLoyaltyPoints: 6.683562403749608 + totalCampaignFreeItems: 4 + totalCampaignRefundedDiscounts: 3.616076749251911 totalCampaignRefund: 5.637376656633329 totalCouponsCreated: 4 + deductedLoyaltyPoints: 8.762042012749001 totalCouponRedemptions: 1 - totalReferralRedemptions: 7 - couponsCreated: 1 referralsCreated: 5 totalReferralsCreated: 9 - campaignRefund: 5.962133916683182 properties: date: format: date-time @@ -6217,7 +6551,23 @@ components: description: Number of referrals created in the campaign by the rule engine since it began. type: integer + addedLoyaltyPoints: + description: Number of added loyalty points in the campaign in a specific + interval. + type: number + totalAddedLoyaltyPoints: + description: Number of added loyalty points in the campaign since it began. + type: number + deductedLoyaltyPoints: + description: Number of deducted loyalty points in the campaign in a specific + interval. + type: number + totalDeductedLoyaltyPoints: + description: Number of deducted loyalty points in the campaign since it + began. + type: number required: + - addedLoyaltyPoints - campaignDiscountCosts - campaignFreeItems - campaignRefund @@ -6227,8 +6577,10 @@ components: - couponRolledbackRedemptions - couponsCreated - date + - deductedLoyaltyPoints - referralRedemptions - referralsCreated + - totalAddedLoyaltyPoints - totalCampaignDiscountCosts - totalCampaignFreeItems - totalCampaignRefund @@ -6237,9 +6589,36 @@ components: - totalCouponRedemptions - totalCouponRolledbackRedemptions - totalCouponsCreated + - totalDeductedLoyaltyPoints - totalReferralRedemptions - totalReferralsCreated type: object + LoyaltyStatistics: + description: "" + example: + totalSpentPoints: 1.4658129805029452 + totalActivePoints: 0.8008281904610115 + totalPendingPoints: 6.027456183070403 + totalExpiredPoints: 5.962133916683182 + properties: + totalActivePoints: + description: Total of active points for this loyalty program + type: number + totalPendingPoints: + description: Total of pending points for this loyalty program + type: number + totalSpentPoints: + description: Total of spent points for this loyalty program + type: number + totalExpiredPoints: + description: Total of expired points for this loyalty program + type: number + required: + - totalActivePoints + - totalExpiredPoints + - totalPendingPoints + - totalSpentPoints + type: object ApplicationApiHealth: description: Report of health of the API connection of an application example: @@ -6397,7 +6776,6 @@ components: User: description: "" example: - releaseUpdate: true created: 2000-01-23T04:56:07.000+00:00 roles: - 5 @@ -6409,10 +6787,10 @@ components: modified: 2000-01-23T04:56:07.000+00:00 id: 6 state: invited + latestFeedTimestamp: 2000-01-23T04:56:07.000+00:00 authMethod: authMethod - latestFeature: latestFeature email: email - policy: policy + policy: '{}' properties: id: description: Unique ID for this entity. @@ -6446,14 +6824,12 @@ components: description: Full name type: string policy: - description: A blob of ACL JSON - format: acl - type: string - releaseUpdate: - description: Update the user via email - type: boolean - latestFeature: - description: Latest feature the user has been notified. + description: User ACL Policy + properties: {} + type: object + latestFeedTimestamp: + description: Latest timestamp the user has been notified for feed. + format: date-time type: string roles: description: Contains a list of all roles the user is a member of @@ -6475,7 +6851,6 @@ components: - modified - name - policy - - releaseUpdate - state type: object NewInvitation: @@ -6540,8 +6915,9 @@ components: description: Points to add or deduct example: name: name + validityDuration: validityDuration + pendingDuration: pendingDuration subLedgerID: subLedgerID - expiryDuration: expiryDuration points: 0.8008281904610115 properties: points: @@ -6550,10 +6926,15 @@ components: name: description: Allows to specify a name for the addition or deduction type: string - expiryDuration: + validityDuration: description: Indicates the duration after which the added loyalty points should expire. The format is a number followed by one letter indicating - the unit, like '1h' or '40m' or '30d'. + the time unit, like '1h' or '40m' (defined by Go time package). + type: string + pendingDuration: + description: Indicates the amount of time before the points are considered + valid. The format is a number followed by one letter indicating the time + unit, like '1h' or '40m' (defined by Go time package). type: string subLedgerID: description: This specifies if we are adding loyalty points to the main @@ -6567,6 +6948,7 @@ components: example: accountID: 5 defaultValidity: defaultValidity + defaultPending: defaultPending allowSubledger: true name: name description: description @@ -6600,7 +6982,12 @@ components: defaultValidity: description: Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating - the unit; like '1h' or '40m' or '30d'. + the unit; like '1h' or '40m'. + type: string + defaultPending: + description: Indicates the default duration for the pending time, after + which points will be valid. The format is a number followed by a duration + unit, like '1h' or '40m'. type: string allowSubledger: description: Indicates if this program supports subledgers inside the program @@ -6608,6 +6995,7 @@ components: required: - accountID - allowSubledger + - defaultPending - defaultValidity - description - id @@ -6637,13 +7025,19 @@ components: defaultValidity: description: Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating - the unit; like '1h' or '40m' or '30d'. + the unit; like '1h' or '40m'. + type: string + defaultPending: + description: Indicates the default duration for the pending time, after + which points will be valid. The format is a number followed by a duration + unit, like '1h' or '40m'. type: string allowSubledger: description: Indicates if this program supports subledgers inside the program type: boolean required: - allowSubledger + - defaultPending - defaultValidity - name - title @@ -6666,7 +7060,12 @@ components: defaultValidity: description: Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating - the unit; like '1h' or '40m' or '30d'. + the unit; like '1h' or '40m'. + type: string + defaultPending: + description: Indicates the default duration for the pending time, after + which points will be valid. The format is a number followed by a duration + unit, like '1h' or '40m'. type: string allowSubledger: description: Indicates if this program supports subledgers inside the program @@ -6676,16 +7075,17 @@ components: description: A single row of the ledger, describing one addition or deduction. example: expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 1 - amount: 5.962133916683182 + eventID: 7 + amount: 9.301444243932576 customerProfileID: customerProfileID created: 2000-01-23T04:56:07.000+00:00 name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 5 - programID: 6 + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 properties: created: format: date-time @@ -6704,7 +7104,10 @@ components: type: string amount: type: number - expiryDate: + startDate: + format: date-time + type: string + expiryDate: format: date-time type: string name: @@ -6733,101 +7136,267 @@ components: example: ledger: total: 0.8008281904610115 + totalSpentPoints: 5.962133916683182 + activePoints: + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 expiringPoints: - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 1 - amount: 5.962133916683182 + eventID: 7 + amount: 9.301444243932576 customerProfileID: customerProfileID created: 2000-01-23T04:56:07.000+00:00 name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 5 - programID: 6 + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 1 - amount: 5.962133916683182 + eventID: 7 + amount: 9.301444243932576 customerProfileID: customerProfileID created: 2000-01-23T04:56:07.000+00:00 name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 5 - programID: 6 + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + totalActivePoints: 6.027456183070403 + totalPendingPoints: 1.4658129805029452 + totalExpiredPoints: 5.637376656633329 transactions: - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 1 - amount: 5.962133916683182 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + expiredPoints: + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 customerProfileID: customerProfileID created: 2000-01-23T04:56:07.000+00:00 name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 5 - programID: 6 + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 1 - amount: 5.962133916683182 + eventID: 7 + amount: 9.301444243932576 customerProfileID: customerProfileID created: 2000-01-23T04:56:07.000+00:00 name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 5 - programID: 6 + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + pendingPoints: + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 subLedgers: key: total: 0.8008281904610115 + totalSpentPoints: 5.962133916683182 + activePoints: + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 expiringPoints: - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 1 - amount: 5.962133916683182 + eventID: 7 + amount: 9.301444243932576 customerProfileID: customerProfileID created: 2000-01-23T04:56:07.000+00:00 name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 5 - programID: 6 + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 1 - amount: 5.962133916683182 + eventID: 7 + amount: 9.301444243932576 customerProfileID: customerProfileID created: 2000-01-23T04:56:07.000+00:00 name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 5 - programID: 6 + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + totalActivePoints: 6.027456183070403 + totalPendingPoints: 1.4658129805029452 + totalExpiredPoints: 5.637376656633329 transactions: - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 1 - amount: 5.962133916683182 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + expiredPoints: + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + pendingPoints: + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 customerProfileID: customerProfileID created: 2000-01-23T04:56:07.000+00:00 name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 5 - programID: 6 + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 1 - amount: 5.962133916683182 + eventID: 7 + amount: 9.301444243932576 customerProfileID: customerProfileID created: 2000-01-23T04:56:07.000+00:00 name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 5 - programID: 6 + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 properties: ledger: $ref: '#/components/schemas/LoyaltySubLedger' @@ -6843,70 +7412,191 @@ components: description: Ledger of Balance in Loyalty Program for a Customer example: total: 0.8008281904610115 + totalSpentPoints: 5.962133916683182 + activePoints: + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 expiringPoints: - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 1 - amount: 5.962133916683182 + eventID: 7 + amount: 9.301444243932576 customerProfileID: customerProfileID created: 2000-01-23T04:56:07.000+00:00 name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 5 - programID: 6 + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 1 - amount: 5.962133916683182 + eventID: 7 + amount: 9.301444243932576 customerProfileID: customerProfileID created: 2000-01-23T04:56:07.000+00:00 name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 5 - programID: 6 + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + totalActivePoints: 6.027456183070403 + totalPendingPoints: 1.4658129805029452 + totalExpiredPoints: 5.637376656633329 transactions: - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 1 - amount: 5.962133916683182 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + expiredPoints: + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 + customerProfileID: customerProfileID + created: 2000-01-23T04:56:07.000+00:00 + name: name + subLedgerID: subLedgerID + customerSessionID: customerSessionID + type: type + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 + pendingPoints: + - expiryDate: 2000-01-23T04:56:07.000+00:00 + eventID: 7 + amount: 9.301444243932576 customerProfileID: customerProfileID created: 2000-01-23T04:56:07.000+00:00 name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 5 - programID: 6 + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 - expiryDate: 2000-01-23T04:56:07.000+00:00 - eventID: 1 - amount: 5.962133916683182 + eventID: 7 + amount: 9.301444243932576 customerProfileID: customerProfileID created: 2000-01-23T04:56:07.000+00:00 name: name subLedgerID: subLedgerID customerSessionID: customerSessionID type: type - userID: 5 - programID: 6 + userID: 3 + programID: 2 + startDate: 2000-01-23T04:56:07.000+00:00 properties: total: + description: | + ⚠️ Deprecated: Please use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance + title: Current Balance (Deprecated) + type: number + totalActivePoints: + description: Total amount of currently active and available points in the + customer's balance title: Current Balance type: number + totalPendingPoints: + description: Total amount of pending points, which are not active yet but + will become active in the future + title: Total pending points + type: number + totalSpentPoints: + description: Total amount of points already spent by this customer + title: Total spent points + type: number + totalExpiredPoints: + description: Total amount of points, that expired without ever being spent + title: Total expired points + type: number transactions: - description: Transactions contains a list of all events that have happened - such as additions, subtractions and expiries + description: List of all events that have happened such as additions, subtractions + and expiries items: $ref: '#/components/schemas/LoyaltyLedgerEntry' type: array expiringPoints: - description: ExpiringPoints contains a list of all points that will expiry - and when + description: List of all points that will expire + items: + $ref: '#/components/schemas/LoyaltyLedgerEntry' + type: array + activePoints: + description: List of all currently active points + items: + $ref: '#/components/schemas/LoyaltyLedgerEntry' + type: array + pendingPoints: + description: List of all points pending activation + items: + $ref: '#/components/schemas/LoyaltyLedgerEntry' + type: array + expiredPoints: + description: List of expired points items: $ref: '#/components/schemas/LoyaltyLedgerEntry' type: array required: - total + - totalActivePoints + - totalExpiredPoints + - totalPendingPoints + - totalSpentPoints type: object Loyalty: description: Customer specific information about loyalty points. @@ -6914,10 +7604,10 @@ components: programs: key: ledger: - currentBalance: 2.8841621266687802 + currentBalance: 5.944895607614016 subLedgers: key: - currentBalance: 2.8841621266687802 + currentBalance: 5.944895607614016 name: name title: title properties: @@ -6934,10 +7624,10 @@ components: description: Customer specific information about loyalty points. example: ledger: - currentBalance: 2.8841621266687802 + currentBalance: 5.944895607614016 subLedgers: key: - currentBalance: 2.8841621266687802 + currentBalance: 5.944895607614016 name: name title: title properties: @@ -6962,7 +7652,7 @@ components: LoyaltyProgramBalance: description: The balance in a Loyalty Program for some Customer. example: - currentBalance: 2.8841621266687802 + currentBalance: 5.944895607614016 properties: currentBalance: title: Current Balance @@ -7022,21 +7712,27 @@ components: CustomerProfile: description: "" example: - accountId: 1 - closedSessions: 1 + accountId: 6 + closedSessions: 7 created: 2000-01-23T04:56:07.000+00:00 integrationId: integrationId attributes: '{}' - totalSales: 6.84685269835264 + totalSales: 1.1730742509559433 lastActivity: 2000-01-23T04:56:07.000+00:00 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 + audienceMemberships: + - name: name + id: 5 + - name: name + id: 5 properties: integrationId: - description: The ID used for this entity in the application system. + description: The integration ID for this entity sent to and used in the + Talon.One system. format: string type: string created: @@ -7066,6 +7762,12 @@ components: $ref: '#/components/schemas/LoyaltyMembership' title: Loyalty programed joined type: array + audienceMemberships: + description: A list of audiences the customer belongs to + items: + $ref: '#/components/schemas/AudienceMembership' + title: Audience memberships + type: array lastActivity: description: Timestamp of the most recent event received from this customer format: date-time @@ -7080,101 +7782,97 @@ components: - lastActivity - totalSales type: object - CustomerProfileUpdate: - example: - customerProfile: - accountId: 1 - closedSessions: 1 - created: 2000-01-23T04:56:07.000+00:00 - integrationId: integrationId - attributes: '{}' - totalSales: 6.84685269835264 - lastActivity: 2000-01-23T04:56:07.000+00:00 - loyaltyMemberships: - - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 - - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 - properties: - customerProfile: - $ref: '#/components/schemas/CustomerProfile' - required: - - customerProfile - type: object CustomerInventory: example: coupons: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 - usageLimit: 594488 - referralId: 0 - usageCounter: 3 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 batchId: batchId - discountCounter: 3.0937452626664474 + discountCounter: 8.969578798196912 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 7 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 670401.2593930737 + discountLimit: 10263.643742455395 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 7.143538047012306 + discountRemainder: 7.740351818741173 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 - usageLimit: 594488 - referralId: 0 - usageCounter: 3 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 batchId: batchId - discountCounter: 3.0937452626664474 + discountCounter: 8.969578798196912 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 7 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 670401.2593930737 + discountLimit: 10263.643742455395 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 7.143538047012306 + discountRemainder: 7.740351818741173 referrals: - expiryDate: 2000-01-23T04:56:07.000+00:00 code: code friendProfileIntegrationId: friendProfileIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 + campaignId: 3 usageLimit: 0 - id: 0 - usageCounter: 1 + id: 6 + usageCounter: 3 advocateProfileIntegrationId: advocateProfileIntegrationId startDate: 2000-01-23T04:56:07.000+00:00 - expiryDate: 2000-01-23T04:56:07.000+00:00 code: code friendProfileIntegrationId: friendProfileIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 + campaignId: 3 usageLimit: 0 - id: 0 - usageCounter: 1 + id: 6 + usageCounter: 3 advocateProfileIntegrationId: advocateProfileIntegrationId startDate: 2000-01-23T04:56:07.000+00:00 profile: - accountId: 1 - closedSessions: 1 + accountId: 6 + closedSessions: 7 created: 2000-01-23T04:56:07.000+00:00 integrationId: integrationId attributes: '{}' - totalSales: 6.84685269835264 + totalSales: 1.1730742509559433 lastActivity: 2000-01-23T04:56:07.000+00:00 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 + audienceMemberships: + - name: name + id: 5 + - name: name + id: 5 + loyalty: + programs: + key: + ledger: + currentBalance: 5.944895607614016 + subLedgers: + key: + currentBalance: 5.944895607614016 + name: name + title: title properties: profile: $ref: '#/components/schemas/CustomerProfile' + loyalty: + $ref: '#/components/schemas/Loyalty' referrals: items: $ref: '#/components/schemas/Referral' @@ -7194,6 +7892,9 @@ components: identifiers: - identifiers - identifiers + - identifiers + - identifiers + - identifiers attributes: '{}' state: open cartItems: @@ -7267,6 +7968,7 @@ components: values such as device ID. items: type: string + maxItems: 5 type: array total: description: The total sum of the cart in one session. @@ -7286,11 +7988,14 @@ components: - couponCodes additionalCosts: key: - price: 6.027456183070403 + price: 7.386281948385884 profileId: profileId identifiers: - identifiers - identifiers + - identifiers + - identifiers + - identifiers referralCode: referralCode attributes: '{}' state: open @@ -7374,6 +8079,7 @@ components: values such as device ID. items: type: string + maxItems: 5 type: array attributes: description: | @@ -7440,7 +8146,8 @@ components: accruedDiscounts: 2.3021358869347655 properties: integrationId: - description: The ID used for this entity in the application system. + description: The integration ID for this entity sent to and used in the + Talon.One system. format: string type: string created: @@ -7503,11 +8210,14 @@ components: identifiers: - identifiers - identifiers + - identifiers + - identifiers + - identifiers integrationId: integrationId - total: 7.386281948385884 + total: 6.027456183070403 referral: referral discounts: - key: 1.2315135367772556 + key: 1.4658129805029452 profileId: profileId attributes: '{}' state: open @@ -7546,7 +8256,8 @@ components: firstSession: true properties: integrationId: - description: The ID used for this entity in the application system. + description: The integration ID for this entity sent to and used in the + Talon.One system. format: string type: string created: @@ -7595,6 +8306,7 @@ components: values such as device ID. items: type: string + maxItems: 5 type: array total: description: The total sum of the cart in one session. @@ -7641,12 +8353,15 @@ components: identifiers: - identifiers - identifiers + - identifiers + - identifiers + - identifiers integrationId: integrationId - total: 1.4658129805029452 + total: 1.2315135367772556 additionalCosts: key: - price: 6.027456183070403 - additionalCostTotal: 5.637376656633329 + price: 7.386281948385884 + additionalCostTotal: 1.4894159098541704 profileId: profileId referralCode: referralCode attributes: '{}' @@ -7684,10 +8399,11 @@ components: category: category height: 5.637376656633329 firstSession: true - cartItemTotal: 5.962133916683182 + cartItemTotal: 1.0246457001441578 properties: integrationId: - description: The ID used for this entity in the application system. + description: The integration ID for this entity sent to and used in the + Talon.One system. format: string type: string created: @@ -7745,6 +8461,7 @@ components: values such as device ID. items: type: string + maxItems: 5 type: array attributes: description: | @@ -7851,9 +8568,10 @@ components: - quantity - sku type: object + x-attributable: true AdditionalCost: example: - price: 6.027456183070403 + price: 7.386281948385884 properties: price: title: Price of additional cost @@ -7930,37 +8648,37 @@ components: referralRejectionReason: reason: ReferralNotFound campaignId: 6 - referralId: 1 + referralId: 6 warnings: '{}' couponRejectionReason: reason: CouponNotFound - campaignId: 6 - couponId: 3 + campaignId: 1 + couponId: 2 ledgerEntries: - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 9 + accountId: 8 eventId: 6 reason: reason - amount: 8 + amount: 3 created: 2000-01-23T04:56:07.000+00:00 profileId: profileId loyaltyProgramId: 9 - id: 5 - referenceId: 9 + id: 6 + referenceId: 6 - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 9 + accountId: 8 eventId: 6 reason: reason - amount: 8 + amount: 3 created: 2000-01-23T04:56:07.000+00:00 profileId: profileId loyaltyProgramId: 9 - id: 5 - referenceId: 9 + id: 6 + referenceId: 6 attributes: '{}' - id: 1 + id: 9 sessionId: sessionId - applicationId: 4 + applicationId: 9 type: type properties: id: @@ -8022,32 +8740,35 @@ components: coupon: recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 - usageLimit: 594488 - referralId: 0 - usageCounter: 3 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 batchId: batchId - discountCounter: 3.0937452626664474 + discountCounter: 8.969578798196912 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 7 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 670401.2593930737 + discountLimit: 10263.643742455395 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 7.143538047012306 + discountRemainder: 7.740351818741173 session: coupon: coupon created: 2000-01-23T04:56:07.000+00:00 identifiers: - identifiers - identifiers + - identifiers + - identifiers + - identifiers integrationId: integrationId - total: 7.386281948385884 + total: 6.027456183070403 referral: referral discounts: - key: 1.2315135367772556 + key: 1.4658129805029452 profileId: profileId attributes: '{}' state: open @@ -8085,26 +8806,31 @@ components: height: 5.637376656633329 firstSession: true profile: - accountId: 1 - closedSessions: 1 + accountId: 6 + closedSessions: 7 created: 2000-01-23T04:56:07.000+00:00 integrationId: integrationId attributes: '{}' - totalSales: 6.84685269835264 + totalSales: 1.1730742509559433 lastActivity: 2000-01-23T04:56:07.000+00:00 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 + audienceMemberships: + - name: name + id: 5 + - name: name + id: 5 loyalty: programs: key: ledger: - currentBalance: 2.8841621266687802 + currentBalance: 5.944895607614016 subLedgers: key: - currentBalance: 2.8841621266687802 + currentBalance: 5.944895607614016 name: name title: title event: @@ -8119,37 +8845,37 @@ components: referralRejectionReason: reason: ReferralNotFound campaignId: 6 - referralId: 1 + referralId: 6 warnings: '{}' couponRejectionReason: reason: CouponNotFound - campaignId: 6 - couponId: 3 + campaignId: 1 + couponId: 2 ledgerEntries: - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 9 + accountId: 8 eventId: 6 reason: reason - amount: 8 + amount: 3 created: 2000-01-23T04:56:07.000+00:00 profileId: profileId loyaltyProgramId: 9 - id: 5 - referenceId: 9 + id: 6 + referenceId: 6 - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 9 + accountId: 8 eventId: 6 reason: reason - amount: 8 + amount: 3 created: 2000-01-23T04:56:07.000+00:00 profileId: profileId loyaltyProgramId: 9 - id: 5 - referenceId: 9 + id: 6 + referenceId: 6 attributes: '{}' - id: 1 + id: 9 sessionId: sessionId - applicationId: 4 + applicationId: 9 type: type properties: session: @@ -8172,15 +8898,15 @@ components: Contains all entities that might interest Talon.One integrations. This is the response type returned by the V2 PUT customer_session endpoint example: effects: - - rulesetId: 7 - ruleIndex: 1 - campaignId: 6 + - rulesetId: 9 + ruleIndex: 0 + campaignId: 0 ruleName: ruleName effectType: effectType props: '{}' - - rulesetId: 7 - ruleIndex: 1 - campaignId: 6 + - rulesetId: 9 + ruleIndex: 0 + campaignId: 0 ruleName: ruleName effectType: effectType props: '{}' @@ -8189,14 +8915,14 @@ components: code: code friendProfileIntegrationId: friendProfileIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 + campaignId: 3 usageLimit: 0 - id: 0 - usageCounter: 1 + id: 6 + usageCounter: 3 advocateProfileIntegrationId: advocateProfileIntegrationId startDate: 2000-01-23T04:56:07.000+00:00 triggeredCampaigns: - - discountCount: 1 + - discountCount: 4 description: description features: - coupons @@ -8208,32 +8934,35 @@ components: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + id: 7 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - activeRulesetId: 3 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 couponRedemptionCount: 4 - userId: 9 - couponCreationCount: 1 + userId: 3 + couponCreationCount: 9 + campaignGroups: + - 6 + - 6 tags: - tags - tags - tags - tags - tags - discountEffectCount: 1 + discountEffectCount: 7 createdBy: createdBy name: name referralSettings: @@ -8244,10 +8973,10 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 7 - referralRedemptionCount: 7 + applicationId: 5 + referralRedemptionCount: 1 updated: 2000-01-23T04:56:07.000+00:00 - - discountCount: 1 + - discountCount: 4 description: description features: - coupons @@ -8259,32 +8988,35 @@ components: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + id: 7 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - activeRulesetId: 3 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 couponRedemptionCount: 4 - userId: 9 - couponCreationCount: 1 + userId: 3 + couponCreationCount: 9 + campaignGroups: + - 6 + - 6 tags: - tags - tags - tags - tags - tags - discountEffectCount: 1 + discountEffectCount: 7 createdBy: createdBy name: name referralSettings: @@ -8295,57 +9027,62 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 7 - referralRedemptionCount: 7 + applicationId: 5 + referralRedemptionCount: 1 updated: 2000-01-23T04:56:07.000+00:00 coupons: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 - usageLimit: 594488 - referralId: 0 - usageCounter: 3 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 batchId: batchId - discountCounter: 3.0937452626664474 + discountCounter: 8.969578798196912 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 7 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 670401.2593930737 + discountLimit: 10263.643742455395 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 7.143538047012306 + discountRemainder: 7.740351818741173 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 - usageLimit: 594488 - referralId: 0 - usageCounter: 3 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 batchId: batchId - discountCounter: 3.0937452626664474 + discountCounter: 8.969578798196912 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 7 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 670401.2593930737 + discountLimit: 10263.643742455395 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 7.143538047012306 + discountRemainder: 7.740351818741173 customerProfile: - accountId: 1 - closedSessions: 1 + accountId: 6 + closedSessions: 7 created: 2000-01-23T04:56:07.000+00:00 integrationId: integrationId attributes: '{}' - totalSales: 6.84685269835264 + totalSales: 1.1730742509559433 lastActivity: 2000-01-23T04:56:07.000+00:00 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 + audienceMemberships: + - name: name + id: 5 + - name: name + id: 5 customerSession: couponCodes: - couponCodes @@ -8354,12 +9091,15 @@ components: identifiers: - identifiers - identifiers + - identifiers + - identifiers + - identifiers integrationId: integrationId - total: 1.4658129805029452 + total: 1.2315135367772556 additionalCosts: key: - price: 6.027456183070403 - additionalCostTotal: 5.637376656633329 + price: 7.386281948385884 + additionalCostTotal: 1.4894159098541704 profileId: profileId referralCode: referralCode attributes: '{}' @@ -8397,15 +9137,15 @@ components: category: category height: 5.637376656633329 firstSession: true - cartItemTotal: 5.962133916683182 + cartItemTotal: 1.0246457001441578 loyalty: programs: key: ledger: - currentBalance: 2.8841621266687802 + currentBalance: 5.944895607614016 subLedgers: key: - currentBalance: 2.8841621266687802 + currentBalance: 5.944895607614016 name: name title: title event: @@ -8420,92 +9160,92 @@ components: referralRejectionReason: reason: ReferralNotFound campaignId: 6 - referralId: 1 + referralId: 6 warnings: '{}' couponRejectionReason: reason: CouponNotFound - campaignId: 6 - couponId: 3 + campaignId: 1 + couponId: 2 ledgerEntries: - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 9 + accountId: 8 eventId: 6 reason: reason - amount: 8 + amount: 3 created: 2000-01-23T04:56:07.000+00:00 profileId: profileId loyaltyProgramId: 9 - id: 5 - referenceId: 9 + id: 6 + referenceId: 6 - expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 9 + accountId: 8 eventId: 6 reason: reason - amount: 8 + amount: 3 created: 2000-01-23T04:56:07.000+00:00 profileId: profileId loyaltyProgramId: 9 - id: 5 - referenceId: 9 + id: 6 + referenceId: 6 attributes: '{}' - id: 1 + id: 9 sessionId: sessionId - applicationId: 4 + applicationId: 9 type: type createdCoupons: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 - usageLimit: 594488 - referralId: 0 - usageCounter: 3 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 batchId: batchId - discountCounter: 3.0937452626664474 + discountCounter: 8.969578798196912 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 7 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 670401.2593930737 + discountLimit: 10263.643742455395 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 7.143538047012306 + discountRemainder: 7.740351818741173 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 - usageLimit: 594488 - referralId: 0 - usageCounter: 3 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 batchId: batchId - discountCounter: 3.0937452626664474 + discountCounter: 8.969578798196912 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 7 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 670401.2593930737 + discountLimit: 10263.643742455395 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 7.143538047012306 + discountRemainder: 7.740351818741173 createdReferrals: - expiryDate: 2000-01-23T04:56:07.000+00:00 code: code friendProfileIntegrationId: friendProfileIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 + campaignId: 3 usageLimit: 0 - id: 0 - usageCounter: 1 + id: 6 + usageCounter: 3 advocateProfileIntegrationId: advocateProfileIntegrationId startDate: 2000-01-23T04:56:07.000+00:00 - expiryDate: 2000-01-23T04:56:07.000+00:00 code: code friendProfileIntegrationId: friendProfileIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 + campaignId: 3 usageLimit: 0 - id: 0 - usageCounter: 1 + id: 6 + usageCounter: 3 advocateProfileIntegrationId: advocateProfileIntegrationId startDate: 2000-01-23T04:56:07.000+00:00 properties: @@ -8557,9 +9297,14 @@ components: id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 + audienceMemberships: + - name: name + id: 5 + - name: name + id: 5 properties: id: description: Unique ID for this entity. @@ -8570,8 +9315,9 @@ components: format: date-time type: string integrationId: - description: The ID used for this entity in the application system. The - ID used for this entity in the application system. + description: The integration ID for this entity sent to and used in the + Talon.One system. The integration ID for this entity sent to and used + in the Talon.One system. format: string type: string attributes: @@ -8597,6 +9343,12 @@ components: $ref: '#/components/schemas/LoyaltyMembership' title: Loyalty programed joined type: array + audienceMemberships: + description: A list of audiences the customer belongs to + items: + $ref: '#/components/schemas/AudienceMembership' + title: Audience memberships + type: array lastActivity: description: Timestamp of the most recent event received from this customer format: date-time @@ -8676,7 +9428,8 @@ components: this entity. type: integer integrationId: - description: The ID used for this entity in the application system. + description: The integration ID for this entity sent to and used in the + Talon.One system. format: string type: string profileintegrationid: @@ -8791,66 +9544,79 @@ components: type: object AccountAnalytics: example: - expiredCoupons: 2 - roles: 7 - activeCampaigns: 6 - activeCoupons: 5 - users: 4 + liveActiveCampaigns: 2 + expiredCoupons: 3 + roles: 1 + activeCampaigns: 5 + activeCoupons: 9 + sandboxApplications: 1 activeRules: 1 - campaigns: 1 - coupons: 5 - expiredReferralCodes: 2 - webhooks: 1 + users: 1 + liveApplications: 6 + campaigns: 5 + coupons: 7 + expiredReferralCodes: 7 + webhooks: 7 loyaltyPrograms: 1 - referralCodes: 9 + referralCodes: 2 applications: 0 - customAttributes: 7 - activeReferralCodes: 3 + activeReferralCodes: 4 + customAttributes: 6 properties: applications: - description: Total Number of Applications inside the account + description: Total number of applications in the account type: integer - activeCampaigns: - description: Total Number of Active Applications inside the account + liveApplications: + description: Total number of live applications in the account + type: integer + sandboxApplications: + description: Total number of sandbox applications in the account type: integer campaigns: - description: Total Number of campaigns inside the account + description: Total number of campaigns in the account + type: integer + activeCampaigns: + description: Total number of active campaigns in the account + type: integer + liveActiveCampaigns: + description: Total number of active campaigns in live applications in the + account type: integer coupons: - description: Total Number of coupons inside the account + description: Total number of coupons in the account type: integer activeCoupons: - description: Total Number of active coupons inside the account + description: Total number of active coupons in the account type: integer expiredCoupons: - description: Total Number of expired coupons inside the account - type: integer - customAttributes: - description: Total Number of custom attributes inside the account + description: Total number of expired coupons in the account type: integer referralCodes: - description: Total Number of referral codes inside the account + description: Total number of referral codes in the account type: integer activeReferralCodes: - description: Total Number of active referral codes inside the account + description: Total number of active referral codes in the account type: integer expiredReferralCodes: - description: Total Number of expired referral codes inside the account + description: Total number of expired referral codes in the account + type: integer + activeRules: + description: Total number of active rules in the account type: integer users: - description: Total Number of users inside the account + description: Total number of users in the account type: integer roles: - description: Total Number of roles inside the account + description: Total number of roles in the account + type: integer + customAttributes: + description: Total number of custom attributes in the account type: integer webhooks: - description: Total Number of webhooks inside the account + description: Total number of webhooks in the account type: integer loyaltyPrograms: - description: Total Number of loyalty programs inside the account - type: integer - activeRules: - description: Total Number of active rules in the account + description: Total number of loyalty programs in the account type: integer required: - activeCampaigns @@ -8863,54 +9629,59 @@ components: - customAttributes - expiredCoupons - expiredReferralCodes + - liveActiveCampaigns + - liveApplications - loyaltyPrograms - referralCodes - roles + - sandboxApplications - users - webhooks type: object AccountLimits: properties: liveApplications: - description: Total Number of allowed live applications in the account + description: Total number of allowed live applications in the account type: integer sandboxApplications: - description: Total Number of allowed sandbox applications in the account + description: Total number of allowed sandbox applications in the account type: integer activeCampaigns: - description: Total Number of allowed active campaigns in the account + description: Total number of allowed active campaigns in live applications + in the account type: integer coupons: - description: Total Number of allowed coupons in the account + description: Total number of allowed coupons in the account type: integer referralCodes: - description: Total Number of allowed referral codes in the account + description: Total number of allowed referral codes in the account + type: integer + activeRules: + description: Total number of allowed active rulesets in the account type: integer liveLoyaltyPrograms: - description: Total Number of allowed live loyalty programs in the account + description: Total number of allowed live loyalty programs in the account type: integer sandboxLoyaltyPrograms: - description: Total Number of allowed sandbox loyalty programs in the account + description: Total number of allowed sandbox loyalty programs in the account type: integer webhooks: - description: Total Number of allowed webhooks in the account + description: Total number of allowed webhooks in the account type: integer users: - description: Total Number of allowed users in the account + description: Total number of allowed users in the account type: integer apiVolume: - description: Total allowed api volume - type: integer - activeRules: - description: Total allowed active rulesets + description: Allowed volume of API requests to the account type: integer promotionTypes: - description: array of rulesets where webhook is used + description: Array of promotion types that are employed in the account items: type: string type: array required: - activeCampaigns + - activeRules - apiVolume - coupons - liveApplications @@ -9103,12 +9874,6 @@ components: - deactivated - active type: string - releaseUpdate: - description: Update the user via email - type: boolean - latestFeature: - description: The latest feature you've been notified. - type: string roles: description: Update items: @@ -10001,6 +10766,69 @@ components: - url - verb type: object + NewAudience: + properties: + name: + description: The human-friendly display name for this Audience. + minLength: 1 + type: string + integration: + description: Integration that this audience was created in. + enum: + - mparticle + type: string + integrationId: + description: The ID of this Audience in the third-party integration + minLength: 1 + type: string + required: + - integration + - integrationId + - name + type: object + UpdateAudience: + properties: + name: + description: The human-friendly display name for this Audience. + minLength: 1 + type: string + required: + - name + type: object + Audience: + description: "" + properties: + accountId: + description: The ID of the account that owns this entity. + type: integer + id: + description: Unique ID for this entity. + type: integer + created: + description: The exact moment this entity was created. + format: date-time + type: string + name: + description: The human-friendly display name for this Audience. + minLength: 1 + type: string + integration: + description: Integration that this audience was created in. + enum: + - mparticle + type: string + integrationId: + description: The ID of this Audience in the third-party integration + minLength: 1 + type: string + required: + - accountId + - created + - id + - integration + - integrationId + - name + type: object ManagerConfig: properties: schemaVersion: @@ -10173,13 +11001,14 @@ components: description: "" example: accountID: 1 + campaignGroupID: 5 members: - 5 - 5 name: name description: description id: 6 - acl: acl + acl: '{}' properties: id: description: The ID of the role corresponding to the DB row @@ -10187,6 +11016,9 @@ components: accountID: description: The ID of the Talon.One account that owns this role. type: integer + campaignGroupID: + description: The ID of the Campaign Group this role was created for. + type: integer name: description: Name of the role type: string @@ -10199,9 +11031,9 @@ components: type: integer type: array acl: - description: Role Policy this should be a stringified blob of json - format: aclRole - type: string + description: Role ACL Policy + properties: {} + type: object required: - accountID - id @@ -10292,15 +11124,15 @@ components: description: "" example: expiryDate: 2000-01-23T04:56:07.000+00:00 - accountId: 9 + accountId: 8 eventId: 6 reason: reason - amount: 8 + amount: 3 created: 2000-01-23T04:56:07.000+00:00 profileId: profileId loyaltyProgramId: 9 - id: 5 - referenceId: 9 + id: 6 + referenceId: 6 properties: id: description: Unique ID for this entity. @@ -10350,7 +11182,7 @@ components: LoyaltyMembership: example: joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 properties: joined: description: The moment in which the loyalty program was joined. @@ -10396,12 +11228,12 @@ components: referralRejectionReason: reason: ReferralNotFound campaignId: 6 - referralId: 1 + referralId: 6 warnings: '{}' couponRejectionReason: reason: CouponNotFound - campaignId: 6 - couponId: 3 + campaignId: 1 + couponId: 2 properties: campaigns: description: Maps each evaluated campaign ID to a key-value list of that @@ -10417,6 +11249,7 @@ components: referralRejectionReason: $ref: '#/components/schemas/ReferralRejectionReason' warnings: + description: Contains warnings about possible misuse. properties: {} type: object type: object @@ -10426,8 +11259,8 @@ components: effect. example: reason: CouponNotFound - campaignId: 6 - couponId: 3 + campaignId: 1 + couponId: 2 properties: campaignId: type: integer @@ -10437,7 +11270,6 @@ components: enum: - CouponNotFound - CouponPartOfNotRunningCampaign - - CouponValidConditionMissing - CouponLimitReached - CampaignLimitReached - ProfileLimitReached @@ -10459,7 +11291,7 @@ components: example: reason: ReferralNotFound campaignId: 6 - referralId: 1 + referralId: 6 properties: campaignId: type: integer @@ -10470,7 +11302,6 @@ components: - ReferralNotFound - ReferralRecipientIdSameAsAdvocate - ReferralPartOfNotRunningCampaign - - ReferralValidConditionMissing - ReferralLimitReached - CampaignLimitReached - ProfileLimitReached @@ -10486,16 +11317,29 @@ components: - referralId type: object ApplicationAPIKey: + description: "" properties: + title: + description: Title for API Key + type: string + expires: + description: The date the API key expired + format: date-time + type: string + platform: + description: Platform the API key is valid for. + enum: + - none + - segment + - braze + - mparticle + type: string id: description: ID of the API Key type: integer createdBy: description: ID of user who created type: integer - title: - description: Title for API Key - type: string accountID: description: ID of account the key is used for type: integer @@ -10506,10 +11350,6 @@ components: description: The date the API key was created format: date-time type: string - expires: - description: The date the API key expired - format: date-time - type: string required: - accountID - applicationID @@ -10522,15 +11362,27 @@ components: NewApplicationAPIKey: description: "" properties: + title: + description: Title for API Key + type: string + expires: + description: The date the API key expired + format: date-time + type: string + platform: + description: Platform the API key is valid for. + enum: + - none + - segment + - braze + - mparticle + type: string id: description: ID of the API Key type: integer createdBy: description: ID of user who created type: integer - title: - description: Title for API Key - type: string accountID: description: ID of account the key is used for type: integer @@ -10541,10 +11393,6 @@ components: description: The date the API key was created format: date-time type: string - expires: - description: The date the API key expired - format: date-time - type: string key: description: Raw API Key type: string @@ -10567,6 +11415,14 @@ components: description: The date the API key expired format: date-time type: string + platform: + description: Platform the API key is valid for. + enum: + - none + - segment + - braze + - mparticle + type: string required: - expires - title @@ -10764,9 +11620,9 @@ components: Effect: description: "" example: - rulesetId: 7 - ruleIndex: 1 - campaignId: 6 + rulesetId: 9 + ruleIndex: 0 + campaignId: 0 ruleName: ruleName effectType: effectType props: '{}' @@ -10927,7 +11783,7 @@ components: SetDiscountEffectProps: description: The properties specific to the "setDiscount" effect. This gets triggered whenever a validated rule contained a "set discount" effect. This - is a discount that should be applied globally on the session total. + is a discount that should be applied on the scope of defined with it. properties: name: description: The name/description of this discount @@ -10935,6 +11791,10 @@ components: value: description: The total monetary value of the discount type: number + scope: + description: The scope which the discount was applied on, can be one of + (cartItems,additionalCosts,sessionTotal) + type: string required: - name - value @@ -10954,6 +11814,10 @@ components: description: The index of the item in the cart items list on which this discount should be applied type: number + subPosition: + description: The sub-index of the item in an item stack on which this discount + should be applied + type: number required: - name - position @@ -10996,11 +11860,15 @@ components: recipientIntegrationId: description: The user for whom these points were added type: string - expiryCondition: - description: The amount of time (in days) these points are valid + startDate: + description: Date after which points will be valid + format: date-time + type: string + expiryDate: + description: Date after which points will expire + format: date-time type: string required: - - expiryCondition - name - programId - recipientIntegrationId @@ -11153,11 +12021,14 @@ components: - couponCodes additionalCosts: key: - price: 6.027456183070403 + price: 7.386281948385884 profileId: profileId identifiers: - identifiers - identifiers + - identifiers + - identifiers + - identifiers referralCode: referralCode attributes: '{}' state: open @@ -11215,33 +12086,923 @@ components: required: - customerSession type: object + CustomerProfileIntegrationRequestV2: + description: "" + example: + attributes: '{}' + responseContent: + - customerProfile + - customerProfile + properties: + attributes: + description: Arbitrary properties associated with this item + properties: {} + type: object + responseContent: + description: | + Optional list of requested information to be present on the response related to the customer profile update. Currently supported: "customerProfile", "triggeredCampaigns", "loyalty" and "event". + items: + enum: + - customerProfile + - triggeredCampaigns + - loyalty + - event + type: string + type: array + type: object + AudienceMembership: + example: + name: name + id: 5 + properties: + id: + description: The ID of the audience belonging to this entity. + title: Audience ID + type: integer + name: + description: The Name of the audience belonging to this entity. + title: Audience Name + type: string + required: + - id + - name + type: object + MultipleCustomerProfileIntegrationRequest: + example: + customerProfiles: + - integrationId: integrationId + attributes: '{}' + - integrationId: integrationId + attributes: '{}' + properties: + customerProfiles: + items: + $ref: '#/components/schemas/MultipleCustomerProfileIntegrationRequestItem' + type: array + type: object + MultipleCustomerProfileIntegrationRequestItem: + description: "" + example: + integrationId: integrationId + attributes: '{}' + properties: + attributes: + description: Arbitrary properties associated with this item + properties: {} + type: object + integrationId: + description: The custom identifier for this profile, must be unique within + the account. + type: string + required: + - integrationId + type: object + MultipleCustomerProfileIntegrationResponseV2: + example: + integrationStates: + - effects: + - rulesetId: 9 + ruleIndex: 0 + campaignId: 0 + ruleName: ruleName + effectType: effectType + props: '{}' + - rulesetId: 9 + ruleIndex: 0 + campaignId: 0 + ruleName: ruleName + effectType: effectType + props: '{}' + referral: + expiryDate: 2000-01-23T04:56:07.000+00:00 + code: code + friendProfileIntegrationId: friendProfileIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 3 + usageLimit: 0 + id: 6 + usageCounter: 3 + advocateProfileIntegrationId: advocateProfileIntegrationId + startDate: 2000-01-23T04:56:07.000+00:00 + triggeredCampaigns: + - discountCount: 4 + description: description + features: + - coupons + - coupons + - coupons + couponSettings: + couponPattern: couponPattern + validCharacters: + - validCharacters + - validCharacters + startTime: 2000-01-23T04:56:07.000+00:00 + id: 7 + state: enabled + limits: + - entities: + - Coupon + - Coupon + limit: 0.02025324113236393 + action: redeemCoupon + - entities: + - Coupon + - Coupon + limit: 0.02025324113236393 + action: redeemCoupon + activeRulesetId: 4 + updatedBy: updatedBy + created: 2000-01-23T04:56:07.000+00:00 + couponRedemptionCount: 4 + userId: 3 + couponCreationCount: 9 + campaignGroups: + - 6 + - 6 + tags: + - tags + - tags + - tags + - tags + - tags + discountEffectCount: 7 + createdBy: createdBy + name: name + referralSettings: + couponPattern: couponPattern + validCharacters: + - validCharacters + - validCharacters + attributes: '{}' + lastActivity: 2000-01-23T04:56:07.000+00:00 + endTime: 2000-01-23T04:56:07.000+00:00 + applicationId: 5 + referralRedemptionCount: 1 + updated: 2000-01-23T04:56:07.000+00:00 + - discountCount: 4 + description: description + features: + - coupons + - coupons + - coupons + couponSettings: + couponPattern: couponPattern + validCharacters: + - validCharacters + - validCharacters + startTime: 2000-01-23T04:56:07.000+00:00 + id: 7 + state: enabled + limits: + - entities: + - Coupon + - Coupon + limit: 0.02025324113236393 + action: redeemCoupon + - entities: + - Coupon + - Coupon + limit: 0.02025324113236393 + action: redeemCoupon + activeRulesetId: 4 + updatedBy: updatedBy + created: 2000-01-23T04:56:07.000+00:00 + couponRedemptionCount: 4 + userId: 3 + couponCreationCount: 9 + campaignGroups: + - 6 + - 6 + tags: + - tags + - tags + - tags + - tags + - tags + discountEffectCount: 7 + createdBy: createdBy + name: name + referralSettings: + couponPattern: couponPattern + validCharacters: + - validCharacters + - validCharacters + attributes: '{}' + lastActivity: 2000-01-23T04:56:07.000+00:00 + endTime: 2000-01-23T04:56:07.000+00:00 + applicationId: 5 + referralRedemptionCount: 1 + updated: 2000-01-23T04:56:07.000+00:00 + coupons: + - recipientIntegrationId: recipientIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 + batchId: batchId + discountCounter: 8.969578798196912 + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 3 + reservation: true + attributes: '{}' + id: 0 + value: value + discountLimit: 10263.643742455395 + startDate: 2000-01-23T04:56:07.000+00:00 + discountRemainder: 7.740351818741173 + - recipientIntegrationId: recipientIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 + batchId: batchId + discountCounter: 8.969578798196912 + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 3 + reservation: true + attributes: '{}' + id: 0 + value: value + discountLimit: 10263.643742455395 + startDate: 2000-01-23T04:56:07.000+00:00 + discountRemainder: 7.740351818741173 + customerProfile: + accountId: 6 + closedSessions: 7 + created: 2000-01-23T04:56:07.000+00:00 + integrationId: integrationId + attributes: '{}' + totalSales: 1.1730742509559433 + lastActivity: 2000-01-23T04:56:07.000+00:00 + loyaltyMemberships: + - joined: 2000-01-23T04:56:07.000+00:00 + loyaltyProgramId: 4 + - joined: 2000-01-23T04:56:07.000+00:00 + loyaltyProgramId: 4 + audienceMemberships: + - name: name + id: 5 + - name: name + id: 5 + customerSession: + couponCodes: + - couponCodes + - couponCodes + created: 2000-01-23T04:56:07.000+00:00 + identifiers: + - identifiers + - identifiers + - identifiers + - identifiers + - identifiers + integrationId: integrationId + total: 1.2315135367772556 + additionalCosts: + key: + price: 7.386281948385884 + additionalCostTotal: 1.4894159098541704 + profileId: profileId + referralCode: referralCode + attributes: '{}' + state: open + applicationId: 0 + cartItems: + - quantity: 1 + price: 1.4658129805029452 + name: name + width: 2.3021358869347655 + length: 7.061401241503109 + weight: 5.962133916683182 + attributes: '{}' + adjustment: + pointPayment: 1 + remainingPrice: 0.4145608029883936 + payFromLoyaltyProgram: 3 + position: 9.301444243932576 + sku: sku + category: category + height: 5.637376656633329 + - quantity: 1 + price: 1.4658129805029452 + name: name + width: 2.3021358869347655 + length: 7.061401241503109 + weight: 5.962133916683182 + attributes: '{}' + adjustment: + pointPayment: 1 + remainingPrice: 0.4145608029883936 + payFromLoyaltyProgram: 3 + position: 9.301444243932576 + sku: sku + category: category + height: 5.637376656633329 + firstSession: true + cartItemTotal: 1.0246457001441578 + loyalty: + programs: + key: + ledger: + currentBalance: 5.944895607614016 + subLedgers: + key: + currentBalance: 5.944895607614016 + name: name + title: title + event: + effects: + - '{}' + - '{}' + created: 2000-01-23T04:56:07.000+00:00 + profileId: profileId + meta: + campaigns: '{}' + coupons: '{}' + referralRejectionReason: + reason: ReferralNotFound + campaignId: 6 + referralId: 6 + warnings: '{}' + couponRejectionReason: + reason: CouponNotFound + campaignId: 1 + couponId: 2 + ledgerEntries: + - expiryDate: 2000-01-23T04:56:07.000+00:00 + accountId: 8 + eventId: 6 + reason: reason + amount: 3 + created: 2000-01-23T04:56:07.000+00:00 + profileId: profileId + loyaltyProgramId: 9 + id: 6 + referenceId: 6 + - expiryDate: 2000-01-23T04:56:07.000+00:00 + accountId: 8 + eventId: 6 + reason: reason + amount: 3 + created: 2000-01-23T04:56:07.000+00:00 + profileId: profileId + loyaltyProgramId: 9 + id: 6 + referenceId: 6 + attributes: '{}' + id: 9 + sessionId: sessionId + applicationId: 9 + type: type + createdCoupons: + - recipientIntegrationId: recipientIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 + batchId: batchId + discountCounter: 8.969578798196912 + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 3 + reservation: true + attributes: '{}' + id: 0 + value: value + discountLimit: 10263.643742455395 + startDate: 2000-01-23T04:56:07.000+00:00 + discountRemainder: 7.740351818741173 + - recipientIntegrationId: recipientIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 + batchId: batchId + discountCounter: 8.969578798196912 + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 3 + reservation: true + attributes: '{}' + id: 0 + value: value + discountLimit: 10263.643742455395 + startDate: 2000-01-23T04:56:07.000+00:00 + discountRemainder: 7.740351818741173 + createdReferrals: + - expiryDate: 2000-01-23T04:56:07.000+00:00 + code: code + friendProfileIntegrationId: friendProfileIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 3 + usageLimit: 0 + id: 6 + usageCounter: 3 + advocateProfileIntegrationId: advocateProfileIntegrationId + startDate: 2000-01-23T04:56:07.000+00:00 + - expiryDate: 2000-01-23T04:56:07.000+00:00 + code: code + friendProfileIntegrationId: friendProfileIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 3 + usageLimit: 0 + id: 6 + usageCounter: 3 + advocateProfileIntegrationId: advocateProfileIntegrationId + startDate: 2000-01-23T04:56:07.000+00:00 + - effects: + - rulesetId: 9 + ruleIndex: 0 + campaignId: 0 + ruleName: ruleName + effectType: effectType + props: '{}' + - rulesetId: 9 + ruleIndex: 0 + campaignId: 0 + ruleName: ruleName + effectType: effectType + props: '{}' + referral: + expiryDate: 2000-01-23T04:56:07.000+00:00 + code: code + friendProfileIntegrationId: friendProfileIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 3 + usageLimit: 0 + id: 6 + usageCounter: 3 + advocateProfileIntegrationId: advocateProfileIntegrationId + startDate: 2000-01-23T04:56:07.000+00:00 + triggeredCampaigns: + - discountCount: 4 + description: description + features: + - coupons + - coupons + - coupons + couponSettings: + couponPattern: couponPattern + validCharacters: + - validCharacters + - validCharacters + startTime: 2000-01-23T04:56:07.000+00:00 + id: 7 + state: enabled + limits: + - entities: + - Coupon + - Coupon + limit: 0.02025324113236393 + action: redeemCoupon + - entities: + - Coupon + - Coupon + limit: 0.02025324113236393 + action: redeemCoupon + activeRulesetId: 4 + updatedBy: updatedBy + created: 2000-01-23T04:56:07.000+00:00 + couponRedemptionCount: 4 + userId: 3 + couponCreationCount: 9 + campaignGroups: + - 6 + - 6 + tags: + - tags + - tags + - tags + - tags + - tags + discountEffectCount: 7 + createdBy: createdBy + name: name + referralSettings: + couponPattern: couponPattern + validCharacters: + - validCharacters + - validCharacters + attributes: '{}' + lastActivity: 2000-01-23T04:56:07.000+00:00 + endTime: 2000-01-23T04:56:07.000+00:00 + applicationId: 5 + referralRedemptionCount: 1 + updated: 2000-01-23T04:56:07.000+00:00 + - discountCount: 4 + description: description + features: + - coupons + - coupons + - coupons + couponSettings: + couponPattern: couponPattern + validCharacters: + - validCharacters + - validCharacters + startTime: 2000-01-23T04:56:07.000+00:00 + id: 7 + state: enabled + limits: + - entities: + - Coupon + - Coupon + limit: 0.02025324113236393 + action: redeemCoupon + - entities: + - Coupon + - Coupon + limit: 0.02025324113236393 + action: redeemCoupon + activeRulesetId: 4 + updatedBy: updatedBy + created: 2000-01-23T04:56:07.000+00:00 + couponRedemptionCount: 4 + userId: 3 + couponCreationCount: 9 + campaignGroups: + - 6 + - 6 + tags: + - tags + - tags + - tags + - tags + - tags + discountEffectCount: 7 + createdBy: createdBy + name: name + referralSettings: + couponPattern: couponPattern + validCharacters: + - validCharacters + - validCharacters + attributes: '{}' + lastActivity: 2000-01-23T04:56:07.000+00:00 + endTime: 2000-01-23T04:56:07.000+00:00 + applicationId: 5 + referralRedemptionCount: 1 + updated: 2000-01-23T04:56:07.000+00:00 + coupons: + - recipientIntegrationId: recipientIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 + batchId: batchId + discountCounter: 8.969578798196912 + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 3 + reservation: true + attributes: '{}' + id: 0 + value: value + discountLimit: 10263.643742455395 + startDate: 2000-01-23T04:56:07.000+00:00 + discountRemainder: 7.740351818741173 + - recipientIntegrationId: recipientIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 + batchId: batchId + discountCounter: 8.969578798196912 + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 3 + reservation: true + attributes: '{}' + id: 0 + value: value + discountLimit: 10263.643742455395 + startDate: 2000-01-23T04:56:07.000+00:00 + discountRemainder: 7.740351818741173 + customerProfile: + accountId: 6 + closedSessions: 7 + created: 2000-01-23T04:56:07.000+00:00 + integrationId: integrationId + attributes: '{}' + totalSales: 1.1730742509559433 + lastActivity: 2000-01-23T04:56:07.000+00:00 + loyaltyMemberships: + - joined: 2000-01-23T04:56:07.000+00:00 + loyaltyProgramId: 4 + - joined: 2000-01-23T04:56:07.000+00:00 + loyaltyProgramId: 4 + audienceMemberships: + - name: name + id: 5 + - name: name + id: 5 + customerSession: + couponCodes: + - couponCodes + - couponCodes + created: 2000-01-23T04:56:07.000+00:00 + identifiers: + - identifiers + - identifiers + - identifiers + - identifiers + - identifiers + integrationId: integrationId + total: 1.2315135367772556 + additionalCosts: + key: + price: 7.386281948385884 + additionalCostTotal: 1.4894159098541704 + profileId: profileId + referralCode: referralCode + attributes: '{}' + state: open + applicationId: 0 + cartItems: + - quantity: 1 + price: 1.4658129805029452 + name: name + width: 2.3021358869347655 + length: 7.061401241503109 + weight: 5.962133916683182 + attributes: '{}' + adjustment: + pointPayment: 1 + remainingPrice: 0.4145608029883936 + payFromLoyaltyProgram: 3 + position: 9.301444243932576 + sku: sku + category: category + height: 5.637376656633329 + - quantity: 1 + price: 1.4658129805029452 + name: name + width: 2.3021358869347655 + length: 7.061401241503109 + weight: 5.962133916683182 + attributes: '{}' + adjustment: + pointPayment: 1 + remainingPrice: 0.4145608029883936 + payFromLoyaltyProgram: 3 + position: 9.301444243932576 + sku: sku + category: category + height: 5.637376656633329 + firstSession: true + cartItemTotal: 1.0246457001441578 + loyalty: + programs: + key: + ledger: + currentBalance: 5.944895607614016 + subLedgers: + key: + currentBalance: 5.944895607614016 + name: name + title: title + event: + effects: + - '{}' + - '{}' + created: 2000-01-23T04:56:07.000+00:00 + profileId: profileId + meta: + campaigns: '{}' + coupons: '{}' + referralRejectionReason: + reason: ReferralNotFound + campaignId: 6 + referralId: 6 + warnings: '{}' + couponRejectionReason: + reason: CouponNotFound + campaignId: 1 + couponId: 2 + ledgerEntries: + - expiryDate: 2000-01-23T04:56:07.000+00:00 + accountId: 8 + eventId: 6 + reason: reason + amount: 3 + created: 2000-01-23T04:56:07.000+00:00 + profileId: profileId + loyaltyProgramId: 9 + id: 6 + referenceId: 6 + - expiryDate: 2000-01-23T04:56:07.000+00:00 + accountId: 8 + eventId: 6 + reason: reason + amount: 3 + created: 2000-01-23T04:56:07.000+00:00 + profileId: profileId + loyaltyProgramId: 9 + id: 6 + referenceId: 6 + attributes: '{}' + id: 9 + sessionId: sessionId + applicationId: 9 + type: type + createdCoupons: + - recipientIntegrationId: recipientIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 + batchId: batchId + discountCounter: 8.969578798196912 + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 3 + reservation: true + attributes: '{}' + id: 0 + value: value + discountLimit: 10263.643742455395 + startDate: 2000-01-23T04:56:07.000+00:00 + discountRemainder: 7.740351818741173 + - recipientIntegrationId: recipientIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 + batchId: batchId + discountCounter: 8.969578798196912 + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 3 + reservation: true + attributes: '{}' + id: 0 + value: value + discountLimit: 10263.643742455395 + startDate: 2000-01-23T04:56:07.000+00:00 + discountRemainder: 7.740351818741173 + createdReferrals: + - expiryDate: 2000-01-23T04:56:07.000+00:00 + code: code + friendProfileIntegrationId: friendProfileIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 3 + usageLimit: 0 + id: 6 + usageCounter: 3 + advocateProfileIntegrationId: advocateProfileIntegrationId + startDate: 2000-01-23T04:56:07.000+00:00 + - expiryDate: 2000-01-23T04:56:07.000+00:00 + code: code + friendProfileIntegrationId: friendProfileIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 3 + usageLimit: 0 + id: 6 + usageCounter: 3 + advocateProfileIntegrationId: advocateProfileIntegrationId + startDate: 2000-01-23T04:56:07.000+00:00 + properties: + integrationStates: + items: + $ref: '#/components/schemas/IntegrationStateV2' + type: array + type: object + CustomerProfileAudienceRequest: + example: + data: + - profileIntegrationId: profileIntegrationId + action: add + audienceId: 0 + - profileIntegrationId: profileIntegrationId + action: add + audienceId: 0 + properties: + data: + items: + $ref: '#/components/schemas/CustomerProfileAudienceRequestItem' + type: array + type: object + CustomerProfileAudienceRequestItem: + example: + profileIntegrationId: profileIntegrationId + action: add + audienceId: 0 + properties: + action: + enum: + - add + - delete + type: string + profileIntegrationId: + type: string + audienceId: + type: integer + required: + - action + - audienceId + - profileIntegrationId + type: object + FeedNotification: + description: A feed notification for CAMA users + properties: + title: + description: Title of the feed notification + type: string + created: + description: Timestamp of the moment this feed notification was created + format: date-time + type: string + updated: + description: Timestamp of the moment this feed notification was last updated + format: date-time + type: string + articleUrl: + description: URL to the feed notification in the help center + type: string + type: + description: The type of the feed notification + enum: + - feed + - feature + - announcement + - alert + - test + type: string + body: + description: Body of the feed notification + type: string + required: + - articleUrl + - body + - created + - title + - type + - updated + type: object + UserFeedNotifications: + description: notifications to notify CAMA user about + properties: + lastUpdate: + description: Timestamp of the last request for this list + format: date-time + type: string + notifications: + description: List of all notifications to notify the user about + items: + $ref: '#/components/schemas/FeedNotification' + type: array + required: + - lastUpdate + - notifications + type: object + UpdateUserLatestFeedTimestamp: + description: Updates current user's latest seen notifications timestamp + properties: + newLatestFeedTimestamp: + description: New timestamp to update for the current user + format: date-time + type: string + required: + - newLatestFeedTimestamp + type: object inline_response_200: example: data: - - accountId: 1 - closedSessions: 1 + - accountId: 6 + closedSessions: 7 created: 2000-01-23T04:56:07.000+00:00 integrationId: integrationId attributes: '{}' - totalSales: 6.84685269835264 + totalSales: 1.1730742509559433 lastActivity: 2000-01-23T04:56:07.000+00:00 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 - - accountId: 1 - closedSessions: 1 + loyaltyProgramId: 4 + audienceMemberships: + - name: name + id: 5 + - name: name + id: 5 + - accountId: 6 + closedSessions: 7 created: 2000-01-23T04:56:07.000+00:00 integrationId: integrationId attributes: '{}' - totalSales: 6.84685269835264 + totalSales: 1.1730742509559433 lastActivity: 2000-01-23T04:56:07.000+00:00 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 + audienceMemberships: + - name: name + id: 5 + - name: name + id: 5 totalResultSize: 0 properties: totalResultSize: @@ -11256,8 +13017,10 @@ components: inline_response_200_1: example: data: - - created: 2000-01-23T04:56:07.000+00:00 + - enableFlattenedCartItems: true + created: 2000-01-23T04:56:07.000+00:00 timezone: timezone + sandbox: true description: description attributesSettings: mandatory: @@ -11269,10 +13032,12 @@ components: - coupons caseSensitivity: sensitive accountId: 1 + enableCascadingDiscounts: true campaignPriority: universal loyaltyPrograms: - accountID: 5 defaultValidity: defaultValidity + defaultPending: defaultPending allowSubledger: true name: name description: description @@ -11283,6 +13048,7 @@ components: - 2 - accountID: 5 defaultValidity: defaultValidity + defaultPending: defaultPending allowSubledger: true name: name description: description @@ -11292,6 +13058,7 @@ components: - 2 - 2 name: name + exclusiveCampaignsStrategy: listOrder modified: 2000-01-23T04:56:07.000+00:00 currency: currency attributes: '{}' @@ -11300,15 +13067,17 @@ components: - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - - created: 2000-01-23T04:56:07.000+00:00 + - enableFlattenedCartItems: true + created: 2000-01-23T04:56:07.000+00:00 timezone: timezone + sandbox: true description: description attributesSettings: mandatory: @@ -11320,10 +13089,12 @@ components: - coupons caseSensitivity: sensitive accountId: 1 + enableCascadingDiscounts: true campaignPriority: universal loyaltyPrograms: - accountID: 5 defaultValidity: defaultValidity + defaultPending: defaultPending allowSubledger: true name: name description: description @@ -11334,6 +13105,7 @@ components: - 2 - accountID: 5 defaultValidity: defaultValidity + defaultPending: defaultPending allowSubledger: true name: name description: description @@ -11343,6 +13115,7 @@ components: - 2 - 2 name: name + exclusiveCampaignsStrategy: listOrder modified: 2000-01-23T04:56:07.000+00:00 currency: currency attributes: '{}' @@ -11351,12 +13124,12 @@ components: - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon totalResultSize: 0 properties: @@ -11372,7 +13145,7 @@ components: inline_response_200_2: example: data: - - discountCount: 1 + - discountCount: 4 description: description features: - coupons @@ -11384,32 +13157,35 @@ components: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + id: 7 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - activeRulesetId: 3 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 couponRedemptionCount: 4 - userId: 9 - couponCreationCount: 1 + userId: 3 + couponCreationCount: 9 + campaignGroups: + - 6 + - 6 tags: - tags - tags - tags - tags - tags - discountEffectCount: 1 + discountEffectCount: 7 createdBy: createdBy name: name referralSettings: @@ -11420,10 +13196,10 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 7 - referralRedemptionCount: 7 + applicationId: 5 + referralRedemptionCount: 1 updated: 2000-01-23T04:56:07.000+00:00 - - discountCount: 1 + - discountCount: 4 description: description features: - coupons @@ -11435,32 +13211,35 @@ components: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 2 + id: 7 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - entities: - Coupon - Coupon - limit: 0.20271230230023218 + limit: 0.02025324113236393 action: redeemCoupon - activeRulesetId: 3 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 couponRedemptionCount: 4 - userId: 9 - couponCreationCount: 1 + userId: 3 + couponCreationCount: 9 + campaignGroups: + - 6 + - 6 tags: - tags - tags - tags - tags - tags - discountEffectCount: 1 + discountEffectCount: 7 createdBy: createdBy name: name referralSettings: @@ -11471,8 +13250,8 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 7 - referralRedemptionCount: 7 + applicationId: 5 + referralRedemptionCount: 1 updated: 2000-01-23T04:56:07.000+00:00 totalResultSize: 0 properties: @@ -11606,38 +13385,38 @@ components: data: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 - usageLimit: 594488 - referralId: 0 - usageCounter: 3 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 batchId: batchId - discountCounter: 3.0937452626664474 + discountCounter: 8.969578798196912 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 7 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 670401.2593930737 + discountLimit: 10263.643742455395 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 7.143538047012306 + discountRemainder: 7.740351818741173 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 - usageLimit: 594488 - referralId: 0 - usageCounter: 3 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 batchId: batchId - discountCounter: 3.0937452626664474 + discountCounter: 8.969578798196912 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 7 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 670401.2593930737 + discountLimit: 10263.643742455395 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 7.143538047012306 + discountRemainder: 7.740351818741173 totalResultSize: 0 properties: totalResultSize: @@ -11654,38 +13433,38 @@ components: data: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 - usageLimit: 594488 - referralId: 0 - usageCounter: 3 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 batchId: batchId - discountCounter: 3.0937452626664474 + discountCounter: 8.969578798196912 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 7 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 670401.2593930737 + discountLimit: 10263.643742455395 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 7.143538047012306 + discountRemainder: 7.740351818741173 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 - usageLimit: 594488 - referralId: 0 - usageCounter: 3 + campaignId: 7 + usageLimit: 651917 + referralId: 3 + usageCounter: 4 batchId: batchId - discountCounter: 3.0937452626664474 + discountCounter: 8.969578798196912 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 7 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 670401.2593930737 + discountLimit: 10263.643742455395 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 7.143538047012306 + discountRemainder: 7.740351818741173 hasMore: true properties: hasMore: @@ -11704,20 +13483,20 @@ components: code: code friendProfileIntegrationId: friendProfileIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 + campaignId: 3 usageLimit: 0 - id: 0 - usageCounter: 1 + id: 6 + usageCounter: 3 advocateProfileIntegrationId: advocateProfileIntegrationId startDate: 2000-01-23T04:56:07.000+00:00 - expiryDate: 2000-01-23T04:56:07.000+00:00 code: code friendProfileIntegrationId: friendProfileIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 + campaignId: 3 usageLimit: 0 - id: 0 - usageCounter: 1 + id: 6 + usageCounter: 3 advocateProfileIntegrationId: advocateProfileIntegrationId startDate: 2000-01-23T04:56:07.000+00:00 totalResultSize: 0 @@ -11738,20 +13517,20 @@ components: code: code friendProfileIntegrationId: friendProfileIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 + campaignId: 3 usageLimit: 0 - id: 0 - usageCounter: 1 + id: 6 + usageCounter: 3 advocateProfileIntegrationId: advocateProfileIntegrationId startDate: 2000-01-23T04:56:07.000+00:00 - expiryDate: 2000-01-23T04:56:07.000+00:00 code: code friendProfileIntegrationId: friendProfileIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 6 + campaignId: 3 usageLimit: 0 - id: 0 - usageCounter: 1 + id: 6 + usageCounter: 3 advocateProfileIntegrationId: advocateProfileIntegrationId startDate: 2000-01-23T04:56:07.000+00:00 hasMore: true @@ -11770,6 +13549,7 @@ components: data: - accountID: 5 defaultValidity: defaultValidity + defaultPending: defaultPending allowSubledger: true name: name description: description @@ -11780,6 +13560,7 @@ components: - 2 - accountID: 5 defaultValidity: defaultValidity + defaultPending: defaultPending allowSubledger: true name: name description: description @@ -11862,44 +13643,52 @@ components: couponRolledbackRedemptions: 1 totalCouponRolledbackRedemptions: 1 campaignRefundedDiscounts: 9.301444243932576 - campaignFreeItems: 2 - totalCampaignFreeItems: 4 - totalCampaignRefundedDiscounts: 3.616076749251911 + totalDeductedLoyaltyPoints: 9.018348186070783 couponRedemptions: 7 totalCampaignDiscountCosts: 7.061401241503109 referralRedemptions: 6 totalCampaignRevenue: 1.4658129805029452 campaignRevenue: 6.027456183070403 campaignDiscountCosts: 2.3021358869347655 + totalReferralRedemptions: 7 + couponsCreated: 1 + addedLoyaltyPoints: 9.369310271410669 + campaignRefund: 5.962133916683182 + campaignFreeItems: 2 + totalAddedLoyaltyPoints: 6.683562403749608 + totalCampaignFreeItems: 4 + totalCampaignRefundedDiscounts: 3.616076749251911 totalCampaignRefund: 5.637376656633329 totalCouponsCreated: 4 + deductedLoyaltyPoints: 8.762042012749001 totalCouponRedemptions: 1 - totalReferralRedemptions: 7 - couponsCreated: 1 referralsCreated: 5 totalReferralsCreated: 9 - campaignRefund: 5.962133916683182 - date: 2000-01-23T04:56:07.000+00:00 couponRolledbackRedemptions: 1 totalCouponRolledbackRedemptions: 1 campaignRefundedDiscounts: 9.301444243932576 - campaignFreeItems: 2 - totalCampaignFreeItems: 4 - totalCampaignRefundedDiscounts: 3.616076749251911 + totalDeductedLoyaltyPoints: 9.018348186070783 couponRedemptions: 7 totalCampaignDiscountCosts: 7.061401241503109 referralRedemptions: 6 totalCampaignRevenue: 1.4658129805029452 campaignRevenue: 6.027456183070403 campaignDiscountCosts: 2.3021358869347655 + totalReferralRedemptions: 7 + couponsCreated: 1 + addedLoyaltyPoints: 9.369310271410669 + campaignRefund: 5.962133916683182 + campaignFreeItems: 2 + totalAddedLoyaltyPoints: 6.683562403749608 + totalCampaignFreeItems: 4 + totalCampaignRefundedDiscounts: 3.616076749251911 totalCampaignRefund: 5.637376656633329 totalCouponsCreated: 4 + deductedLoyaltyPoints: 8.762042012749001 totalCouponRedemptions: 1 - totalReferralRedemptions: 7 - couponsCreated: 1 referralsCreated: 5 totalReferralsCreated: 9 - campaignRefund: 5.962133916683182 totalResultSize: 0 properties: totalResultSize: @@ -11924,9 +13713,14 @@ components: id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 + audienceMemberships: + - name: name + id: 5 + - name: name + id: 5 - accountId: 1 closedSessions: 5 created: 2000-01-23T04:56:07.000+00:00 @@ -11937,20 +13731,27 @@ components: id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 + audienceMemberships: + - name: name + id: 5 + - name: name + id: 5 + hasMore: true totalResultSize: 0 properties: totalResultSize: type: integer + hasMore: + type: boolean data: items: $ref: '#/components/schemas/ApplicationCustomer' type: array required: - data - - totalResultSize inline_response_200_13: example: data: @@ -11964,9 +13765,14 @@ components: id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 + audienceMemberships: + - name: name + id: 5 + - name: name + id: 5 - accountId: 1 closedSessions: 5 created: 2000-01-23T04:56:07.000+00:00 @@ -11977,9 +13783,14 @@ components: id: 6 loyaltyMemberships: - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 - joined: 2000-01-23T04:56:07.000+00:00 - loyaltyProgramId: 7 + loyaltyProgramId: 4 + audienceMemberships: + - name: name + id: 5 + - name: name + id: 5 hasMore: true properties: hasMore: @@ -12503,8 +14314,7 @@ components: inline_response_200_26: example: data: - - releaseUpdate: true - created: 2000-01-23T04:56:07.000+00:00 + - created: 2000-01-23T04:56:07.000+00:00 roles: - 5 - 5 @@ -12515,12 +14325,11 @@ components: modified: 2000-01-23T04:56:07.000+00:00 id: 6 state: invited + latestFeedTimestamp: 2000-01-23T04:56:07.000+00:00 authMethod: authMethod - latestFeature: latestFeature email: email - policy: policy - - releaseUpdate: true - created: 2000-01-23T04:56:07.000+00:00 + policy: '{}' + - created: 2000-01-23T04:56:07.000+00:00 roles: - 5 - 5 @@ -12531,10 +14340,10 @@ components: modified: 2000-01-23T04:56:07.000+00:00 id: 6 state: invited + latestFeedTimestamp: 2000-01-23T04:56:07.000+00:00 authMethod: authMethod - latestFeature: latestFeature email: email - policy: policy + policy: '{}' totalResultSize: 0 properties: totalResultSize: @@ -12630,21 +14439,23 @@ components: example: data: - accountID: 1 + campaignGroupID: 5 members: - 5 - 5 name: name description: description id: 6 - acl: acl + acl: '{}' - accountID: 1 + campaignGroupID: 5 members: - 5 - 5 name: name description: description id: 6 - acl: acl + acl: '{}' totalResultSize: 0 properties: totalResultSize: diff --git a/api_integration.go b/api_integration.go index 58d8f550..360a8879 100644 --- a/api_integration.go +++ b/api_integration.go @@ -578,6 +578,7 @@ type apiGetCustomerInventoryRequest struct { profile *bool referrals *bool coupons *bool + loyalty *bool } func (r apiGetCustomerInventoryRequest) Profile(profile bool) apiGetCustomerInventoryRequest { @@ -595,6 +596,11 @@ func (r apiGetCustomerInventoryRequest) Coupons(coupons bool) apiGetCustomerInve return r } +func (r apiGetCustomerInventoryRequest) Loyalty(loyalty bool) apiGetCustomerInventoryRequest { + r.loyalty = &loyalty + return r +} + /* GetCustomerInventory Get an inventory of all data associated with a specific customer profile. Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information, referral codes and reserved coupons. In the future, this will be expanded with loyalty points. @@ -645,6 +651,9 @@ func (r apiGetCustomerInventoryRequest) Execute() (CustomerInventory, *_nethttp. if r.coupons != nil { localVarQueryParams.Add("coupons", parameterToString(*r.coupons, "")) } + if r.loyalty != nil { + localVarQueryParams.Add("loyalty", parameterToString(*r.loyalty, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -1053,7 +1062,9 @@ func (r apiUpdateCustomerProfileRequest) Dry(dry bool) apiUpdateCustomerProfileR } /* -UpdateCustomerProfile Update a Customer Profile +UpdateCustomerProfile Update a Customer Profile V1 +⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2). + Update (or create) a [Customer Profile][]. This profile information can then be matched and/or updated by campaign [Rules][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. @@ -1200,18 +1211,143 @@ func (r apiUpdateCustomerProfileRequest) Execute() (IntegrationState, *_nethttp. return localVarReturnValue, localVarHTTPResponse, nil } +type apiUpdateCustomerProfileAudiencesRequest struct { + ctx _context.Context + apiService *IntegrationApiService + body *CustomerProfileAudienceRequest +} + +func (r apiUpdateCustomerProfileAudiencesRequest) Body(body CustomerProfileAudienceRequest) apiUpdateCustomerProfileAudiencesRequest { + r.body = &body + return r +} + +/* +UpdateCustomerProfileAudiences Update a Customer Profile Audiences +Update one ore multiple Customer Profiles with the specified Audiences + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return apiUpdateCustomerProfileAudiencesRequest +*/ +func (a *IntegrationApiService) UpdateCustomerProfileAudiences(ctx _context.Context) apiUpdateCustomerProfileAudiencesRequest { + return apiUpdateCustomerProfileAudiencesRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + +*/ +func (r apiUpdateCustomerProfileAudiencesRequest) Execute() (*_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.UpdateCustomerProfileAudiences") + if err != nil { + return nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v2/customer_audiences" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return nil, reportError("body is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + type apiUpdateCustomerProfileV2Request struct { - ctx _context.Context - apiService *IntegrationApiService - customerProfileId string - body *NewCustomerProfile + ctx _context.Context + apiService *IntegrationApiService + integrationId string + body *CustomerProfileIntegrationRequestV2 + runRuleEngine *bool + dry *bool } -func (r apiUpdateCustomerProfileV2Request) Body(body NewCustomerProfile) apiUpdateCustomerProfileV2Request { +func (r apiUpdateCustomerProfileV2Request) Body(body CustomerProfileIntegrationRequestV2) apiUpdateCustomerProfileV2Request { r.body = &body return r } +func (r apiUpdateCustomerProfileV2Request) RunRuleEngine(runRuleEngine bool) apiUpdateCustomerProfileV2Request { + r.runRuleEngine = &runRuleEngine + return r +} + +func (r apiUpdateCustomerProfileV2Request) Dry(dry bool) apiUpdateCustomerProfileV2Request { + r.dry = &dry + return r +} + /* UpdateCustomerProfileV2 Update a Customer Profile Update (or create) a [Customer Profile][]. @@ -1221,29 +1357,29 @@ The `integrationId` may be any identifier that will remain stable for the custom [Customer Profile]: /Getting-Started/entities#customer-profile * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param customerProfileId The custom identifier for this profile, must be unique within the account. + * @param integrationId The custom identifier for this profile, must be unique within the account. @return apiUpdateCustomerProfileV2Request */ -func (a *IntegrationApiService) UpdateCustomerProfileV2(ctx _context.Context, customerProfileId string) apiUpdateCustomerProfileV2Request { +func (a *IntegrationApiService) UpdateCustomerProfileV2(ctx _context.Context, integrationId string) apiUpdateCustomerProfileV2Request { return apiUpdateCustomerProfileV2Request{ - apiService: a, - ctx: ctx, - customerProfileId: customerProfileId, + apiService: a, + ctx: ctx, + integrationId: integrationId, } } /* Execute executes the request - @return CustomerProfileUpdate + @return IntegrationStateV2 */ -func (r apiUpdateCustomerProfileV2Request) Execute() (CustomerProfileUpdate, *_nethttp.Response, error) { +func (r apiUpdateCustomerProfileV2Request) Execute() (IntegrationStateV2, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPut localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue CustomerProfileUpdate + localVarReturnValue IntegrationStateV2 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.UpdateCustomerProfileV2") @@ -1251,8 +1387,156 @@ func (r apiUpdateCustomerProfileV2Request) Execute() (CustomerProfileUpdate, *_n return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v2/customer_profiles/{customerProfileId}" - localVarPath = strings.Replace(localVarPath, "{"+"customerProfileId"+"}", _neturl.QueryEscape(parameterToString(r.customerProfileId, "")), -1) + localVarPath := localBasePath + "/v2/customer_profiles/{integrationId}" + localVarPath = strings.Replace(localVarPath, "{"+"integrationId"+"}", _neturl.QueryEscape(parameterToString(r.integrationId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + if r.runRuleEngine != nil { + localVarQueryParams.Add("runRuleEngine", parameterToString(*r.runRuleEngine, "")) + } + if r.dry != nil { + localVarQueryParams.Add("dry", parameterToString(*r.dry, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v IntegrationStateV2 + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiUpdateCustomerProfilesV2Request struct { + ctx _context.Context + apiService *IntegrationApiService + body *MultipleCustomerProfileIntegrationRequest + silent *string +} + +func (r apiUpdateCustomerProfilesV2Request) Body(body MultipleCustomerProfileIntegrationRequest) apiUpdateCustomerProfilesV2Request { + r.body = &body + return r +} + +func (r apiUpdateCustomerProfilesV2Request) Silent(silent string) apiUpdateCustomerProfilesV2Request { + r.silent = &silent + return r +} + +/* +UpdateCustomerProfilesV2 Update multiple Customer Profiles +Update (or create) up to 1000 [Customer Profiles][] in 1 request. + +The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. + +[Customer Profiles]: /Getting-Started/entities#customer-profile + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return apiUpdateCustomerProfilesV2Request +*/ +func (a *IntegrationApiService) UpdateCustomerProfilesV2(ctx _context.Context) apiUpdateCustomerProfilesV2Request { + return apiUpdateCustomerProfilesV2Request{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + @return MultipleCustomerProfileIntegrationResponseV2 +*/ +func (r apiUpdateCustomerProfilesV2Request) Execute() (MultipleCustomerProfileIntegrationResponseV2, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPut + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue MultipleCustomerProfileIntegrationResponseV2 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.UpdateCustomerProfilesV2") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v2/customer_profiles" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1262,6 +1546,9 @@ func (r apiUpdateCustomerProfileV2Request) Execute() (CustomerProfileUpdate, *_n return localVarReturnValue, nil, reportError("body is required and must be specified") } + if r.silent != nil { + localVarQueryParams.Add("silent", parameterToString(*r.silent, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{"application/json"} @@ -1317,7 +1604,7 @@ func (r apiUpdateCustomerProfileV2Request) Execute() (CustomerProfileUpdate, *_n error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v CustomerProfileUpdate + var v MultipleCustomerProfileIntegrationResponseV2 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -1359,7 +1646,9 @@ func (r apiUpdateCustomerSessionRequest) Dry(dry bool) apiUpdateCustomerSessionR } /* -UpdateCustomerSession Update a Customer Session +UpdateCustomerSession Update a Customer Session V1 +⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2). + Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. diff --git a/api_management.go b/api_management.go index 5aedf14b..c5455041 100644 --- a/api_management.go +++ b/api_management.go @@ -3500,9 +3500,33 @@ func (r apiGetApplicationCustomerRequest) Execute() (ApplicationCustomer, *_neth } type apiGetApplicationCustomersRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + integrationId *string + pageSize *int32 + skip *int32 + withTotalResultSize *bool +} + +func (r apiGetApplicationCustomersRequest) IntegrationId(integrationId string) apiGetApplicationCustomersRequest { + r.integrationId = &integrationId + return r +} + +func (r apiGetApplicationCustomersRequest) PageSize(pageSize int32) apiGetApplicationCustomersRequest { + r.pageSize = &pageSize + return r +} + +func (r apiGetApplicationCustomersRequest) Skip(skip int32) apiGetApplicationCustomersRequest { + r.skip = &skip + return r +} + +func (r apiGetApplicationCustomersRequest) WithTotalResultSize(withTotalResultSize bool) apiGetApplicationCustomersRequest { + r.withTotalResultSize = &withTotalResultSize + return r } /* @@ -3545,6 +3569,18 @@ func (r apiGetApplicationCustomersRequest) Execute() (InlineResponse20012, *_net localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} + if r.integrationId != nil { + localVarQueryParams.Add("integrationId", parameterToString(*r.integrationId, "")) + } + if r.pageSize != nil { + localVarQueryParams.Add("pageSize", parameterToString(*r.pageSize, "")) + } + if r.skip != nil { + localVarQueryParams.Add("skip", parameterToString(*r.skip, "")) + } + if r.withTotalResultSize != nil { + localVarQueryParams.Add("withTotalResultSize", parameterToString(*r.withTotalResultSize, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -4545,10 +4581,11 @@ type apiGetApplicationSessionsRequest struct { sort *string profile *string state *string + createdBefore *time.Time + createdAfter *time.Time coupon *string referral *string integrationId *string - customerId *string } func (r apiGetApplicationSessionsRequest) PageSize(pageSize int32) apiGetApplicationSessionsRequest { @@ -4576,6 +4613,16 @@ func (r apiGetApplicationSessionsRequest) State(state string) apiGetApplicationS return r } +func (r apiGetApplicationSessionsRequest) CreatedBefore(createdBefore time.Time) apiGetApplicationSessionsRequest { + r.createdBefore = &createdBefore + return r +} + +func (r apiGetApplicationSessionsRequest) CreatedAfter(createdAfter time.Time) apiGetApplicationSessionsRequest { + r.createdAfter = &createdAfter + return r +} + func (r apiGetApplicationSessionsRequest) Coupon(coupon string) apiGetApplicationSessionsRequest { r.coupon = &coupon return r @@ -4591,11 +4638,6 @@ func (r apiGetApplicationSessionsRequest) IntegrationId(integrationId string) ap return r } -func (r apiGetApplicationSessionsRequest) CustomerId(customerId string) apiGetApplicationSessionsRequest { - r.customerId = &customerId - return r -} - /* GetApplicationSessions List Application Sessions * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @@ -4651,6 +4693,12 @@ func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20016, *_neth if r.state != nil { localVarQueryParams.Add("state", parameterToString(*r.state, "")) } + if r.createdBefore != nil { + localVarQueryParams.Add("createdBefore", parameterToString(*r.createdBefore, "")) + } + if r.createdAfter != nil { + localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) + } if r.coupon != nil { localVarQueryParams.Add("coupon", parameterToString(*r.coupon, "")) } @@ -4660,9 +4708,6 @@ func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20016, *_neth if r.integrationId != nil { localVarQueryParams.Add("integrationId", parameterToString(*r.integrationId, "")) } - if r.customerId != nil { - localVarQueryParams.Add("customerId", parameterToString(*r.customerId, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -5612,17 +5657,18 @@ func (r apiGetCampaignByAttributesRequest) Execute() (InlineResponse2002, *_neth } type apiGetCampaignsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - pageSize *int32 - skip *int32 - sort *string - campaignState *string - name *string - tags *string - createdBefore *time.Time - createdAfter *time.Time + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + pageSize *int32 + skip *int32 + sort *string + campaignState *string + name *string + tags *string + createdBefore *time.Time + createdAfter *time.Time + campaignGroupId *int32 } func (r apiGetCampaignsRequest) PageSize(pageSize int32) apiGetCampaignsRequest { @@ -5665,6 +5711,11 @@ func (r apiGetCampaignsRequest) CreatedAfter(createdAfter time.Time) apiGetCampa return r } +func (r apiGetCampaignsRequest) CampaignGroupId(campaignGroupId int32) apiGetCampaignsRequest { + r.campaignGroupId = &campaignGroupId + return r +} + /* GetCampaigns List your Campaigns * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @@ -5729,6 +5780,9 @@ func (r apiGetCampaignsRequest) Execute() (InlineResponse2002, *_nethttp.Respons if r.createdAfter != nil { localVarQueryParams.Add("createdAfter", parameterToString(*r.createdAfter, "")) } + if r.campaignGroupId != nil { + localVarQueryParams.Add("campaignGroupId", parameterToString(*r.campaignGroupId, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -7741,25 +7795,22 @@ func (r apiGetCustomerAnalyticsRequest) Execute() (CustomerAnalytics, *_nethttp. } type apiGetCustomerProfileRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - customerId int32 + ctx _context.Context + apiService *ManagementApiService + customerId int32 } /* GetCustomerProfile Get Customer Profile * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param applicationId * @param customerId @return apiGetCustomerProfileRequest */ -func (a *ManagementApiService) GetCustomerProfile(ctx _context.Context, applicationId int32, customerId int32) apiGetCustomerProfileRequest { +func (a *ManagementApiService) GetCustomerProfile(ctx _context.Context, customerId int32) apiGetCustomerProfileRequest { return apiGetCustomerProfileRequest{ - apiService: a, - ctx: ctx, - applicationId: applicationId, - customerId: customerId, + apiService: a, + ctx: ctx, + customerId: customerId, } } @@ -7783,7 +7834,6 @@ func (r apiGetCustomerProfileRequest) Execute() (ApplicationCustomer, *_nethttp. } localVarPath := localBasePath + "/v1/customers/{customerId}" - localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarPath = strings.Replace(localVarPath, "{"+"customerId"+"}", _neturl.QueryEscape(parameterToString(r.customerId, "")), -1) localVarHeaderParams := make(map[string]string) @@ -9000,6 +9050,128 @@ func (r apiGetLoyaltyProgramsRequest) Execute() (InlineResponse2008, *_nethttp.R return localVarReturnValue, localVarHTTPResponse, nil } +type apiGetLoyaltyStatisticsRequest struct { + ctx _context.Context + apiService *ManagementApiService + programID string +} + +/* +GetLoyaltyStatistics Get loyalty program statistics by loyalty program ID + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param programID +@return apiGetLoyaltyStatisticsRequest +*/ +func (a *ManagementApiService) GetLoyaltyStatistics(ctx _context.Context, programID string) apiGetLoyaltyStatisticsRequest { + return apiGetLoyaltyStatisticsRequest{ + apiService: a, + ctx: ctx, + programID: programID, + } +} + +/* +Execute executes the request + @return LoyaltyStatistics +*/ +func (r apiGetLoyaltyStatisticsRequest) Execute() (LoyaltyStatistics, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue LoyaltyStatistics + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyStatistics") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{programID}/statistics" + localVarPath = strings.Replace(localVarPath, "{"+"programID"+"}", _neturl.QueryEscape(parameterToString(r.programID, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v LoyaltyStatistics + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + type apiGetReferralsRequest struct { ctx _context.Context apiService *ManagementApiService diff --git a/configuration.go b/configuration.go index 01a84f97..68864587 100644 --- a/configuration.go +++ b/configuration.go @@ -97,7 +97,7 @@ type Configuration struct { func NewConfiguration() *Configuration { cfg := &Configuration{ DefaultHeader: make(map[string]string), - UserAgent: "OpenAPI-Generator/2.1.1/go", + UserAgent: "OpenAPI-Generator/2.2.0/go", Debug: false, Servers: ServerConfigurations{ { diff --git a/docs/AccountAnalytics.md b/docs/AccountAnalytics.md index a430853d..419b0dcd 100644 --- a/docs/AccountAnalytics.md +++ b/docs/AccountAnalytics.md @@ -4,21 +4,24 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Applications** | Pointer to **int32** | Total Number of Applications inside the account | -**ActiveCampaigns** | Pointer to **int32** | Total Number of Active Applications inside the account | -**Campaigns** | Pointer to **int32** | Total Number of campaigns inside the account | -**Coupons** | Pointer to **int32** | Total Number of coupons inside the account | -**ActiveCoupons** | Pointer to **int32** | Total Number of active coupons inside the account | -**ExpiredCoupons** | Pointer to **int32** | Total Number of expired coupons inside the account | -**CustomAttributes** | Pointer to **int32** | Total Number of custom attributes inside the account | -**ReferralCodes** | Pointer to **int32** | Total Number of referral codes inside the account | -**ActiveReferralCodes** | Pointer to **int32** | Total Number of active referral codes inside the account | -**ExpiredReferralCodes** | Pointer to **int32** | Total Number of expired referral codes inside the account | -**Users** | Pointer to **int32** | Total Number of users inside the account | -**Roles** | Pointer to **int32** | Total Number of roles inside the account | -**Webhooks** | Pointer to **int32** | Total Number of webhooks inside the account | -**LoyaltyPrograms** | Pointer to **int32** | Total Number of loyalty programs inside the account | -**ActiveRules** | Pointer to **int32** | Total Number of active rules in the account | +**Applications** | Pointer to **int32** | Total number of applications in the account | +**LiveApplications** | Pointer to **int32** | Total number of live applications in the account | +**SandboxApplications** | Pointer to **int32** | Total number of sandbox applications in the account | +**Campaigns** | Pointer to **int32** | Total number of campaigns in the account | +**ActiveCampaigns** | Pointer to **int32** | Total number of active campaigns in the account | +**LiveActiveCampaigns** | Pointer to **int32** | Total number of active campaigns in live applications in the account | +**Coupons** | Pointer to **int32** | Total number of coupons in the account | +**ActiveCoupons** | Pointer to **int32** | Total number of active coupons in the account | +**ExpiredCoupons** | Pointer to **int32** | Total number of expired coupons in the account | +**ReferralCodes** | Pointer to **int32** | Total number of referral codes in the account | +**ActiveReferralCodes** | Pointer to **int32** | Total number of active referral codes in the account | +**ExpiredReferralCodes** | Pointer to **int32** | Total number of expired referral codes in the account | +**ActiveRules** | Pointer to **int32** | Total number of active rules in the account | +**Users** | Pointer to **int32** | Total number of users in the account | +**Roles** | Pointer to **int32** | Total number of roles in the account | +**CustomAttributes** | Pointer to **int32** | Total number of custom attributes in the account | +**Webhooks** | Pointer to **int32** | Total number of webhooks in the account | +**LoyaltyPrograms** | Pointer to **int32** | Total number of loyalty programs in the account | ## Methods @@ -47,30 +50,55 @@ HasApplications returns a boolean if a field has been set. SetApplications gets a reference to the given int32 and assigns it to the Applications field. -### GetActiveCampaigns +### GetLiveApplications -`func (o *AccountAnalytics) GetActiveCampaigns() int32` +`func (o *AccountAnalytics) GetLiveApplications() int32` -GetActiveCampaigns returns the ActiveCampaigns field if non-nil, zero value otherwise. +GetLiveApplications returns the LiveApplications field if non-nil, zero value otherwise. -### GetActiveCampaignsOk +### GetLiveApplicationsOk -`func (o *AccountAnalytics) GetActiveCampaignsOk() (int32, bool)` +`func (o *AccountAnalytics) GetLiveApplicationsOk() (int32, bool)` -GetActiveCampaignsOk returns a tuple with the ActiveCampaigns field if it's non-nil, zero value otherwise +GetLiveApplicationsOk returns a tuple with the LiveApplications field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasActiveCampaigns +### HasLiveApplications -`func (o *AccountAnalytics) HasActiveCampaigns() bool` +`func (o *AccountAnalytics) HasLiveApplications() bool` -HasActiveCampaigns returns a boolean if a field has been set. +HasLiveApplications returns a boolean if a field has been set. -### SetActiveCampaigns +### SetLiveApplications -`func (o *AccountAnalytics) SetActiveCampaigns(v int32)` +`func (o *AccountAnalytics) SetLiveApplications(v int32)` -SetActiveCampaigns gets a reference to the given int32 and assigns it to the ActiveCampaigns field. +SetLiveApplications gets a reference to the given int32 and assigns it to the LiveApplications field. + +### GetSandboxApplications + +`func (o *AccountAnalytics) GetSandboxApplications() int32` + +GetSandboxApplications returns the SandboxApplications field if non-nil, zero value otherwise. + +### GetSandboxApplicationsOk + +`func (o *AccountAnalytics) GetSandboxApplicationsOk() (int32, bool)` + +GetSandboxApplicationsOk returns a tuple with the SandboxApplications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSandboxApplications + +`func (o *AccountAnalytics) HasSandboxApplications() bool` + +HasSandboxApplications returns a boolean if a field has been set. + +### SetSandboxApplications + +`func (o *AccountAnalytics) SetSandboxApplications(v int32)` + +SetSandboxApplications gets a reference to the given int32 and assigns it to the SandboxApplications field. ### GetCampaigns @@ -97,6 +125,56 @@ HasCampaigns returns a boolean if a field has been set. SetCampaigns gets a reference to the given int32 and assigns it to the Campaigns field. +### GetActiveCampaigns + +`func (o *AccountAnalytics) GetActiveCampaigns() int32` + +GetActiveCampaigns returns the ActiveCampaigns field if non-nil, zero value otherwise. + +### GetActiveCampaignsOk + +`func (o *AccountAnalytics) GetActiveCampaignsOk() (int32, bool)` + +GetActiveCampaignsOk returns a tuple with the ActiveCampaigns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActiveCampaigns + +`func (o *AccountAnalytics) HasActiveCampaigns() bool` + +HasActiveCampaigns returns a boolean if a field has been set. + +### SetActiveCampaigns + +`func (o *AccountAnalytics) SetActiveCampaigns(v int32)` + +SetActiveCampaigns gets a reference to the given int32 and assigns it to the ActiveCampaigns field. + +### GetLiveActiveCampaigns + +`func (o *AccountAnalytics) GetLiveActiveCampaigns() int32` + +GetLiveActiveCampaigns returns the LiveActiveCampaigns field if non-nil, zero value otherwise. + +### GetLiveActiveCampaignsOk + +`func (o *AccountAnalytics) GetLiveActiveCampaignsOk() (int32, bool)` + +GetLiveActiveCampaignsOk returns a tuple with the LiveActiveCampaigns field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLiveActiveCampaigns + +`func (o *AccountAnalytics) HasLiveActiveCampaigns() bool` + +HasLiveActiveCampaigns returns a boolean if a field has been set. + +### SetLiveActiveCampaigns + +`func (o *AccountAnalytics) SetLiveActiveCampaigns(v int32)` + +SetLiveActiveCampaigns gets a reference to the given int32 and assigns it to the LiveActiveCampaigns field. + ### GetCoupons `func (o *AccountAnalytics) GetCoupons() int32` @@ -172,31 +250,6 @@ HasExpiredCoupons returns a boolean if a field has been set. SetExpiredCoupons gets a reference to the given int32 and assigns it to the ExpiredCoupons field. -### GetCustomAttributes - -`func (o *AccountAnalytics) GetCustomAttributes() int32` - -GetCustomAttributes returns the CustomAttributes field if non-nil, zero value otherwise. - -### GetCustomAttributesOk - -`func (o *AccountAnalytics) GetCustomAttributesOk() (int32, bool)` - -GetCustomAttributesOk returns a tuple with the CustomAttributes field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCustomAttributes - -`func (o *AccountAnalytics) HasCustomAttributes() bool` - -HasCustomAttributes returns a boolean if a field has been set. - -### SetCustomAttributes - -`func (o *AccountAnalytics) SetCustomAttributes(v int32)` - -SetCustomAttributes gets a reference to the given int32 and assigns it to the CustomAttributes field. - ### GetReferralCodes `func (o *AccountAnalytics) GetReferralCodes() int32` @@ -272,6 +325,31 @@ HasExpiredReferralCodes returns a boolean if a field has been set. SetExpiredReferralCodes gets a reference to the given int32 and assigns it to the ExpiredReferralCodes field. +### GetActiveRules + +`func (o *AccountAnalytics) GetActiveRules() int32` + +GetActiveRules returns the ActiveRules field if non-nil, zero value otherwise. + +### GetActiveRulesOk + +`func (o *AccountAnalytics) GetActiveRulesOk() (int32, bool)` + +GetActiveRulesOk returns a tuple with the ActiveRules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActiveRules + +`func (o *AccountAnalytics) HasActiveRules() bool` + +HasActiveRules returns a boolean if a field has been set. + +### SetActiveRules + +`func (o *AccountAnalytics) SetActiveRules(v int32)` + +SetActiveRules gets a reference to the given int32 and assigns it to the ActiveRules field. + ### GetUsers `func (o *AccountAnalytics) GetUsers() int32` @@ -322,6 +400,31 @@ HasRoles returns a boolean if a field has been set. SetRoles gets a reference to the given int32 and assigns it to the Roles field. +### GetCustomAttributes + +`func (o *AccountAnalytics) GetCustomAttributes() int32` + +GetCustomAttributes returns the CustomAttributes field if non-nil, zero value otherwise. + +### GetCustomAttributesOk + +`func (o *AccountAnalytics) GetCustomAttributesOk() (int32, bool)` + +GetCustomAttributesOk returns a tuple with the CustomAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCustomAttributes + +`func (o *AccountAnalytics) HasCustomAttributes() bool` + +HasCustomAttributes returns a boolean if a field has been set. + +### SetCustomAttributes + +`func (o *AccountAnalytics) SetCustomAttributes(v int32)` + +SetCustomAttributes gets a reference to the given int32 and assigns it to the CustomAttributes field. + ### GetWebhooks `func (o *AccountAnalytics) GetWebhooks() int32` @@ -372,31 +475,6 @@ HasLoyaltyPrograms returns a boolean if a field has been set. SetLoyaltyPrograms gets a reference to the given int32 and assigns it to the LoyaltyPrograms field. -### GetActiveRules - -`func (o *AccountAnalytics) GetActiveRules() int32` - -GetActiveRules returns the ActiveRules field if non-nil, zero value otherwise. - -### GetActiveRulesOk - -`func (o *AccountAnalytics) GetActiveRulesOk() (int32, bool)` - -GetActiveRulesOk returns a tuple with the ActiveRules field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasActiveRules - -`func (o *AccountAnalytics) HasActiveRules() bool` - -HasActiveRules returns a boolean if a field has been set. - -### SetActiveRules - -`func (o *AccountAnalytics) SetActiveRules(v int32)` - -SetActiveRules gets a reference to the given int32 and assigns it to the ActiveRules field. - [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AccountLimits.md b/docs/AccountLimits.md index 82a4cdd5..e9fc02ab 100644 --- a/docs/AccountLimits.md +++ b/docs/AccountLimits.md @@ -4,18 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**LiveApplications** | Pointer to **int32** | Total Number of allowed live applications in the account | -**SandboxApplications** | Pointer to **int32** | Total Number of allowed sandbox applications in the account | -**ActiveCampaigns** | Pointer to **int32** | Total Number of allowed active campaigns in the account | -**Coupons** | Pointer to **int32** | Total Number of allowed coupons in the account | -**ReferralCodes** | Pointer to **int32** | Total Number of allowed referral codes in the account | -**LiveLoyaltyPrograms** | Pointer to **int32** | Total Number of allowed live loyalty programs in the account | -**SandboxLoyaltyPrograms** | Pointer to **int32** | Total Number of allowed sandbox loyalty programs in the account | -**Webhooks** | Pointer to **int32** | Total Number of allowed webhooks in the account | -**Users** | Pointer to **int32** | Total Number of allowed users in the account | -**ApiVolume** | Pointer to **int32** | Total allowed api volume | -**ActiveRules** | Pointer to **int32** | Total allowed active rulesets | [optional] -**PromotionTypes** | Pointer to **[]string** | array of rulesets where webhook is used | +**LiveApplications** | Pointer to **int32** | Total number of allowed live applications in the account | +**SandboxApplications** | Pointer to **int32** | Total number of allowed sandbox applications in the account | +**ActiveCampaigns** | Pointer to **int32** | Total number of allowed active campaigns in live applications in the account | +**Coupons** | Pointer to **int32** | Total number of allowed coupons in the account | +**ReferralCodes** | Pointer to **int32** | Total number of allowed referral codes in the account | +**ActiveRules** | Pointer to **int32** | Total number of allowed active rulesets in the account | +**LiveLoyaltyPrograms** | Pointer to **int32** | Total number of allowed live loyalty programs in the account | +**SandboxLoyaltyPrograms** | Pointer to **int32** | Total number of allowed sandbox loyalty programs in the account | +**Webhooks** | Pointer to **int32** | Total number of allowed webhooks in the account | +**Users** | Pointer to **int32** | Total number of allowed users in the account | +**ApiVolume** | Pointer to **int32** | Allowed volume of API requests to the account | +**PromotionTypes** | Pointer to **[]string** | Array of promotion types that are employed in the account | ## Methods @@ -144,6 +144,31 @@ HasReferralCodes returns a boolean if a field has been set. SetReferralCodes gets a reference to the given int32 and assigns it to the ReferralCodes field. +### GetActiveRules + +`func (o *AccountLimits) GetActiveRules() int32` + +GetActiveRules returns the ActiveRules field if non-nil, zero value otherwise. + +### GetActiveRulesOk + +`func (o *AccountLimits) GetActiveRulesOk() (int32, bool)` + +GetActiveRulesOk returns a tuple with the ActiveRules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActiveRules + +`func (o *AccountLimits) HasActiveRules() bool` + +HasActiveRules returns a boolean if a field has been set. + +### SetActiveRules + +`func (o *AccountLimits) SetActiveRules(v int32)` + +SetActiveRules gets a reference to the given int32 and assigns it to the ActiveRules field. + ### GetLiveLoyaltyPrograms `func (o *AccountLimits) GetLiveLoyaltyPrograms() int32` @@ -269,31 +294,6 @@ HasApiVolume returns a boolean if a field has been set. SetApiVolume gets a reference to the given int32 and assigns it to the ApiVolume field. -### GetActiveRules - -`func (o *AccountLimits) GetActiveRules() int32` - -GetActiveRules returns the ActiveRules field if non-nil, zero value otherwise. - -### GetActiveRulesOk - -`func (o *AccountLimits) GetActiveRulesOk() (int32, bool)` - -GetActiveRulesOk returns a tuple with the ActiveRules field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasActiveRules - -`func (o *AccountLimits) HasActiveRules() bool` - -HasActiveRules returns a boolean if a field has been set. - -### SetActiveRules - -`func (o *AccountLimits) SetActiveRules(v int32)` - -SetActiveRules gets a reference to the given int32 and assigns it to the ActiveRules field. - ### GetPromotionTypes `func (o *AccountLimits) GetPromotionTypes() []string` diff --git a/docs/AddLoyaltyPointsEffectProps.md b/docs/AddLoyaltyPointsEffectProps.md index c588bc43..7a56d539 100644 --- a/docs/AddLoyaltyPointsEffectProps.md +++ b/docs/AddLoyaltyPointsEffectProps.md @@ -9,7 +9,8 @@ Name | Type | Description | Notes **SubLedgerId** | Pointer to **string** | The ID of the subledger within the loyalty program where these points were added | **Value** | Pointer to **float32** | The amount of points that were added | **RecipientIntegrationId** | Pointer to **string** | The user for whom these points were added | -**ExpiryCondition** | Pointer to **string** | The amount of time (in days) these points are valid | +**StartDate** | Pointer to [**time.Time**](time.Time.md) | Date after which points will be valid | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Date after which points will expire | [optional] ## Methods @@ -138,30 +139,55 @@ HasRecipientIntegrationId returns a boolean if a field has been set. SetRecipientIntegrationId gets a reference to the given string and assigns it to the RecipientIntegrationId field. -### GetExpiryCondition +### GetStartDate -`func (o *AddLoyaltyPointsEffectProps) GetExpiryCondition() string` +`func (o *AddLoyaltyPointsEffectProps) GetStartDate() time.Time` -GetExpiryCondition returns the ExpiryCondition field if non-nil, zero value otherwise. +GetStartDate returns the StartDate field if non-nil, zero value otherwise. -### GetExpiryConditionOk +### GetStartDateOk -`func (o *AddLoyaltyPointsEffectProps) GetExpiryConditionOk() (string, bool)` +`func (o *AddLoyaltyPointsEffectProps) GetStartDateOk() (time.Time, bool)` -GetExpiryConditionOk returns a tuple with the ExpiryCondition field if it's non-nil, zero value otherwise +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasExpiryCondition +### HasStartDate -`func (o *AddLoyaltyPointsEffectProps) HasExpiryCondition() bool` +`func (o *AddLoyaltyPointsEffectProps) HasStartDate() bool` -HasExpiryCondition returns a boolean if a field has been set. +HasStartDate returns a boolean if a field has been set. -### SetExpiryCondition +### SetStartDate -`func (o *AddLoyaltyPointsEffectProps) SetExpiryCondition(v string)` +`func (o *AddLoyaltyPointsEffectProps) SetStartDate(v time.Time)` -SetExpiryCondition gets a reference to the given string and assigns it to the ExpiryCondition field. +SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. + +### GetExpiryDate + +`func (o *AddLoyaltyPointsEffectProps) GetExpiryDate() time.Time` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *AddLoyaltyPointsEffectProps) GetExpiryDateOk() (time.Time, bool)` + +GetExpiryDateOk returns a tuple with the ExpiryDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiryDate + +`func (o *AddLoyaltyPointsEffectProps) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *AddLoyaltyPointsEffectProps) SetExpiryDate(v time.Time)` + +SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. [[Back to Model list]](../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 eb3bb0ef..475f66e8 100644 --- a/docs/Application.md +++ b/docs/Application.md @@ -15,8 +15,12 @@ Name | Type | Description | Notes **CaseSensitivity** | Pointer to **string** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional] **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign | [optional] **Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] -**CampaignPriority** | Pointer to **string** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive) | [optional] +**CampaignPriority** | Pointer to **string** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional] +**ExclusiveCampaignsStrategy** | Pointer to **string** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional] +**EnableCascadingDiscounts** | Pointer to **bool** | Flag indicating if discounts should cascade for this application | [optional] +**EnableFlattenedCartItems** | Pointer to **bool** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one | [optional] **AttributesSettings** | Pointer to [**AttributesSettings**](AttributesSettings.md) | | [optional] +**Sandbox** | Pointer to **bool** | Flag indicating if this is a live or sandbox application | [optional] **LoyaltyPrograms** | Pointer to [**[]LoyaltyProgram**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed | ## Methods @@ -321,6 +325,81 @@ HasCampaignPriority returns a boolean if a field has been set. SetCampaignPriority gets a reference to the given string and assigns it to the CampaignPriority field. +### GetExclusiveCampaignsStrategy + +`func (o *Application) GetExclusiveCampaignsStrategy() string` + +GetExclusiveCampaignsStrategy returns the ExclusiveCampaignsStrategy field if non-nil, zero value otherwise. + +### GetExclusiveCampaignsStrategyOk + +`func (o *Application) GetExclusiveCampaignsStrategyOk() (string, bool)` + +GetExclusiveCampaignsStrategyOk returns a tuple with the ExclusiveCampaignsStrategy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExclusiveCampaignsStrategy + +`func (o *Application) HasExclusiveCampaignsStrategy() bool` + +HasExclusiveCampaignsStrategy returns a boolean if a field has been set. + +### SetExclusiveCampaignsStrategy + +`func (o *Application) SetExclusiveCampaignsStrategy(v string)` + +SetExclusiveCampaignsStrategy gets a reference to the given string and assigns it to the ExclusiveCampaignsStrategy field. + +### GetEnableCascadingDiscounts + +`func (o *Application) GetEnableCascadingDiscounts() bool` + +GetEnableCascadingDiscounts returns the EnableCascadingDiscounts field if non-nil, zero value otherwise. + +### GetEnableCascadingDiscountsOk + +`func (o *Application) GetEnableCascadingDiscountsOk() (bool, bool)` + +GetEnableCascadingDiscountsOk returns a tuple with the EnableCascadingDiscounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnableCascadingDiscounts + +`func (o *Application) HasEnableCascadingDiscounts() bool` + +HasEnableCascadingDiscounts returns a boolean if a field has been set. + +### SetEnableCascadingDiscounts + +`func (o *Application) SetEnableCascadingDiscounts(v bool)` + +SetEnableCascadingDiscounts gets a reference to the given bool and assigns it to the EnableCascadingDiscounts field. + +### GetEnableFlattenedCartItems + +`func (o *Application) GetEnableFlattenedCartItems() bool` + +GetEnableFlattenedCartItems returns the EnableFlattenedCartItems field if non-nil, zero value otherwise. + +### GetEnableFlattenedCartItemsOk + +`func (o *Application) GetEnableFlattenedCartItemsOk() (bool, bool)` + +GetEnableFlattenedCartItemsOk returns a tuple with the EnableFlattenedCartItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnableFlattenedCartItems + +`func (o *Application) HasEnableFlattenedCartItems() bool` + +HasEnableFlattenedCartItems returns a boolean if a field has been set. + +### SetEnableFlattenedCartItems + +`func (o *Application) SetEnableFlattenedCartItems(v bool)` + +SetEnableFlattenedCartItems gets a reference to the given bool and assigns it to the EnableFlattenedCartItems field. + ### GetAttributesSettings `func (o *Application) GetAttributesSettings() AttributesSettings` @@ -346,6 +425,31 @@ HasAttributesSettings returns a boolean if a field has been set. SetAttributesSettings gets a reference to the given AttributesSettings and assigns it to the AttributesSettings field. +### GetSandbox + +`func (o *Application) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *Application) GetSandboxOk() (bool, bool)` + +GetSandboxOk returns a tuple with the Sandbox field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSandbox + +`func (o *Application) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *Application) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. + ### GetLoyaltyPrograms `func (o *Application) GetLoyaltyPrograms() []LoyaltyProgram` diff --git a/docs/ApplicationApiKey.md b/docs/ApplicationApiKey.md index fb313178..c9babc59 100644 --- a/docs/ApplicationApiKey.md +++ b/docs/ApplicationApiKey.md @@ -4,16 +4,92 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**Title** | Pointer to **string** | Title for API Key | +**Expires** | Pointer to [**time.Time**](time.Time.md) | The date the API key expired | +**Platform** | Pointer to **string** | Platform the API key is valid for. | [optional] **Id** | Pointer to **int32** | ID of the API Key | **CreatedBy** | Pointer to **int32** | ID of user who created | -**Title** | Pointer to **string** | Title for API Key | **AccountID** | Pointer to **int32** | ID of account the key is used for | **ApplicationID** | Pointer to **int32** | ID of application the key is used for | **Created** | Pointer to [**time.Time**](time.Time.md) | The date the API key was created | -**Expires** | Pointer to [**time.Time**](time.Time.md) | The date the API key expired | ## Methods +### GetTitle + +`func (o *ApplicationApiKey) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *ApplicationApiKey) GetTitleOk() (string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTitle + +`func (o *ApplicationApiKey) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitle + +`func (o *ApplicationApiKey) SetTitle(v string)` + +SetTitle gets a reference to the given string and assigns it to the Title field. + +### GetExpires + +`func (o *ApplicationApiKey) GetExpires() time.Time` + +GetExpires returns the Expires field if non-nil, zero value otherwise. + +### GetExpiresOk + +`func (o *ApplicationApiKey) GetExpiresOk() (time.Time, bool)` + +GetExpiresOk returns a tuple with the Expires field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpires + +`func (o *ApplicationApiKey) HasExpires() bool` + +HasExpires returns a boolean if a field has been set. + +### SetExpires + +`func (o *ApplicationApiKey) SetExpires(v time.Time)` + +SetExpires gets a reference to the given time.Time and assigns it to the Expires field. + +### GetPlatform + +`func (o *ApplicationApiKey) GetPlatform() string` + +GetPlatform returns the Platform field if non-nil, zero value otherwise. + +### GetPlatformOk + +`func (o *ApplicationApiKey) GetPlatformOk() (string, bool)` + +GetPlatformOk returns a tuple with the Platform field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPlatform + +`func (o *ApplicationApiKey) HasPlatform() bool` + +HasPlatform returns a boolean if a field has been set. + +### SetPlatform + +`func (o *ApplicationApiKey) SetPlatform(v string)` + +SetPlatform gets a reference to the given string and assigns it to the Platform field. + ### GetId `func (o *ApplicationApiKey) GetId() int32` @@ -64,31 +140,6 @@ HasCreatedBy returns a boolean if a field has been set. SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. -### GetTitle - -`func (o *ApplicationApiKey) GetTitle() string` - -GetTitle returns the Title field if non-nil, zero value otherwise. - -### GetTitleOk - -`func (o *ApplicationApiKey) GetTitleOk() (string, bool)` - -GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTitle - -`func (o *ApplicationApiKey) HasTitle() bool` - -HasTitle returns a boolean if a field has been set. - -### SetTitle - -`func (o *ApplicationApiKey) SetTitle(v string)` - -SetTitle gets a reference to the given string and assigns it to the Title field. - ### GetAccountID `func (o *ApplicationApiKey) GetAccountID() int32` @@ -164,31 +215,6 @@ HasCreated returns a boolean if a field has been set. SetCreated gets a reference to the given time.Time and assigns it to the Created field. -### GetExpires - -`func (o *ApplicationApiKey) GetExpires() time.Time` - -GetExpires returns the Expires field if non-nil, zero value otherwise. - -### GetExpiresOk - -`func (o *ApplicationApiKey) GetExpiresOk() (time.Time, bool)` - -GetExpiresOk returns a tuple with the Expires field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasExpires - -`func (o *ApplicationApiKey) HasExpires() bool` - -HasExpires returns a boolean if a field has been set. - -### SetExpires - -`func (o *ApplicationApiKey) SetExpires(v time.Time)` - -SetExpires gets a reference to the given time.Time and assigns it to the Expires field. - [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ApplicationCustomer.md b/docs/ApplicationCustomer.md index 5b17083f..d0e9029d 100644 --- a/docs/ApplicationCustomer.md +++ b/docs/ApplicationCustomer.md @@ -6,12 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | Pointer to **int32** | Unique ID for this entity. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. | -**IntegrationId** | Pointer to **string** | The ID used for this entity in the application system. The ID used for this entity in the application system. | +**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. The integration ID for this entity sent to and used in the Talon.One system. | **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | **AccountId** | Pointer to **int32** | The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. | **ClosedSessions** | Pointer to **int32** | The total amount of closed sessions by a customer. A closed session is a successful purchase. | **TotalSales** | Pointer to **float32** | Sum of all purchases made by this customer | **LoyaltyMemberships** | Pointer to [**[]LoyaltyMembership**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer | [optional] +**AudienceMemberships** | Pointer to [**[]AudienceMembership**](AudienceMembership.md) | A list of audiences the customer belongs to | [optional] **LastActivity** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent event received from this customer | ## Methods @@ -216,6 +217,31 @@ HasLoyaltyMemberships returns a boolean if a field has been set. SetLoyaltyMemberships gets a reference to the given []LoyaltyMembership and assigns it to the LoyaltyMemberships field. +### GetAudienceMemberships + +`func (o *ApplicationCustomer) GetAudienceMemberships() []AudienceMembership` + +GetAudienceMemberships returns the AudienceMemberships field if non-nil, zero value otherwise. + +### GetAudienceMembershipsOk + +`func (o *ApplicationCustomer) GetAudienceMembershipsOk() ([]AudienceMembership, bool)` + +GetAudienceMembershipsOk returns a tuple with the AudienceMemberships field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAudienceMemberships + +`func (o *ApplicationCustomer) HasAudienceMemberships() bool` + +HasAudienceMemberships returns a boolean if a field has been set. + +### SetAudienceMemberships + +`func (o *ApplicationCustomer) SetAudienceMemberships(v []AudienceMembership)` + +SetAudienceMemberships gets a reference to the given []AudienceMembership and assigns it to the AudienceMemberships field. + ### GetLastActivity `func (o *ApplicationCustomer) GetLastActivity() time.Time` diff --git a/docs/ApplicationSession.md b/docs/ApplicationSession.md index 739786e1..1d9715aa 100644 --- a/docs/ApplicationSession.md +++ b/docs/ApplicationSession.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. The exact moment this entity was created. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | **ProfileId** | Pointer to **int32** | The globally unique Talon.One ID of the customer that created this entity. | [optional] -**IntegrationId** | Pointer to **string** | The ID used for this entity in the application system. | +**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. | **Profileintegrationid** | Pointer to **string** | Integration ID of the customer for the session. | [optional] **Coupon** | Pointer to **string** | Any coupon code entered. | **Referral** | Pointer to **string** | Any referral code entered. | diff --git a/docs/Audience.md b/docs/Audience.md new file mode 100644 index 00000000..285be60b --- /dev/null +++ b/docs/Audience.md @@ -0,0 +1,169 @@ +# Audience + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | +**Id** | Pointer to **int32** | Unique ID for this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**Name** | Pointer to **string** | The human-friendly display name for this Audience. | +**Integration** | Pointer to **string** | Integration that this audience was created in. | +**IntegrationId** | Pointer to **string** | The ID of this Audience in the third-party integration | + +## Methods + +### GetAccountId + +`func (o *Audience) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *Audience) GetAccountIdOk() (int32, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAccountId + +`func (o *Audience) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *Audience) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetId + +`func (o *Audience) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Audience) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *Audience) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *Audience) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *Audience) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Audience) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *Audience) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *Audience) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetName + +`func (o *Audience) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Audience) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *Audience) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *Audience) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetIntegration + +`func (o *Audience) GetIntegration() string` + +GetIntegration returns the Integration field if non-nil, zero value otherwise. + +### GetIntegrationOk + +`func (o *Audience) GetIntegrationOk() (string, bool)` + +GetIntegrationOk returns a tuple with the Integration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIntegration + +`func (o *Audience) HasIntegration() bool` + +HasIntegration returns a boolean if a field has been set. + +### SetIntegration + +`func (o *Audience) SetIntegration(v string)` + +SetIntegration gets a reference to the given string and assigns it to the Integration field. + +### GetIntegrationId + +`func (o *Audience) GetIntegrationId() string` + +GetIntegrationId returns the IntegrationId field if non-nil, zero value otherwise. + +### GetIntegrationIdOk + +`func (o *Audience) GetIntegrationIdOk() (string, bool)` + +GetIntegrationIdOk returns a tuple with the IntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIntegrationId + +`func (o *Audience) HasIntegrationId() bool` + +HasIntegrationId returns a boolean if a field has been set. + +### SetIntegrationId + +`func (o *Audience) SetIntegrationId(v string)` + +SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AudienceMembership.md b/docs/AudienceMembership.md new file mode 100644 index 00000000..b6ba0248 --- /dev/null +++ b/docs/AudienceMembership.md @@ -0,0 +1,65 @@ +# AudienceMembership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | The ID of the audience belonging to this entity. | +**Name** | Pointer to **string** | The Name of the audience belonging to this entity. | + +## Methods + +### GetId + +`func (o *AudienceMembership) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AudienceMembership) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *AudienceMembership) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *AudienceMembership) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetName + +`func (o *AudienceMembership) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *AudienceMembership) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *AudienceMembership) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *AudienceMembership) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Campaign.md b/docs/Campaign.md index e6b514da..8cf369cf 100644 --- a/docs/Campaign.md +++ b/docs/Campaign.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of limits that will operate for this campaign | +**CampaignGroups** | Pointer to **[]int32** | The IDs of the campaign groups that own this entity. | [optional] **CouponRedemptionCount** | Pointer to **int32** | Number of coupons redeemed in the campaign. | [optional] **ReferralRedemptionCount** | Pointer to **int32** | Number of referral codes redeemed in the campaign. | [optional] **DiscountCount** | Pointer to **int32** | Total amount of discounts redeemed in the campaign. | [optional] @@ -432,6 +433,31 @@ HasLimits returns a boolean if a field has been set. SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. +### GetCampaignGroups + +`func (o *Campaign) GetCampaignGroups() []int32` + +GetCampaignGroups returns the CampaignGroups field if non-nil, zero value otherwise. + +### GetCampaignGroupsOk + +`func (o *Campaign) GetCampaignGroupsOk() ([]int32, bool)` + +GetCampaignGroupsOk returns a tuple with the CampaignGroups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignGroups + +`func (o *Campaign) HasCampaignGroups() bool` + +HasCampaignGroups returns a boolean if a field has been set. + +### SetCampaignGroups + +`func (o *Campaign) SetCampaignGroups(v []int32)` + +SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. + ### GetCouponRedemptionCount `func (o *Campaign) GetCouponRedemptionCount() int32` diff --git a/docs/CampaignAnalytics.md b/docs/CampaignAnalytics.md index 444f4068..f7cd55d2 100644 --- a/docs/CampaignAnalytics.md +++ b/docs/CampaignAnalytics.md @@ -25,6 +25,10 @@ Name | Type | Description | Notes **TotalCouponsCreated** | Pointer to **int32** | Number of coupons created in the campaign by the rule engine since it began. | **ReferralsCreated** | Pointer to **int32** | Number of referrals created in the campaign by the rule engine. | **TotalReferralsCreated** | Pointer to **int32** | Number of referrals created in the campaign by the rule engine since it began. | +**AddedLoyaltyPoints** | Pointer to **float32** | Number of added loyalty points in the campaign in a specific interval. | +**TotalAddedLoyaltyPoints** | Pointer to **float32** | Number of added loyalty points in the campaign since it began. | +**DeductedLoyaltyPoints** | Pointer to **float32** | Number of deducted loyalty points in the campaign in a specific interval. | +**TotalDeductedLoyaltyPoints** | Pointer to **float32** | Number of deducted loyalty points in the campaign since it began. | ## Methods @@ -553,6 +557,106 @@ HasTotalReferralsCreated returns a boolean if a field has been set. SetTotalReferralsCreated gets a reference to the given int32 and assigns it to the TotalReferralsCreated field. +### GetAddedLoyaltyPoints + +`func (o *CampaignAnalytics) GetAddedLoyaltyPoints() float32` + +GetAddedLoyaltyPoints returns the AddedLoyaltyPoints field if non-nil, zero value otherwise. + +### GetAddedLoyaltyPointsOk + +`func (o *CampaignAnalytics) GetAddedLoyaltyPointsOk() (float32, bool)` + +GetAddedLoyaltyPointsOk returns a tuple with the AddedLoyaltyPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAddedLoyaltyPoints + +`func (o *CampaignAnalytics) HasAddedLoyaltyPoints() bool` + +HasAddedLoyaltyPoints returns a boolean if a field has been set. + +### SetAddedLoyaltyPoints + +`func (o *CampaignAnalytics) SetAddedLoyaltyPoints(v float32)` + +SetAddedLoyaltyPoints gets a reference to the given float32 and assigns it to the AddedLoyaltyPoints field. + +### GetTotalAddedLoyaltyPoints + +`func (o *CampaignAnalytics) GetTotalAddedLoyaltyPoints() float32` + +GetTotalAddedLoyaltyPoints returns the TotalAddedLoyaltyPoints field if non-nil, zero value otherwise. + +### GetTotalAddedLoyaltyPointsOk + +`func (o *CampaignAnalytics) GetTotalAddedLoyaltyPointsOk() (float32, bool)` + +GetTotalAddedLoyaltyPointsOk returns a tuple with the TotalAddedLoyaltyPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalAddedLoyaltyPoints + +`func (o *CampaignAnalytics) HasTotalAddedLoyaltyPoints() bool` + +HasTotalAddedLoyaltyPoints returns a boolean if a field has been set. + +### SetTotalAddedLoyaltyPoints + +`func (o *CampaignAnalytics) SetTotalAddedLoyaltyPoints(v float32)` + +SetTotalAddedLoyaltyPoints gets a reference to the given float32 and assigns it to the TotalAddedLoyaltyPoints field. + +### GetDeductedLoyaltyPoints + +`func (o *CampaignAnalytics) GetDeductedLoyaltyPoints() float32` + +GetDeductedLoyaltyPoints returns the DeductedLoyaltyPoints field if non-nil, zero value otherwise. + +### GetDeductedLoyaltyPointsOk + +`func (o *CampaignAnalytics) GetDeductedLoyaltyPointsOk() (float32, bool)` + +GetDeductedLoyaltyPointsOk returns a tuple with the DeductedLoyaltyPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDeductedLoyaltyPoints + +`func (o *CampaignAnalytics) HasDeductedLoyaltyPoints() bool` + +HasDeductedLoyaltyPoints returns a boolean if a field has been set. + +### SetDeductedLoyaltyPoints + +`func (o *CampaignAnalytics) SetDeductedLoyaltyPoints(v float32)` + +SetDeductedLoyaltyPoints gets a reference to the given float32 and assigns it to the DeductedLoyaltyPoints field. + +### GetTotalDeductedLoyaltyPoints + +`func (o *CampaignAnalytics) GetTotalDeductedLoyaltyPoints() float32` + +GetTotalDeductedLoyaltyPoints returns the TotalDeductedLoyaltyPoints field if non-nil, zero value otherwise. + +### GetTotalDeductedLoyaltyPointsOk + +`func (o *CampaignAnalytics) GetTotalDeductedLoyaltyPointsOk() (float32, bool)` + +GetTotalDeductedLoyaltyPointsOk returns a tuple with the TotalDeductedLoyaltyPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalDeductedLoyaltyPoints + +`func (o *CampaignAnalytics) HasTotalDeductedLoyaltyPoints() bool` + +HasTotalDeductedLoyaltyPoints returns a boolean if a field has been set. + +### SetTotalDeductedLoyaltyPoints + +`func (o *CampaignAnalytics) SetTotalDeductedLoyaltyPoints(v float32)` + +SetTotalDeductedLoyaltyPoints gets a reference to the given float32 and assigns it to the TotalDeductedLoyaltyPoints field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CampaignCopy.md b/docs/CampaignCopy.md index b981d6da..d2f3cf70 100644 --- a/docs/CampaignCopy.md +++ b/docs/CampaignCopy.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | Name of the copied campaign (Defaults to \"Copy of original campaign name\") | [optional] -**ApplicationIds** | Pointer to **[]string** | Application IDs of the applications to which a campaign should be copied to | +**ApplicationIds** | Pointer to **[]int32** | Application IDs of the applications to which a campaign should be copied to | **Description** | Pointer to **string** | A detailed description of the campaign. | [optional] **StartTime** | Pointer to [**time.Time**](time.Time.md) | Datetime when the campaign will become active. | [optional] **EndTime** | Pointer to [**time.Time**](time.Time.md) | Datetime when the campaign will become in-active. | [optional] @@ -40,13 +40,13 @@ SetName gets a reference to the given string and assigns it to the Name field. ### GetApplicationIds -`func (o *CampaignCopy) GetApplicationIds() []string` +`func (o *CampaignCopy) GetApplicationIds() []int32` GetApplicationIds returns the ApplicationIds field if non-nil, zero value otherwise. ### GetApplicationIdsOk -`func (o *CampaignCopy) GetApplicationIdsOk() ([]string, bool)` +`func (o *CampaignCopy) GetApplicationIdsOk() ([]int32, bool)` GetApplicationIdsOk returns a tuple with the ApplicationIds field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -59,9 +59,9 @@ HasApplicationIds returns a boolean if a field has been set. ### SetApplicationIds -`func (o *CampaignCopy) SetApplicationIds(v []string)` +`func (o *CampaignCopy) SetApplicationIds(v []int32)` -SetApplicationIds gets a reference to the given []string and assigns it to the ApplicationIds field. +SetApplicationIds gets a reference to the given []int32 and assigns it to the ApplicationIds field. ### GetDescription diff --git a/docs/CampaignGroup.md b/docs/CampaignGroup.md new file mode 100644 index 00000000..4cd65056 --- /dev/null +++ b/docs/CampaignGroup.md @@ -0,0 +1,221 @@ +# CampaignGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | +**AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | +**Name** | Pointer to **string** | The name of this campaign group. | +**Description** | Pointer to **string** | A longer description of the campaign group. | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this campaign group is enabled for | [optional] +**CampaignIds** | Pointer to **[]int32** | A list of the IDs of the campaigns that this campaign group owns | [optional] + +## Methods + +### GetId + +`func (o *CampaignGroup) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignGroup) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *CampaignGroup) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *CampaignGroup) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *CampaignGroup) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignGroup) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *CampaignGroup) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *CampaignGroup) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetModified + +`func (o *CampaignGroup) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CampaignGroup) GetModifiedOk() (time.Time, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModified + +`func (o *CampaignGroup) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *CampaignGroup) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + +### GetAccountId + +`func (o *CampaignGroup) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *CampaignGroup) GetAccountIdOk() (int32, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAccountId + +`func (o *CampaignGroup) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *CampaignGroup) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetName + +`func (o *CampaignGroup) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CampaignGroup) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *CampaignGroup) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *CampaignGroup) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *CampaignGroup) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CampaignGroup) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *CampaignGroup) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *CampaignGroup) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetSubscribedApplicationsIds + +`func (o *CampaignGroup) GetSubscribedApplicationsIds() []int32` + +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. + +### GetSubscribedApplicationsIdsOk + +`func (o *CampaignGroup) GetSubscribedApplicationsIdsOk() ([]int32, bool)` + +GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubscribedApplicationsIds + +`func (o *CampaignGroup) HasSubscribedApplicationsIds() bool` + +HasSubscribedApplicationsIds returns a boolean if a field has been set. + +### SetSubscribedApplicationsIds + +`func (o *CampaignGroup) SetSubscribedApplicationsIds(v []int32)` + +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. + +### GetCampaignIds + +`func (o *CampaignGroup) GetCampaignIds() []int32` + +GetCampaignIds returns the CampaignIds field if non-nil, zero value otherwise. + +### GetCampaignIdsOk + +`func (o *CampaignGroup) GetCampaignIdsOk() ([]int32, bool)` + +GetCampaignIdsOk returns a tuple with the CampaignIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignIds + +`func (o *CampaignGroup) HasCampaignIds() bool` + +HasCampaignIds returns a boolean if a field has been set. + +### SetCampaignIds + +`func (o *CampaignGroup) SetCampaignIds(v []int32)` + +SetCampaignIds gets a reference to the given []int32 and assigns it to the CampaignIds field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CampaignGroupEntity.md b/docs/CampaignGroupEntity.md new file mode 100644 index 00000000..fb44e847 --- /dev/null +++ b/docs/CampaignGroupEntity.md @@ -0,0 +1,39 @@ +# CampaignGroupEntity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CampaignGroups** | Pointer to **[]int32** | The IDs of the campaign groups that own this entity. | [optional] + +## Methods + +### GetCampaignGroups + +`func (o *CampaignGroupEntity) GetCampaignGroups() []int32` + +GetCampaignGroups returns the CampaignGroups field if non-nil, zero value otherwise. + +### GetCampaignGroupsOk + +`func (o *CampaignGroupEntity) GetCampaignGroupsOk() ([]int32, bool)` + +GetCampaignGroupsOk returns a tuple with the CampaignGroups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignGroups + +`func (o *CampaignGroupEntity) HasCampaignGroups() bool` + +HasCampaignGroups returns a boolean if a field has been set. + +### SetCampaignGroups + +`func (o *CampaignGroupEntity) SetCampaignGroups(v []int32)` + +SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateApplicationApiKey.md b/docs/CreateApplicationApiKey.md index b16429c0..28c8a792 100644 --- a/docs/CreateApplicationApiKey.md +++ b/docs/CreateApplicationApiKey.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Title** | Pointer to **string** | Title for API Key | **Expires** | Pointer to [**time.Time**](time.Time.md) | The date the API key expired | +**Platform** | Pointer to **string** | Platform the API key is valid for. | [optional] ## Methods @@ -59,6 +60,31 @@ HasExpires returns a boolean if a field has been set. SetExpires gets a reference to the given time.Time and assigns it to the Expires field. +### GetPlatform + +`func (o *CreateApplicationApiKey) GetPlatform() string` + +GetPlatform returns the Platform field if non-nil, zero value otherwise. + +### GetPlatformOk + +`func (o *CreateApplicationApiKey) GetPlatformOk() (string, bool)` + +GetPlatformOk returns a tuple with the Platform field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPlatform + +`func (o *CreateApplicationApiKey) HasPlatform() bool` + +HasPlatform returns a boolean if a field has been set. + +### SetPlatform + +`func (o *CreateApplicationApiKey) SetPlatform(v string)` + +SetPlatform gets a reference to the given string and assigns it to the Platform field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CustomerActivityReport.md b/docs/CustomerActivityReport.md index f0af57d4..7bc66f6a 100644 --- a/docs/CustomerActivityReport.md +++ b/docs/CustomerActivityReport.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IntegrationId** | Pointer to **string** | The ID used for this entity in the application system. | +**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **Name** | Pointer to **string** | The name for this customer profile. | **CustomerId** | Pointer to **int32** | The internal Talon.One ID of the customer. | diff --git a/docs/CustomerInventory.md b/docs/CustomerInventory.md index 607cd96b..26b80e4d 100644 --- a/docs/CustomerInventory.md +++ b/docs/CustomerInventory.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Profile** | Pointer to [**CustomerProfile**](CustomerProfile.md) | | [optional] +**Loyalty** | Pointer to [**Loyalty**](Loyalty.md) | | [optional] **Referrals** | Pointer to [**[]Referral**](Referral.md) | | [optional] **Coupons** | Pointer to [**[]Coupon**](Coupon.md) | | [optional] @@ -35,6 +36,31 @@ HasProfile returns a boolean if a field has been set. SetProfile gets a reference to the given CustomerProfile and assigns it to the Profile field. +### GetLoyalty + +`func (o *CustomerInventory) GetLoyalty() Loyalty` + +GetLoyalty returns the Loyalty field if non-nil, zero value otherwise. + +### GetLoyaltyOk + +`func (o *CustomerInventory) GetLoyaltyOk() (Loyalty, bool)` + +GetLoyaltyOk returns a tuple with the Loyalty field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLoyalty + +`func (o *CustomerInventory) HasLoyalty() bool` + +HasLoyalty returns a boolean if a field has been set. + +### SetLoyalty + +`func (o *CustomerInventory) SetLoyalty(v Loyalty)` + +SetLoyalty gets a reference to the given Loyalty and assigns it to the Loyalty field. + ### GetReferrals `func (o *CustomerInventory) GetReferrals() []Referral` diff --git a/docs/CustomerProfile.md b/docs/CustomerProfile.md index 906bcec1..dd593eca 100644 --- a/docs/CustomerProfile.md +++ b/docs/CustomerProfile.md @@ -4,13 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IntegrationId** | Pointer to **string** | The ID used for this entity in the application system. | +**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | **AccountId** | Pointer to **int32** | The ID of the Talon.One account that owns this profile. | **ClosedSessions** | Pointer to **int32** | The total amount of closed sessions by a customer. A closed session is a successful purchase. | **TotalSales** | Pointer to **float32** | Sum of all purchases made by this customer | **LoyaltyMemberships** | Pointer to [**[]LoyaltyMembership**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer | [optional] +**AudienceMemberships** | Pointer to [**[]AudienceMembership**](AudienceMembership.md) | A list of audiences the customer belongs to | [optional] **LastActivity** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent event received from this customer | ## Methods @@ -190,6 +191,31 @@ HasLoyaltyMemberships returns a boolean if a field has been set. SetLoyaltyMemberships gets a reference to the given []LoyaltyMembership and assigns it to the LoyaltyMemberships field. +### GetAudienceMemberships + +`func (o *CustomerProfile) GetAudienceMemberships() []AudienceMembership` + +GetAudienceMemberships returns the AudienceMemberships field if non-nil, zero value otherwise. + +### GetAudienceMembershipsOk + +`func (o *CustomerProfile) GetAudienceMembershipsOk() ([]AudienceMembership, bool)` + +GetAudienceMembershipsOk returns a tuple with the AudienceMemberships field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAudienceMemberships + +`func (o *CustomerProfile) HasAudienceMemberships() bool` + +HasAudienceMemberships returns a boolean if a field has been set. + +### SetAudienceMemberships + +`func (o *CustomerProfile) SetAudienceMemberships(v []AudienceMembership)` + +SetAudienceMemberships gets a reference to the given []AudienceMembership and assigns it to the AudienceMemberships field. + ### GetLastActivity `func (o *CustomerProfile) GetLastActivity() time.Time` diff --git a/docs/CustomerProfileAudienceRequest.md b/docs/CustomerProfileAudienceRequest.md new file mode 100644 index 00000000..d3fda596 --- /dev/null +++ b/docs/CustomerProfileAudienceRequest.md @@ -0,0 +1,39 @@ +# CustomerProfileAudienceRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | Pointer to [**[]CustomerProfileAudienceRequestItem**](CustomerProfileAudienceRequestItem.md) | | [optional] + +## Methods + +### GetData + +`func (o *CustomerProfileAudienceRequest) GetData() []CustomerProfileAudienceRequestItem` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *CustomerProfileAudienceRequest) GetDataOk() ([]CustomerProfileAudienceRequestItem, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasData + +`func (o *CustomerProfileAudienceRequest) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *CustomerProfileAudienceRequest) SetData(v []CustomerProfileAudienceRequestItem)` + +SetData gets a reference to the given []CustomerProfileAudienceRequestItem and assigns it to the Data field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CustomerProfileAudienceRequestItem.md b/docs/CustomerProfileAudienceRequestItem.md new file mode 100644 index 00000000..35375ea2 --- /dev/null +++ b/docs/CustomerProfileAudienceRequestItem.md @@ -0,0 +1,91 @@ +# CustomerProfileAudienceRequestItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Action** | Pointer to **string** | | +**ProfileIntegrationId** | Pointer to **string** | | +**AudienceId** | Pointer to **int32** | | + +## Methods + +### GetAction + +`func (o *CustomerProfileAudienceRequestItem) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *CustomerProfileAudienceRequestItem) GetActionOk() (string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAction + +`func (o *CustomerProfileAudienceRequestItem) HasAction() bool` + +HasAction returns a boolean if a field has been set. + +### SetAction + +`func (o *CustomerProfileAudienceRequestItem) SetAction(v string)` + +SetAction gets a reference to the given string and assigns it to the Action field. + +### GetProfileIntegrationId + +`func (o *CustomerProfileAudienceRequestItem) GetProfileIntegrationId() string` + +GetProfileIntegrationId returns the ProfileIntegrationId field if non-nil, zero value otherwise. + +### GetProfileIntegrationIdOk + +`func (o *CustomerProfileAudienceRequestItem) GetProfileIntegrationIdOk() (string, bool)` + +GetProfileIntegrationIdOk returns a tuple with the ProfileIntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProfileIntegrationId + +`func (o *CustomerProfileAudienceRequestItem) HasProfileIntegrationId() bool` + +HasProfileIntegrationId returns a boolean if a field has been set. + +### SetProfileIntegrationId + +`func (o *CustomerProfileAudienceRequestItem) SetProfileIntegrationId(v string)` + +SetProfileIntegrationId gets a reference to the given string and assigns it to the ProfileIntegrationId field. + +### GetAudienceId + +`func (o *CustomerProfileAudienceRequestItem) GetAudienceId() int32` + +GetAudienceId returns the AudienceId field if non-nil, zero value otherwise. + +### GetAudienceIdOk + +`func (o *CustomerProfileAudienceRequestItem) GetAudienceIdOk() (int32, bool)` + +GetAudienceIdOk returns a tuple with the AudienceId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAudienceId + +`func (o *CustomerProfileAudienceRequestItem) HasAudienceId() bool` + +HasAudienceId returns a boolean if a field has been set. + +### SetAudienceId + +`func (o *CustomerProfileAudienceRequestItem) SetAudienceId(v int32)` + +SetAudienceId gets a reference to the given int32 and assigns it to the AudienceId field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CustomerProfileIntegrationRequestV2.md b/docs/CustomerProfileIntegrationRequestV2.md new file mode 100644 index 00000000..37b91722 --- /dev/null +++ b/docs/CustomerProfileIntegrationRequestV2.md @@ -0,0 +1,65 @@ +# CustomerProfileIntegrationRequestV2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] +**ResponseContent** | Pointer to **[]string** | Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\" and \"event\". | [optional] + +## Methods + +### GetAttributes + +`func (o *CustomerProfileIntegrationRequestV2) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *CustomerProfileIntegrationRequestV2) GetAttributesOk() (map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *CustomerProfileIntegrationRequestV2) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *CustomerProfileIntegrationRequestV2) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + +### GetResponseContent + +`func (o *CustomerProfileIntegrationRequestV2) GetResponseContent() []string` + +GetResponseContent returns the ResponseContent field if non-nil, zero value otherwise. + +### GetResponseContentOk + +`func (o *CustomerProfileIntegrationRequestV2) GetResponseContentOk() ([]string, bool)` + +GetResponseContentOk returns a tuple with the ResponseContent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasResponseContent + +`func (o *CustomerProfileIntegrationRequestV2) HasResponseContent() bool` + +HasResponseContent returns a boolean if a field has been set. + +### SetResponseContent + +`func (o *CustomerProfileIntegrationRequestV2) SetResponseContent(v []string)` + +SetResponseContent gets a reference to the given []string and assigns it to the ResponseContent field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CustomerProfileUpdate.md b/docs/CustomerProfileUpdate.md deleted file mode 100644 index 54fbf619..00000000 --- a/docs/CustomerProfileUpdate.md +++ /dev/null @@ -1,39 +0,0 @@ -# CustomerProfileUpdate - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CustomerProfile** | Pointer to [**CustomerProfile**](CustomerProfile.md) | | - -## Methods - -### GetCustomerProfile - -`func (o *CustomerProfileUpdate) GetCustomerProfile() CustomerProfile` - -GetCustomerProfile returns the CustomerProfile field if non-nil, zero value otherwise. - -### GetCustomerProfileOk - -`func (o *CustomerProfileUpdate) GetCustomerProfileOk() (CustomerProfile, bool)` - -GetCustomerProfileOk returns a tuple with the CustomerProfile field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCustomerProfile - -`func (o *CustomerProfileUpdate) HasCustomerProfile() bool` - -HasCustomerProfile returns a boolean if a field has been set. - -### SetCustomerProfile - -`func (o *CustomerProfileUpdate) SetCustomerProfile(v CustomerProfile)` - -SetCustomerProfile gets a reference to the given CustomerProfile and assigns it to the CustomerProfile field. - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CustomerSession.md b/docs/CustomerSession.md index 3c60a80d..03b76bea 100644 --- a/docs/CustomerSession.md +++ b/docs/CustomerSession.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IntegrationId** | Pointer to **string** | The ID used for this entity in the application system. | +**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | **ProfileId** | Pointer to **string** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | diff --git a/docs/CustomerSessionV2.md b/docs/CustomerSessionV2.md index 38d6fc19..8e410240 100644 --- a/docs/CustomerSessionV2.md +++ b/docs/CustomerSessionV2.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IntegrationId** | Pointer to **string** | The ID used for this entity in the application system. | +**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | **ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | **ProfileId** | Pointer to **string** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | diff --git a/docs/EntityWithTalangVisibleId.md b/docs/EntityWithTalangVisibleId.md new file mode 100644 index 00000000..73dccc50 --- /dev/null +++ b/docs/EntityWithTalangVisibleId.md @@ -0,0 +1,65 @@ +# EntityWithTalangVisibleId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Unique ID for this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | + +## Methods + +### GetId + +`func (o *EntityWithTalangVisibleId) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EntityWithTalangVisibleId) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *EntityWithTalangVisibleId) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *EntityWithTalangVisibleId) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *EntityWithTalangVisibleId) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *EntityWithTalangVisibleId) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *EntityWithTalangVisibleId) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *EntityWithTalangVisibleId) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/FeedNotification.md b/docs/FeedNotification.md new file mode 100644 index 00000000..1dbf863a --- /dev/null +++ b/docs/FeedNotification.md @@ -0,0 +1,169 @@ +# FeedNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Title** | Pointer to **string** | Title of the feed notification | +**Created** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the moment this feed notification was created | +**Updated** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the moment this feed notification was last updated | +**ArticleUrl** | Pointer to **string** | URL to the feed notification in the help center | +**Type** | Pointer to **string** | The type of the feed notification | +**Body** | Pointer to **string** | Body of the feed notification | + +## Methods + +### GetTitle + +`func (o *FeedNotification) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *FeedNotification) GetTitleOk() (string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTitle + +`func (o *FeedNotification) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitle + +`func (o *FeedNotification) SetTitle(v string)` + +SetTitle gets a reference to the given string and assigns it to the Title field. + +### GetCreated + +`func (o *FeedNotification) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *FeedNotification) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *FeedNotification) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *FeedNotification) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetUpdated + +`func (o *FeedNotification) GetUpdated() time.Time` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *FeedNotification) GetUpdatedOk() (time.Time, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUpdated + +`func (o *FeedNotification) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + +### SetUpdated + +`func (o *FeedNotification) SetUpdated(v time.Time)` + +SetUpdated gets a reference to the given time.Time and assigns it to the Updated field. + +### GetArticleUrl + +`func (o *FeedNotification) GetArticleUrl() string` + +GetArticleUrl returns the ArticleUrl field if non-nil, zero value otherwise. + +### GetArticleUrlOk + +`func (o *FeedNotification) GetArticleUrlOk() (string, bool)` + +GetArticleUrlOk returns a tuple with the ArticleUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasArticleUrl + +`func (o *FeedNotification) HasArticleUrl() bool` + +HasArticleUrl returns a boolean if a field has been set. + +### SetArticleUrl + +`func (o *FeedNotification) SetArticleUrl(v string)` + +SetArticleUrl gets a reference to the given string and assigns it to the ArticleUrl field. + +### GetType + +`func (o *FeedNotification) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *FeedNotification) GetTypeOk() (string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasType + +`func (o *FeedNotification) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *FeedNotification) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetBody + +`func (o *FeedNotification) GetBody() string` + +GetBody returns the Body field if non-nil, zero value otherwise. + +### GetBodyOk + +`func (o *FeedNotification) GetBodyOk() (string, bool)` + +GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBody + +`func (o *FeedNotification) HasBody() bool` + +HasBody returns a boolean if a field has been set. + +### SetBody + +`func (o *FeedNotification) SetBody(v string)` + +SetBody gets a reference to the given string and assigns it to the Body field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse20012.md b/docs/InlineResponse20012.md index 7360503c..78f24f53 100644 --- a/docs/InlineResponse20012.md +++ b/docs/InlineResponse20012.md @@ -4,7 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | +**TotalResultSize** | Pointer to **int32** | | [optional] +**HasMore** | Pointer to **bool** | | [optional] **Data** | Pointer to [**[]ApplicationCustomer**](ApplicationCustomer.md) | | ## Methods @@ -34,6 +35,31 @@ HasTotalResultSize returns a boolean if a field has been set. SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +### GetHasMore + +`func (o *InlineResponse20012) GetHasMore() bool` + +GetHasMore returns the HasMore field if non-nil, zero value otherwise. + +### GetHasMoreOk + +`func (o *InlineResponse20012) GetHasMoreOk() (bool, bool)` + +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasHasMore + +`func (o *InlineResponse20012) HasHasMore() bool` + +HasHasMore returns a boolean if a field has been set. + +### SetHasMore + +`func (o *InlineResponse20012) SetHasMore(v bool)` + +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. + ### GetData `func (o *InlineResponse20012) GetData() []ApplicationCustomer` diff --git a/docs/IntegrationApi.md b/docs/IntegrationApi.md index ced34321..b3b9a33e 100644 --- a/docs/IntegrationApi.md +++ b/docs/IntegrationApi.md @@ -11,9 +11,11 @@ Method | HTTP request | Description [**GetCustomerInventory**](IntegrationApi.md#GetCustomerInventory) | **Get** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile. [**GetReservedCustomers**](IntegrationApi.md#GetReservedCustomers) | **Get** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved [**TrackEvent**](IntegrationApi.md#TrackEvent) | **Post** /v1/events | Track an Event -[**UpdateCustomerProfile**](IntegrationApi.md#UpdateCustomerProfile) | **Put** /v1/customer_profiles/{integrationId} | Update a Customer Profile -[**UpdateCustomerProfileV2**](IntegrationApi.md#UpdateCustomerProfileV2) | **Put** /v2/customer_profiles/{customerProfileId} | Update a Customer Profile -[**UpdateCustomerSession**](IntegrationApi.md#UpdateCustomerSession) | **Put** /v1/customer_sessions/{customerSessionId} | Update a Customer Session +[**UpdateCustomerProfile**](IntegrationApi.md#UpdateCustomerProfile) | **Put** /v1/customer_profiles/{integrationId} | Update a Customer Profile V1 +[**UpdateCustomerProfileAudiences**](IntegrationApi.md#UpdateCustomerProfileAudiences) | **Post** /v2/customer_audiences | Update a Customer Profile Audiences +[**UpdateCustomerProfileV2**](IntegrationApi.md#UpdateCustomerProfileV2) | **Put** /v2/customer_profiles/{integrationId} | Update a Customer Profile +[**UpdateCustomerProfilesV2**](IntegrationApi.md#UpdateCustomerProfilesV2) | **Put** /v2/customer_profiles | Update multiple Customer Profiles +[**UpdateCustomerSession**](IntegrationApi.md#UpdateCustomerSession) | **Put** /v1/customer_sessions/{customerSessionId} | Update a Customer Session V1 [**UpdateCustomerSessionV2**](IntegrationApi.md#UpdateCustomerSessionV2) | **Put** /v2/customer_sessions/{customerSessionId} | Update a Customer Session @@ -190,7 +192,7 @@ Name | Type | Description | Notes ## GetCustomerInventory -> CustomerInventory GetCustomerInventory(ctx, integrationId).Profile(profile).Referrals(referrals).Coupons(coupons).Execute() +> CustomerInventory GetCustomerInventory(ctx, integrationId).Profile(profile).Referrals(referrals).Coupons(coupons).Loyalty(loyalty).Execute() Get an inventory of all data associated with a specific customer profile. @@ -215,6 +217,7 @@ Name | Type | Description | Notes **profile** | **bool** | optional flag to decide if you would like customer profile information in the response | **referrals** | **bool** | optional flag to decide if you would like referral information in the response | **coupons** | **bool** | optional flag to decide if you would like coupon information in the response | + **loyalty** | **bool** | optional flag to decide if you would like loyalty information in the response | ### Return type @@ -321,7 +324,7 @@ Name | Type | Description | Notes > IntegrationState UpdateCustomerProfile(ctx, integrationId).Body(body).Dry(dry).Execute() -Update a Customer Profile +Update a Customer Profile V1 @@ -362,9 +365,48 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## UpdateCustomerProfileAudiences + +> UpdateCustomerProfileAudiences(ctx).Body(body).Execute() + +Update a Customer Profile Audiences + + + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCustomerProfileAudiencesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CustomerProfileAudienceRequest**](CustomerProfileAudienceRequest.md) | | + +### Return type + + (empty response body) + +### Authorization + +[api_key_v1](../README.md#api_key_v1) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## UpdateCustomerProfileV2 -> CustomerProfileUpdate UpdateCustomerProfileV2(ctx, customerProfileId).Body(body).Execute() +> IntegrationStateV2 UpdateCustomerProfileV2(ctx, integrationId).Body(body).RunRuleEngine(runRuleEngine).Dry(dry).Execute() Update a Customer Profile @@ -376,7 +418,7 @@ Update a Customer Profile Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**customerProfileId** | **string** | The custom identifier for this profile, must be unique within the account. | +**integrationId** | **string** | The custom identifier for this profile, must be unique within the account. | ### Other Parameters @@ -386,11 +428,53 @@ Other parameters are passed through a pointer to a apiUpdateCustomerProfileV2Req Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**NewCustomerProfile**](NewCustomerProfile.md) | | + **body** | [**CustomerProfileIntegrationRequestV2**](CustomerProfileIntegrationRequestV2.md) | | + **runRuleEngine** | **bool** | Flag to indicate whether to run the rule engine (Defaults to false). | + **dry** | **bool** | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'. Only used when 'runRuleEngine' is set to 'true'). | + +### Return type + +[**IntegrationStateV2**](IntegrationStateV2.md) + +### Authorization + +[api_key_v1](../README.md#api_key_v1) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateCustomerProfilesV2 + +> MultipleCustomerProfileIntegrationResponseV2 UpdateCustomerProfilesV2(ctx).Body(body).Silent(silent).Execute() + +Update multiple Customer Profiles + + + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCustomerProfilesV2Request struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**MultipleCustomerProfileIntegrationRequest**](MultipleCustomerProfileIntegrationRequest.md) | | + **silent** | **string** | If set to 'yes', response will be an empty 204, otherwise a list of the IntegrationStateV2 generated. | ### Return type -[**CustomerProfileUpdate**](CustomerProfileUpdate.md) +[**MultipleCustomerProfileIntegrationResponseV2**](MultipleCustomerProfileIntegrationResponseV2.md) ### Authorization @@ -410,7 +494,7 @@ Name | Type | Description | Notes > IntegrationState UpdateCustomerSession(ctx, customerSessionId).Body(body).Dry(dry).Execute() -Update a Customer Session +Update a Customer Session V1 diff --git a/docs/IntegrationEntity.md b/docs/IntegrationEntity.md index 9be73c0b..a6a4f052 100644 --- a/docs/IntegrationEntity.md +++ b/docs/IntegrationEntity.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IntegrationId** | Pointer to **string** | The ID used for this entity in the application system. | +**IntegrationId** | Pointer to **string** | The integration ID for this entity sent to and used in the Talon.One system. | **Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | ## Methods diff --git a/docs/LoyaltyLedgerEntry.md b/docs/LoyaltyLedgerEntry.md index 340f46f7..baee7f8f 100644 --- a/docs/LoyaltyLedgerEntry.md +++ b/docs/LoyaltyLedgerEntry.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **EventID** | Pointer to **int32** | | [optional] **Type** | Pointer to **string** | The type of the ledger transaction. Possible values are addition, subtraction, expire or expiring (for expiring points ledgers) | **Amount** | Pointer to **float32** | | +**StartDate** | Pointer to [**time.Time**](time.Time.md) | | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | | [optional] **Name** | Pointer to **string** | A name referencing the condition or effect that added this entry, or the specific name provided in an API call. | **SubLedgerID** | Pointer to **string** | This specifies if we are adding loyalty points to the main ledger or a subledger | @@ -193,6 +194,31 @@ HasAmount returns a boolean if a field has been set. SetAmount gets a reference to the given float32 and assigns it to the Amount field. +### GetStartDate + +`func (o *LoyaltyLedgerEntry) GetStartDate() time.Time` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *LoyaltyLedgerEntry) GetStartDateOk() (time.Time, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStartDate + +`func (o *LoyaltyLedgerEntry) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *LoyaltyLedgerEntry) SetStartDate(v time.Time)` + +SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. + ### GetExpiryDate `func (o *LoyaltyLedgerEntry) GetExpiryDate() time.Time` diff --git a/docs/LoyaltyPoints.md b/docs/LoyaltyPoints.md index 1ec18e39..ca4b9c6b 100644 --- a/docs/LoyaltyPoints.md +++ b/docs/LoyaltyPoints.md @@ -6,7 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Points** | Pointer to **float32** | Amount of loyalty points | **Name** | Pointer to **string** | Allows to specify a name for the addition or deduction | [optional] -**ExpiryDuration** | Pointer to **string** | Indicates the duration after which the added loyalty points should expire. The format is a number followed by one letter indicating the unit, like '1h' or '40m' or '30d'. | [optional] +**ValidityDuration** | Pointer to **string** | Indicates the duration after which the added loyalty points should expire. The format is a number followed by one letter indicating the time unit, like '1h' or '40m' (defined by Go time package). | [optional] +**PendingDuration** | Pointer to **string** | Indicates the amount of time before the points are considered valid. The format is a number followed by one letter indicating the time unit, like '1h' or '40m' (defined by Go time package). | [optional] **SubLedgerID** | Pointer to **string** | This specifies if we are adding loyalty points to the main ledger or a subledger | [optional] ## Methods @@ -61,30 +62,55 @@ HasName returns a boolean if a field has been set. SetName gets a reference to the given string and assigns it to the Name field. -### GetExpiryDuration +### GetValidityDuration -`func (o *LoyaltyPoints) GetExpiryDuration() string` +`func (o *LoyaltyPoints) GetValidityDuration() string` -GetExpiryDuration returns the ExpiryDuration field if non-nil, zero value otherwise. +GetValidityDuration returns the ValidityDuration field if non-nil, zero value otherwise. -### GetExpiryDurationOk +### GetValidityDurationOk -`func (o *LoyaltyPoints) GetExpiryDurationOk() (string, bool)` +`func (o *LoyaltyPoints) GetValidityDurationOk() (string, bool)` -GetExpiryDurationOk returns a tuple with the ExpiryDuration field if it's non-nil, zero value otherwise +GetValidityDurationOk returns a tuple with the ValidityDuration field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasExpiryDuration +### HasValidityDuration -`func (o *LoyaltyPoints) HasExpiryDuration() bool` +`func (o *LoyaltyPoints) HasValidityDuration() bool` -HasExpiryDuration returns a boolean if a field has been set. +HasValidityDuration returns a boolean if a field has been set. -### SetExpiryDuration +### SetValidityDuration -`func (o *LoyaltyPoints) SetExpiryDuration(v string)` +`func (o *LoyaltyPoints) SetValidityDuration(v string)` -SetExpiryDuration gets a reference to the given string and assigns it to the ExpiryDuration field. +SetValidityDuration gets a reference to the given string and assigns it to the ValidityDuration field. + +### GetPendingDuration + +`func (o *LoyaltyPoints) GetPendingDuration() string` + +GetPendingDuration returns the PendingDuration field if non-nil, zero value otherwise. + +### GetPendingDurationOk + +`func (o *LoyaltyPoints) GetPendingDurationOk() (string, bool)` + +GetPendingDurationOk returns a tuple with the PendingDuration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPendingDuration + +`func (o *LoyaltyPoints) HasPendingDuration() bool` + +HasPendingDuration returns a boolean if a field has been set. + +### SetPendingDuration + +`func (o *LoyaltyPoints) SetPendingDuration(v string)` + +SetPendingDuration gets a reference to the given string and assigns it to the PendingDuration field. ### GetSubLedgerID diff --git a/docs/LoyaltyProgram.md b/docs/LoyaltyProgram.md index ece269a1..0826c01d 100644 --- a/docs/LoyaltyProgram.md +++ b/docs/LoyaltyProgram.md @@ -10,7 +10,8 @@ Name | Type | Description | Notes **Title** | Pointer to **string** | The display title for the Loyalty Program. | **Description** | Pointer to **string** | Description of our Loyalty Program. | **SubscribedApplications** | Pointer to **[]int32** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | -**DefaultValidity** | Pointer to **string** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m' or '30d'. | +**DefaultValidity** | Pointer to **string** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. | +**DefaultPending** | Pointer to **string** | Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. | **AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program | ## Methods @@ -190,6 +191,31 @@ HasDefaultValidity returns a boolean if a field has been set. SetDefaultValidity gets a reference to the given string and assigns it to the DefaultValidity field. +### GetDefaultPending + +`func (o *LoyaltyProgram) GetDefaultPending() string` + +GetDefaultPending returns the DefaultPending field if non-nil, zero value otherwise. + +### GetDefaultPendingOk + +`func (o *LoyaltyProgram) GetDefaultPendingOk() (string, bool)` + +GetDefaultPendingOk returns a tuple with the DefaultPending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDefaultPending + +`func (o *LoyaltyProgram) HasDefaultPending() bool` + +HasDefaultPending returns a boolean if a field has been set. + +### SetDefaultPending + +`func (o *LoyaltyProgram) SetDefaultPending(v string)` + +SetDefaultPending gets a reference to the given string and assigns it to the DefaultPending field. + ### GetAllowSubledger `func (o *LoyaltyProgram) GetAllowSubledger() bool` diff --git a/docs/LoyaltyStatistics.md b/docs/LoyaltyStatistics.md new file mode 100644 index 00000000..2f1672a9 --- /dev/null +++ b/docs/LoyaltyStatistics.md @@ -0,0 +1,117 @@ +# LoyaltyStatistics + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalActivePoints** | Pointer to **float32** | Total of active points for this loyalty program | +**TotalPendingPoints** | Pointer to **float32** | Total of pending points for this loyalty program | +**TotalSpentPoints** | Pointer to **float32** | Total of spent points for this loyalty program | +**TotalExpiredPoints** | Pointer to **float32** | Total of expired points for this loyalty program | + +## Methods + +### GetTotalActivePoints + +`func (o *LoyaltyStatistics) GetTotalActivePoints() float32` + +GetTotalActivePoints returns the TotalActivePoints field if non-nil, zero value otherwise. + +### GetTotalActivePointsOk + +`func (o *LoyaltyStatistics) GetTotalActivePointsOk() (float32, bool)` + +GetTotalActivePointsOk returns a tuple with the TotalActivePoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalActivePoints + +`func (o *LoyaltyStatistics) HasTotalActivePoints() bool` + +HasTotalActivePoints returns a boolean if a field has been set. + +### SetTotalActivePoints + +`func (o *LoyaltyStatistics) SetTotalActivePoints(v float32)` + +SetTotalActivePoints gets a reference to the given float32 and assigns it to the TotalActivePoints field. + +### GetTotalPendingPoints + +`func (o *LoyaltyStatistics) GetTotalPendingPoints() float32` + +GetTotalPendingPoints returns the TotalPendingPoints field if non-nil, zero value otherwise. + +### GetTotalPendingPointsOk + +`func (o *LoyaltyStatistics) GetTotalPendingPointsOk() (float32, bool)` + +GetTotalPendingPointsOk returns a tuple with the TotalPendingPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalPendingPoints + +`func (o *LoyaltyStatistics) HasTotalPendingPoints() bool` + +HasTotalPendingPoints returns a boolean if a field has been set. + +### SetTotalPendingPoints + +`func (o *LoyaltyStatistics) SetTotalPendingPoints(v float32)` + +SetTotalPendingPoints gets a reference to the given float32 and assigns it to the TotalPendingPoints field. + +### GetTotalSpentPoints + +`func (o *LoyaltyStatistics) GetTotalSpentPoints() float32` + +GetTotalSpentPoints returns the TotalSpentPoints field if non-nil, zero value otherwise. + +### GetTotalSpentPointsOk + +`func (o *LoyaltyStatistics) GetTotalSpentPointsOk() (float32, bool)` + +GetTotalSpentPointsOk returns a tuple with the TotalSpentPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalSpentPoints + +`func (o *LoyaltyStatistics) HasTotalSpentPoints() bool` + +HasTotalSpentPoints returns a boolean if a field has been set. + +### SetTotalSpentPoints + +`func (o *LoyaltyStatistics) SetTotalSpentPoints(v float32)` + +SetTotalSpentPoints gets a reference to the given float32 and assigns it to the TotalSpentPoints field. + +### GetTotalExpiredPoints + +`func (o *LoyaltyStatistics) GetTotalExpiredPoints() float32` + +GetTotalExpiredPoints returns the TotalExpiredPoints field if non-nil, zero value otherwise. + +### GetTotalExpiredPointsOk + +`func (o *LoyaltyStatistics) GetTotalExpiredPointsOk() (float32, bool)` + +GetTotalExpiredPointsOk returns a tuple with the TotalExpiredPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalExpiredPoints + +`func (o *LoyaltyStatistics) HasTotalExpiredPoints() bool` + +HasTotalExpiredPoints returns a boolean if a field has been set. + +### SetTotalExpiredPoints + +`func (o *LoyaltyStatistics) SetTotalExpiredPoints(v float32)` + +SetTotalExpiredPoints gets a reference to the given float32 and assigns it to the TotalExpiredPoints field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoyaltySubLedger.md b/docs/LoyaltySubLedger.md index 3da5de3e..c755b2d3 100644 --- a/docs/LoyaltySubLedger.md +++ b/docs/LoyaltySubLedger.md @@ -4,9 +4,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Total** | Pointer to **float32** | | -**Transactions** | Pointer to [**[]LoyaltyLedgerEntry**](LoyaltyLedgerEntry.md) | Transactions contains a list of all events that have happened such as additions, subtractions and expiries | [optional] -**ExpiringPoints** | Pointer to [**[]LoyaltyLedgerEntry**](LoyaltyLedgerEntry.md) | ExpiringPoints contains a list of all points that will expiry and when | [optional] +**Total** | Pointer to **float32** | ⚠️ Deprecated: Please use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance | +**TotalActivePoints** | Pointer to **float32** | Total amount of currently active and available points in the customer's balance | +**TotalPendingPoints** | Pointer to **float32** | Total amount of pending points, which are not active yet but will become active in the future | +**TotalSpentPoints** | Pointer to **float32** | Total amount of points already spent by this customer | +**TotalExpiredPoints** | Pointer to **float32** | Total amount of points, that expired without ever being spent | +**Transactions** | Pointer to [**[]LoyaltyLedgerEntry**](LoyaltyLedgerEntry.md) | List of all events that have happened such as additions, subtractions and expiries | [optional] +**ExpiringPoints** | Pointer to [**[]LoyaltyLedgerEntry**](LoyaltyLedgerEntry.md) | List of all points that will expire | [optional] +**ActivePoints** | Pointer to [**[]LoyaltyLedgerEntry**](LoyaltyLedgerEntry.md) | List of all currently active points | [optional] +**PendingPoints** | Pointer to [**[]LoyaltyLedgerEntry**](LoyaltyLedgerEntry.md) | List of all points pending activation | [optional] +**ExpiredPoints** | Pointer to [**[]LoyaltyLedgerEntry**](LoyaltyLedgerEntry.md) | List of expired points | [optional] ## Methods @@ -35,6 +42,106 @@ HasTotal returns a boolean if a field has been set. SetTotal gets a reference to the given float32 and assigns it to the Total field. +### GetTotalActivePoints + +`func (o *LoyaltySubLedger) GetTotalActivePoints() float32` + +GetTotalActivePoints returns the TotalActivePoints field if non-nil, zero value otherwise. + +### GetTotalActivePointsOk + +`func (o *LoyaltySubLedger) GetTotalActivePointsOk() (float32, bool)` + +GetTotalActivePointsOk returns a tuple with the TotalActivePoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalActivePoints + +`func (o *LoyaltySubLedger) HasTotalActivePoints() bool` + +HasTotalActivePoints returns a boolean if a field has been set. + +### SetTotalActivePoints + +`func (o *LoyaltySubLedger) SetTotalActivePoints(v float32)` + +SetTotalActivePoints gets a reference to the given float32 and assigns it to the TotalActivePoints field. + +### GetTotalPendingPoints + +`func (o *LoyaltySubLedger) GetTotalPendingPoints() float32` + +GetTotalPendingPoints returns the TotalPendingPoints field if non-nil, zero value otherwise. + +### GetTotalPendingPointsOk + +`func (o *LoyaltySubLedger) GetTotalPendingPointsOk() (float32, bool)` + +GetTotalPendingPointsOk returns a tuple with the TotalPendingPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalPendingPoints + +`func (o *LoyaltySubLedger) HasTotalPendingPoints() bool` + +HasTotalPendingPoints returns a boolean if a field has been set. + +### SetTotalPendingPoints + +`func (o *LoyaltySubLedger) SetTotalPendingPoints(v float32)` + +SetTotalPendingPoints gets a reference to the given float32 and assigns it to the TotalPendingPoints field. + +### GetTotalSpentPoints + +`func (o *LoyaltySubLedger) GetTotalSpentPoints() float32` + +GetTotalSpentPoints returns the TotalSpentPoints field if non-nil, zero value otherwise. + +### GetTotalSpentPointsOk + +`func (o *LoyaltySubLedger) GetTotalSpentPointsOk() (float32, bool)` + +GetTotalSpentPointsOk returns a tuple with the TotalSpentPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalSpentPoints + +`func (o *LoyaltySubLedger) HasTotalSpentPoints() bool` + +HasTotalSpentPoints returns a boolean if a field has been set. + +### SetTotalSpentPoints + +`func (o *LoyaltySubLedger) SetTotalSpentPoints(v float32)` + +SetTotalSpentPoints gets a reference to the given float32 and assigns it to the TotalSpentPoints field. + +### GetTotalExpiredPoints + +`func (o *LoyaltySubLedger) GetTotalExpiredPoints() float32` + +GetTotalExpiredPoints returns the TotalExpiredPoints field if non-nil, zero value otherwise. + +### GetTotalExpiredPointsOk + +`func (o *LoyaltySubLedger) GetTotalExpiredPointsOk() (float32, bool)` + +GetTotalExpiredPointsOk returns a tuple with the TotalExpiredPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalExpiredPoints + +`func (o *LoyaltySubLedger) HasTotalExpiredPoints() bool` + +HasTotalExpiredPoints returns a boolean if a field has been set. + +### SetTotalExpiredPoints + +`func (o *LoyaltySubLedger) SetTotalExpiredPoints(v float32)` + +SetTotalExpiredPoints gets a reference to the given float32 and assigns it to the TotalExpiredPoints field. + ### GetTransactions `func (o *LoyaltySubLedger) GetTransactions() []LoyaltyLedgerEntry` @@ -85,6 +192,81 @@ HasExpiringPoints returns a boolean if a field has been set. SetExpiringPoints gets a reference to the given []LoyaltyLedgerEntry and assigns it to the ExpiringPoints field. +### GetActivePoints + +`func (o *LoyaltySubLedger) GetActivePoints() []LoyaltyLedgerEntry` + +GetActivePoints returns the ActivePoints field if non-nil, zero value otherwise. + +### GetActivePointsOk + +`func (o *LoyaltySubLedger) GetActivePointsOk() ([]LoyaltyLedgerEntry, bool)` + +GetActivePointsOk returns a tuple with the ActivePoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActivePoints + +`func (o *LoyaltySubLedger) HasActivePoints() bool` + +HasActivePoints returns a boolean if a field has been set. + +### SetActivePoints + +`func (o *LoyaltySubLedger) SetActivePoints(v []LoyaltyLedgerEntry)` + +SetActivePoints gets a reference to the given []LoyaltyLedgerEntry and assigns it to the ActivePoints field. + +### GetPendingPoints + +`func (o *LoyaltySubLedger) GetPendingPoints() []LoyaltyLedgerEntry` + +GetPendingPoints returns the PendingPoints field if non-nil, zero value otherwise. + +### GetPendingPointsOk + +`func (o *LoyaltySubLedger) GetPendingPointsOk() ([]LoyaltyLedgerEntry, bool)` + +GetPendingPointsOk returns a tuple with the PendingPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPendingPoints + +`func (o *LoyaltySubLedger) HasPendingPoints() bool` + +HasPendingPoints returns a boolean if a field has been set. + +### SetPendingPoints + +`func (o *LoyaltySubLedger) SetPendingPoints(v []LoyaltyLedgerEntry)` + +SetPendingPoints gets a reference to the given []LoyaltyLedgerEntry and assigns it to the PendingPoints field. + +### GetExpiredPoints + +`func (o *LoyaltySubLedger) GetExpiredPoints() []LoyaltyLedgerEntry` + +GetExpiredPoints returns the ExpiredPoints field if non-nil, zero value otherwise. + +### GetExpiredPointsOk + +`func (o *LoyaltySubLedger) GetExpiredPointsOk() ([]LoyaltyLedgerEntry, bool)` + +GetExpiredPointsOk returns a tuple with the ExpiredPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiredPoints + +`func (o *LoyaltySubLedger) HasExpiredPoints() bool` + +HasExpiredPoints returns a boolean if a field has been set. + +### SetExpiredPoints + +`func (o *LoyaltySubLedger) SetExpiredPoints(v []LoyaltyLedgerEntry)` + +SetExpiredPoints gets a reference to the given []LoyaltyLedgerEntry and assigns it to the ExpiredPoints field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ManagementApi.md b/docs/ManagementApi.md index 99718602..73619a04 100644 --- a/docs/ManagementApi.md +++ b/docs/ManagementApi.md @@ -61,6 +61,7 @@ Method | HTTP request | Description [**GetLoyaltyPoints**](ManagementApi.md#GetLoyaltyPoints) | **Get** /v1/loyalty_programs/{programID}/profile/{integrationID} | get the Loyalty Ledger for this integrationID [**GetLoyaltyProgram**](ManagementApi.md#GetLoyaltyProgram) | **Get** /v1/loyalty_programs/{programID} | Get a loyalty program [**GetLoyaltyPrograms**](ManagementApi.md#GetLoyaltyPrograms) | **Get** /v1/loyalty_programs | List all loyalty Programs +[**GetLoyaltyStatistics**](ManagementApi.md#GetLoyaltyStatistics) | **Get** /v1/loyalty_programs/{programID}/statistics | Get loyalty program statistics by loyalty program ID [**GetReferrals**](ManagementApi.md#GetReferrals) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals (with total count) [**GetReferralsWithoutTotalCount**](ManagementApi.md#GetReferralsWithoutTotalCount) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List Referrals [**GetRole**](ManagementApi.md#GetRole) | **Get** /v1/roles/{roleId} | Get information for the specified role. @@ -1174,7 +1175,7 @@ Name | Type | Description | Notes ## GetApplicationCustomers -> InlineResponse20012 GetApplicationCustomers(ctx, applicationId).Execute() +> InlineResponse20012 GetApplicationCustomers(ctx, applicationId).IntegrationId(integrationId).PageSize(pageSize).Skip(skip).WithTotalResultSize(withTotalResultSize).Execute() List Application Customers @@ -1194,6 +1195,10 @@ Other parameters are passed through a pointer to a apiGetApplicationCustomersReq Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **integrationId** | **string** | Filter results performing an exact matching against the profile integration identifier. | + **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | + **skip** | **int32** | Skips the given number of items when paging through large result sets. | + **withTotalResultSize** | **bool** | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query. | ### Return type @@ -1457,7 +1462,7 @@ Name | Type | Description | Notes ## GetApplicationSessions -> InlineResponse20016 GetApplicationSessions(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Profile(profile).State(state).Coupon(coupon).Referral(referral).IntegrationId(integrationId).CustomerId(customerId).Execute() +> InlineResponse20016 GetApplicationSessions(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Profile(profile).State(state).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Coupon(coupon).Referral(referral).IntegrationId(integrationId).Execute() List Application Sessions @@ -1482,10 +1487,11 @@ Name | Type | Description | Notes **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | **profile** | **string** | Profile integration ID filter for sessions. Must be exact match. | **state** | **string** | Filter by sessions with this state. Must be exact match. | + **createdBefore** | **time.Time** | Only return events created before this date | + **createdAfter** | **time.Time** | Only return events created after this date | **coupon** | **string** | Filter by sessions with this coupon. Must be exact match. | **referral** | **string** | Filter by sessions with this referral. Must be exact match. | **integrationId** | **string** | Filter by sessions with this integrationId. Must be exact match. | - **customerId** | **string** | Filter by integration ID of the customer for the session | ### Return type @@ -1769,7 +1775,7 @@ Name | Type | Description | Notes ## GetCampaigns -> InlineResponse2002 GetCampaigns(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).CampaignState(campaignState).Name(name).Tags(tags).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Execute() +> InlineResponse2002 GetCampaigns(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).CampaignState(campaignState).Name(name).Tags(tags).CreatedBefore(createdBefore).CreatedAfter(createdAfter).CampaignGroupId(campaignGroupId).Execute() List your Campaigns @@ -1797,6 +1803,7 @@ Name | Type | Description | Notes **tags** | **string** | Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values | **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. | **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. | + **campaignGroupId** | **int32** | Filter results to campaigns owned by the specified campaign group ID. | ### Return type @@ -2294,7 +2301,7 @@ Name | Type | Description | Notes ## GetCustomerProfile -> ApplicationCustomer GetCustomerProfile(ctx, applicationId, customerId).Execute() +> ApplicationCustomer GetCustomerProfile(ctx, customerId).Execute() Get Customer Profile @@ -2304,7 +2311,6 @@ Get Customer Profile Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**applicationId** | **int32** | | **customerId** | **int32** | | ### Other Parameters @@ -2316,7 +2322,6 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - ### Return type [**ApplicationCustomer**](ApplicationCustomer.md) @@ -2660,6 +2665,47 @@ Other parameters are passed through a pointer to a apiGetLoyaltyProgramsRequest [[Back to README]](../README.md) +## GetLoyaltyStatistics + +> LoyaltyStatistics GetLoyaltyStatistics(ctx, programID).Execute() + +Get loyalty program statistics by loyalty program ID + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**programID** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetLoyaltyStatisticsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**LoyaltyStatistics**](LoyaltyStatistics.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## GetReferrals > InlineResponse2006 GetReferrals(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Code(code).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).Advocate(advocate).Execute() diff --git a/docs/Meta.md b/docs/Meta.md index b1f2a212..56174eaf 100644 --- a/docs/Meta.md +++ b/docs/Meta.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **Coupons** | Pointer to [**map[string]interface{}**](.md) | Maps the coupon value to a key-value list of that coupons attributes. | [optional] **CouponRejectionReason** | Pointer to [**CouponRejectionReason**](CouponRejectionReason.md) | | [optional] **ReferralRejectionReason** | Pointer to [**ReferralRejectionReason**](ReferralRejectionReason.md) | | [optional] -**Warnings** | Pointer to [**map[string]interface{}**](.md) | | [optional] +**Warnings** | Pointer to [**map[string]interface{}**](.md) | Contains warnings about possible misuse. | [optional] ## Methods diff --git a/docs/MiscUpdateUserLatestFeature.md b/docs/MiscUpdateUserLatestFeature.md deleted file mode 100644 index 223a56f7..00000000 --- a/docs/MiscUpdateUserLatestFeature.md +++ /dev/null @@ -1,39 +0,0 @@ -# MiscUpdateUserLatestFeature - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LatestFeature** | Pointer to **string** | | [optional] - -## Methods - -### GetLatestFeature - -`func (o *MiscUpdateUserLatestFeature) GetLatestFeature() string` - -GetLatestFeature returns the LatestFeature field if non-nil, zero value otherwise. - -### GetLatestFeatureOk - -`func (o *MiscUpdateUserLatestFeature) GetLatestFeatureOk() (string, bool)` - -GetLatestFeatureOk returns a tuple with the LatestFeature field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLatestFeature - -`func (o *MiscUpdateUserLatestFeature) HasLatestFeature() bool` - -HasLatestFeature returns a boolean if a field has been set. - -### SetLatestFeature - -`func (o *MiscUpdateUserLatestFeature) SetLatestFeature(v string)` - -SetLatestFeature gets a reference to the given string and assigns it to the LatestFeature field. - - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/MultipleCustomerProfileIntegrationRequest.md b/docs/MultipleCustomerProfileIntegrationRequest.md new file mode 100644 index 00000000..fa7a243f --- /dev/null +++ b/docs/MultipleCustomerProfileIntegrationRequest.md @@ -0,0 +1,39 @@ +# MultipleCustomerProfileIntegrationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomerProfiles** | Pointer to [**[]MultipleCustomerProfileIntegrationRequestItem**](MultipleCustomerProfileIntegrationRequestItem.md) | | [optional] + +## Methods + +### GetCustomerProfiles + +`func (o *MultipleCustomerProfileIntegrationRequest) GetCustomerProfiles() []MultipleCustomerProfileIntegrationRequestItem` + +GetCustomerProfiles returns the CustomerProfiles field if non-nil, zero value otherwise. + +### GetCustomerProfilesOk + +`func (o *MultipleCustomerProfileIntegrationRequest) GetCustomerProfilesOk() ([]MultipleCustomerProfileIntegrationRequestItem, bool)` + +GetCustomerProfilesOk returns a tuple with the CustomerProfiles field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCustomerProfiles + +`func (o *MultipleCustomerProfileIntegrationRequest) HasCustomerProfiles() bool` + +HasCustomerProfiles returns a boolean if a field has been set. + +### SetCustomerProfiles + +`func (o *MultipleCustomerProfileIntegrationRequest) SetCustomerProfiles(v []MultipleCustomerProfileIntegrationRequestItem)` + +SetCustomerProfiles gets a reference to the given []MultipleCustomerProfileIntegrationRequestItem and assigns it to the CustomerProfiles field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MultipleCustomerProfileIntegrationRequestItem.md b/docs/MultipleCustomerProfileIntegrationRequestItem.md new file mode 100644 index 00000000..505ebe38 --- /dev/null +++ b/docs/MultipleCustomerProfileIntegrationRequestItem.md @@ -0,0 +1,65 @@ +# MultipleCustomerProfileIntegrationRequestItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] +**IntegrationId** | Pointer to **string** | The custom identifier for this profile, must be unique within the account. | + +## Methods + +### GetAttributes + +`func (o *MultipleCustomerProfileIntegrationRequestItem) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *MultipleCustomerProfileIntegrationRequestItem) GetAttributesOk() (map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *MultipleCustomerProfileIntegrationRequestItem) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *MultipleCustomerProfileIntegrationRequestItem) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + +### GetIntegrationId + +`func (o *MultipleCustomerProfileIntegrationRequestItem) GetIntegrationId() string` + +GetIntegrationId returns the IntegrationId field if non-nil, zero value otherwise. + +### GetIntegrationIdOk + +`func (o *MultipleCustomerProfileIntegrationRequestItem) GetIntegrationIdOk() (string, bool)` + +GetIntegrationIdOk returns a tuple with the IntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIntegrationId + +`func (o *MultipleCustomerProfileIntegrationRequestItem) HasIntegrationId() bool` + +HasIntegrationId returns a boolean if a field has been set. + +### SetIntegrationId + +`func (o *MultipleCustomerProfileIntegrationRequestItem) SetIntegrationId(v string)` + +SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MultipleCustomerProfileIntegrationResponseV2.md b/docs/MultipleCustomerProfileIntegrationResponseV2.md new file mode 100644 index 00000000..2b3f8e15 --- /dev/null +++ b/docs/MultipleCustomerProfileIntegrationResponseV2.md @@ -0,0 +1,39 @@ +# MultipleCustomerProfileIntegrationResponseV2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IntegrationStates** | Pointer to [**[]IntegrationStateV2**](IntegrationStateV2.md) | | [optional] + +## Methods + +### GetIntegrationStates + +`func (o *MultipleCustomerProfileIntegrationResponseV2) GetIntegrationStates() []IntegrationStateV2` + +GetIntegrationStates returns the IntegrationStates field if non-nil, zero value otherwise. + +### GetIntegrationStatesOk + +`func (o *MultipleCustomerProfileIntegrationResponseV2) GetIntegrationStatesOk() ([]IntegrationStateV2, bool)` + +GetIntegrationStatesOk returns a tuple with the IntegrationStates field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIntegrationStates + +`func (o *MultipleCustomerProfileIntegrationResponseV2) HasIntegrationStates() bool` + +HasIntegrationStates returns a boolean if a field has been set. + +### SetIntegrationStates + +`func (o *MultipleCustomerProfileIntegrationResponseV2) SetIntegrationStates(v []IntegrationStateV2)` + +SetIntegrationStates gets a reference to the given []IntegrationStateV2 and assigns it to the IntegrationStates field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewApplication.md b/docs/NewApplication.md index 19fb3deb..26020ef0 100644 --- a/docs/NewApplication.md +++ b/docs/NewApplication.md @@ -11,8 +11,12 @@ Name | Type | Description | Notes **CaseSensitivity** | Pointer to **string** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional] **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign | [optional] **Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] -**CampaignPriority** | Pointer to **string** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive) | [optional] +**CampaignPriority** | Pointer to **string** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional] +**ExclusiveCampaignsStrategy** | Pointer to **string** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional] +**EnableCascadingDiscounts** | Pointer to **bool** | Flag indicating if discounts should cascade for this application | [optional] +**EnableFlattenedCartItems** | Pointer to **bool** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one | [optional] **AttributesSettings** | Pointer to [**AttributesSettings**](AttributesSettings.md) | | [optional] +**Sandbox** | Pointer to **bool** | Flag indicating if this is a live or sandbox application | [optional] **Key** | Pointer to **string** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | [optional] ## Methods @@ -217,6 +221,81 @@ HasCampaignPriority returns a boolean if a field has been set. SetCampaignPriority gets a reference to the given string and assigns it to the CampaignPriority field. +### GetExclusiveCampaignsStrategy + +`func (o *NewApplication) GetExclusiveCampaignsStrategy() string` + +GetExclusiveCampaignsStrategy returns the ExclusiveCampaignsStrategy field if non-nil, zero value otherwise. + +### GetExclusiveCampaignsStrategyOk + +`func (o *NewApplication) GetExclusiveCampaignsStrategyOk() (string, bool)` + +GetExclusiveCampaignsStrategyOk returns a tuple with the ExclusiveCampaignsStrategy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExclusiveCampaignsStrategy + +`func (o *NewApplication) HasExclusiveCampaignsStrategy() bool` + +HasExclusiveCampaignsStrategy returns a boolean if a field has been set. + +### SetExclusiveCampaignsStrategy + +`func (o *NewApplication) SetExclusiveCampaignsStrategy(v string)` + +SetExclusiveCampaignsStrategy gets a reference to the given string and assigns it to the ExclusiveCampaignsStrategy field. + +### GetEnableCascadingDiscounts + +`func (o *NewApplication) GetEnableCascadingDiscounts() bool` + +GetEnableCascadingDiscounts returns the EnableCascadingDiscounts field if non-nil, zero value otherwise. + +### GetEnableCascadingDiscountsOk + +`func (o *NewApplication) GetEnableCascadingDiscountsOk() (bool, bool)` + +GetEnableCascadingDiscountsOk returns a tuple with the EnableCascadingDiscounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnableCascadingDiscounts + +`func (o *NewApplication) HasEnableCascadingDiscounts() bool` + +HasEnableCascadingDiscounts returns a boolean if a field has been set. + +### SetEnableCascadingDiscounts + +`func (o *NewApplication) SetEnableCascadingDiscounts(v bool)` + +SetEnableCascadingDiscounts gets a reference to the given bool and assigns it to the EnableCascadingDiscounts field. + +### GetEnableFlattenedCartItems + +`func (o *NewApplication) GetEnableFlattenedCartItems() bool` + +GetEnableFlattenedCartItems returns the EnableFlattenedCartItems field if non-nil, zero value otherwise. + +### GetEnableFlattenedCartItemsOk + +`func (o *NewApplication) GetEnableFlattenedCartItemsOk() (bool, bool)` + +GetEnableFlattenedCartItemsOk returns a tuple with the EnableFlattenedCartItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnableFlattenedCartItems + +`func (o *NewApplication) HasEnableFlattenedCartItems() bool` + +HasEnableFlattenedCartItems returns a boolean if a field has been set. + +### SetEnableFlattenedCartItems + +`func (o *NewApplication) SetEnableFlattenedCartItems(v bool)` + +SetEnableFlattenedCartItems gets a reference to the given bool and assigns it to the EnableFlattenedCartItems field. + ### GetAttributesSettings `func (o *NewApplication) GetAttributesSettings() AttributesSettings` @@ -242,6 +321,31 @@ HasAttributesSettings returns a boolean if a field has been set. SetAttributesSettings gets a reference to the given AttributesSettings and assigns it to the AttributesSettings field. +### GetSandbox + +`func (o *NewApplication) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *NewApplication) GetSandboxOk() (bool, bool)` + +GetSandboxOk returns a tuple with the Sandbox field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSandbox + +`func (o *NewApplication) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *NewApplication) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. + ### GetKey `func (o *NewApplication) GetKey() string` diff --git a/docs/NewApplicationApiKey.md b/docs/NewApplicationApiKey.md index 18539542..0d86077e 100644 --- a/docs/NewApplicationApiKey.md +++ b/docs/NewApplicationApiKey.md @@ -4,17 +4,93 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**Title** | Pointer to **string** | Title for API Key | +**Expires** | Pointer to [**time.Time**](time.Time.md) | The date the API key expired | +**Platform** | Pointer to **string** | Platform the API key is valid for. | [optional] **Id** | Pointer to **int32** | ID of the API Key | **CreatedBy** | Pointer to **int32** | ID of user who created | -**Title** | Pointer to **string** | Title for API Key | **AccountID** | Pointer to **int32** | ID of account the key is used for | **ApplicationID** | Pointer to **int32** | ID of application the key is used for | **Created** | Pointer to [**time.Time**](time.Time.md) | The date the API key was created | -**Expires** | Pointer to [**time.Time**](time.Time.md) | The date the API key expired | **Key** | Pointer to **string** | Raw API Key | ## Methods +### GetTitle + +`func (o *NewApplicationApiKey) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *NewApplicationApiKey) GetTitleOk() (string, bool)` + +GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTitle + +`func (o *NewApplicationApiKey) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitle + +`func (o *NewApplicationApiKey) SetTitle(v string)` + +SetTitle gets a reference to the given string and assigns it to the Title field. + +### GetExpires + +`func (o *NewApplicationApiKey) GetExpires() time.Time` + +GetExpires returns the Expires field if non-nil, zero value otherwise. + +### GetExpiresOk + +`func (o *NewApplicationApiKey) GetExpiresOk() (time.Time, bool)` + +GetExpiresOk returns a tuple with the Expires field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpires + +`func (o *NewApplicationApiKey) HasExpires() bool` + +HasExpires returns a boolean if a field has been set. + +### SetExpires + +`func (o *NewApplicationApiKey) SetExpires(v time.Time)` + +SetExpires gets a reference to the given time.Time and assigns it to the Expires field. + +### GetPlatform + +`func (o *NewApplicationApiKey) GetPlatform() string` + +GetPlatform returns the Platform field if non-nil, zero value otherwise. + +### GetPlatformOk + +`func (o *NewApplicationApiKey) GetPlatformOk() (string, bool)` + +GetPlatformOk returns a tuple with the Platform field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPlatform + +`func (o *NewApplicationApiKey) HasPlatform() bool` + +HasPlatform returns a boolean if a field has been set. + +### SetPlatform + +`func (o *NewApplicationApiKey) SetPlatform(v string)` + +SetPlatform gets a reference to the given string and assigns it to the Platform field. + ### GetId `func (o *NewApplicationApiKey) GetId() int32` @@ -65,31 +141,6 @@ HasCreatedBy returns a boolean if a field has been set. SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. -### GetTitle - -`func (o *NewApplicationApiKey) GetTitle() string` - -GetTitle returns the Title field if non-nil, zero value otherwise. - -### GetTitleOk - -`func (o *NewApplicationApiKey) GetTitleOk() (string, bool)` - -GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTitle - -`func (o *NewApplicationApiKey) HasTitle() bool` - -HasTitle returns a boolean if a field has been set. - -### SetTitle - -`func (o *NewApplicationApiKey) SetTitle(v string)` - -SetTitle gets a reference to the given string and assigns it to the Title field. - ### GetAccountID `func (o *NewApplicationApiKey) GetAccountID() int32` @@ -165,31 +216,6 @@ HasCreated returns a boolean if a field has been set. SetCreated gets a reference to the given time.Time and assigns it to the Created field. -### GetExpires - -`func (o *NewApplicationApiKey) GetExpires() time.Time` - -GetExpires returns the Expires field if non-nil, zero value otherwise. - -### GetExpiresOk - -`func (o *NewApplicationApiKey) GetExpiresOk() (time.Time, bool)` - -GetExpiresOk returns a tuple with the Expires field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasExpires - -`func (o *NewApplicationApiKey) HasExpires() bool` - -HasExpires returns a boolean if a field has been set. - -### SetExpires - -`func (o *NewApplicationApiKey) SetExpires(v time.Time)` - -SetExpires gets a reference to the given time.Time and assigns it to the Expires field. - ### GetKey `func (o *NewApplicationApiKey) GetKey() string` diff --git a/docs/NewAudience.md b/docs/NewAudience.md new file mode 100644 index 00000000..db33bdb1 --- /dev/null +++ b/docs/NewAudience.md @@ -0,0 +1,91 @@ +# NewAudience + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The human-friendly display name for this Audience. | +**Integration** | Pointer to **string** | Integration that this audience was created in. | +**IntegrationId** | Pointer to **string** | The ID of this Audience in the third-party integration | + +## Methods + +### GetName + +`func (o *NewAudience) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NewAudience) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *NewAudience) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *NewAudience) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetIntegration + +`func (o *NewAudience) GetIntegration() string` + +GetIntegration returns the Integration field if non-nil, zero value otherwise. + +### GetIntegrationOk + +`func (o *NewAudience) GetIntegrationOk() (string, bool)` + +GetIntegrationOk returns a tuple with the Integration field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIntegration + +`func (o *NewAudience) HasIntegration() bool` + +HasIntegration returns a boolean if a field has been set. + +### SetIntegration + +`func (o *NewAudience) SetIntegration(v string)` + +SetIntegration gets a reference to the given string and assigns it to the Integration field. + +### GetIntegrationId + +`func (o *NewAudience) GetIntegrationId() string` + +GetIntegrationId returns the IntegrationId field if non-nil, zero value otherwise. + +### GetIntegrationIdOk + +`func (o *NewAudience) GetIntegrationIdOk() (string, bool)` + +GetIntegrationIdOk returns a tuple with the IntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasIntegrationId + +`func (o *NewAudience) HasIntegrationId() bool` + +HasIntegrationId returns a boolean if a field has been set. + +### SetIntegrationId + +`func (o *NewAudience) SetIntegrationId(v string)` + +SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewCampaign.md b/docs/NewCampaign.md index f012e9d4..d9e1830f 100644 --- a/docs/NewCampaign.md +++ b/docs/NewCampaign.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of limits that will operate for this campaign | +**CampaignGroups** | Pointer to **[]int32** | The IDs of the campaign groups that own this entity. | [optional] ## Methods @@ -319,6 +320,31 @@ HasLimits returns a boolean if a field has been set. SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. +### GetCampaignGroups + +`func (o *NewCampaign) GetCampaignGroups() []int32` + +GetCampaignGroups returns the CampaignGroups field if non-nil, zero value otherwise. + +### GetCampaignGroupsOk + +`func (o *NewCampaign) GetCampaignGroupsOk() ([]int32, bool)` + +GetCampaignGroupsOk returns a tuple with the CampaignGroups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignGroups + +`func (o *NewCampaign) HasCampaignGroups() bool` + +HasCampaignGroups returns a boolean if a field has been set. + +### SetCampaignGroups + +`func (o *NewCampaign) SetCampaignGroups(v []int32)` + +SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/NewCampaignGroup.md b/docs/NewCampaignGroup.md new file mode 100644 index 00000000..05b87c9b --- /dev/null +++ b/docs/NewCampaignGroup.md @@ -0,0 +1,117 @@ +# NewCampaignGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of this campaign group. | +**Description** | Pointer to **string** | A longer description of the campaign group. | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this campaign group is enabled for | [optional] +**CampaignIds** | Pointer to **[]int32** | A list of the IDs of the campaigns that this campaign group owns | [optional] + +## Methods + +### GetName + +`func (o *NewCampaignGroup) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NewCampaignGroup) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *NewCampaignGroup) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *NewCampaignGroup) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *NewCampaignGroup) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NewCampaignGroup) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *NewCampaignGroup) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *NewCampaignGroup) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetSubscribedApplicationsIds + +`func (o *NewCampaignGroup) GetSubscribedApplicationsIds() []int32` + +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. + +### GetSubscribedApplicationsIdsOk + +`func (o *NewCampaignGroup) GetSubscribedApplicationsIdsOk() ([]int32, bool)` + +GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubscribedApplicationsIds + +`func (o *NewCampaignGroup) HasSubscribedApplicationsIds() bool` + +HasSubscribedApplicationsIds returns a boolean if a field has been set. + +### SetSubscribedApplicationsIds + +`func (o *NewCampaignGroup) SetSubscribedApplicationsIds(v []int32)` + +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. + +### GetCampaignIds + +`func (o *NewCampaignGroup) GetCampaignIds() []int32` + +GetCampaignIds returns the CampaignIds field if non-nil, zero value otherwise. + +### GetCampaignIdsOk + +`func (o *NewCampaignGroup) GetCampaignIdsOk() ([]int32, bool)` + +GetCampaignIdsOk returns a tuple with the CampaignIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignIds + +`func (o *NewCampaignGroup) HasCampaignIds() bool` + +HasCampaignIds returns a boolean if a field has been set. + +### SetCampaignIds + +`func (o *NewCampaignGroup) SetCampaignIds(v []int32)` + +SetCampaignIds gets a reference to the given []int32 and assigns it to the CampaignIds field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewLoyaltyProgram.md b/docs/NewLoyaltyProgram.md index ef3f8e7e..a8408216 100644 --- a/docs/NewLoyaltyProgram.md +++ b/docs/NewLoyaltyProgram.md @@ -8,7 +8,8 @@ Name | Type | Description | Notes **Title** | Pointer to **string** | The display title for the Loyalty Program. | **Description** | Pointer to **string** | Description of our Loyalty Program. | [optional] **SubscribedApplications** | Pointer to **[]int32** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional] -**DefaultValidity** | Pointer to **string** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m' or '30d'. | +**DefaultValidity** | Pointer to **string** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. | +**DefaultPending** | Pointer to **string** | Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. | **AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program | ## Methods @@ -138,6 +139,31 @@ HasDefaultValidity returns a boolean if a field has been set. SetDefaultValidity gets a reference to the given string and assigns it to the DefaultValidity field. +### GetDefaultPending + +`func (o *NewLoyaltyProgram) GetDefaultPending() string` + +GetDefaultPending returns the DefaultPending field if non-nil, zero value otherwise. + +### GetDefaultPendingOk + +`func (o *NewLoyaltyProgram) GetDefaultPendingOk() (string, bool)` + +GetDefaultPendingOk returns a tuple with the DefaultPending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDefaultPending + +`func (o *NewLoyaltyProgram) HasDefaultPending() bool` + +HasDefaultPending returns a boolean if a field has been set. + +### SetDefaultPending + +`func (o *NewLoyaltyProgram) SetDefaultPending(v string)` + +SetDefaultPending gets a reference to the given string and assigns it to the DefaultPending field. + ### GetAllowSubledger `func (o *NewLoyaltyProgram) GetAllowSubledger() bool` diff --git a/docs/Role.md b/docs/Role.md index a8ba66fd..5ef2d7a6 100644 --- a/docs/Role.md +++ b/docs/Role.md @@ -6,10 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | Pointer to **int32** | The ID of the role corresponding to the DB row | **AccountID** | Pointer to **int32** | The ID of the Talon.One account that owns this role. | +**CampaignGroupID** | Pointer to **int32** | The ID of the Campaign Group this role was created for. | [optional] **Name** | Pointer to **string** | Name of the role | [optional] **Description** | Pointer to **string** | Description of the role | [optional] **Members** | Pointer to **[]int32** | A list of user identifiers assigned to this role | [optional] -**Acl** | Pointer to **string** | Role Policy this should be a stringified blob of json | [optional] +**Acl** | Pointer to [**map[string]interface{}**](.md) | Role ACL Policy | [optional] ## Methods @@ -63,6 +64,31 @@ HasAccountID returns a boolean if a field has been set. SetAccountID gets a reference to the given int32 and assigns it to the AccountID field. +### GetCampaignGroupID + +`func (o *Role) GetCampaignGroupID() int32` + +GetCampaignGroupID returns the CampaignGroupID field if non-nil, zero value otherwise. + +### GetCampaignGroupIDOk + +`func (o *Role) GetCampaignGroupIDOk() (int32, bool)` + +GetCampaignGroupIDOk returns a tuple with the CampaignGroupID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignGroupID + +`func (o *Role) HasCampaignGroupID() bool` + +HasCampaignGroupID returns a boolean if a field has been set. + +### SetCampaignGroupID + +`func (o *Role) SetCampaignGroupID(v int32)` + +SetCampaignGroupID gets a reference to the given int32 and assigns it to the CampaignGroupID field. + ### GetName `func (o *Role) GetName() string` @@ -140,13 +166,13 @@ SetMembers gets a reference to the given []int32 and assigns it to the Members f ### GetAcl -`func (o *Role) GetAcl() string` +`func (o *Role) GetAcl() map[string]interface{}` GetAcl returns the Acl field if non-nil, zero value otherwise. ### GetAclOk -`func (o *Role) GetAclOk() (string, bool)` +`func (o *Role) GetAclOk() (map[string]interface{}, bool)` GetAclOk returns a tuple with the Acl field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -159,9 +185,9 @@ HasAcl returns a boolean if a field has been set. ### SetAcl -`func (o *Role) SetAcl(v string)` +`func (o *Role) SetAcl(v map[string]interface{})` -SetAcl gets a reference to the given string and assigns it to the Acl field. +SetAcl gets a reference to the given map[string]interface{} and assigns it to the Acl field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SetDiscountEffectProps.md b/docs/SetDiscountEffectProps.md index 2a35b1a4..96daa78f 100644 --- a/docs/SetDiscountEffectProps.md +++ b/docs/SetDiscountEffectProps.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | The name/description of this discount | **Value** | Pointer to **float32** | The total monetary value of the discount | +**Scope** | Pointer to **string** | The scope which the discount was applied on, can be one of (cartItems,additionalCosts,sessionTotal) | [optional] ## Methods @@ -59,6 +60,31 @@ HasValue returns a boolean if a field has been set. SetValue gets a reference to the given float32 and assigns it to the Value field. +### GetScope + +`func (o *SetDiscountEffectProps) GetScope() string` + +GetScope returns the Scope field if non-nil, zero value otherwise. + +### GetScopeOk + +`func (o *SetDiscountEffectProps) GetScopeOk() (string, bool)` + +GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasScope + +`func (o *SetDiscountEffectProps) HasScope() bool` + +HasScope returns a boolean if a field has been set. + +### SetScope + +`func (o *SetDiscountEffectProps) SetScope(v string)` + +SetScope gets a reference to the given string and assigns it to the Scope field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SetDiscountPerItemEffectProps.md b/docs/SetDiscountPerItemEffectProps.md index f8d4a625..df4d3607 100644 --- a/docs/SetDiscountPerItemEffectProps.md +++ b/docs/SetDiscountPerItemEffectProps.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **Name** | Pointer to **string** | The name/description of this discount | **Value** | Pointer to **float32** | The total monetary value of the discount | **Position** | Pointer to **float32** | The index of the item in the cart items list on which this discount should be applied | +**SubPosition** | Pointer to **float32** | The sub-index of the item in an item stack on which this discount should be applied | [optional] ## Methods @@ -85,6 +86,31 @@ HasPosition returns a boolean if a field has been set. SetPosition gets a reference to the given float32 and assigns it to the Position field. +### GetSubPosition + +`func (o *SetDiscountPerItemEffectProps) GetSubPosition() float32` + +GetSubPosition returns the SubPosition field if non-nil, zero value otherwise. + +### GetSubPositionOk + +`func (o *SetDiscountPerItemEffectProps) GetSubPositionOk() (float32, bool)` + +GetSubPositionOk returns a tuple with the SubPosition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubPosition + +`func (o *SetDiscountPerItemEffectProps) HasSubPosition() bool` + +HasSubPosition returns a boolean if a field has been set. + +### SetSubPosition + +`func (o *SetDiscountPerItemEffectProps) SetSubPosition(v float32)` + +SetSubPosition gets a reference to the given float32 and assigns it to the SubPosition field. + [[Back to Model list]](../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 67e74f06..0c0edca7 100644 --- a/docs/UpdateApplication.md +++ b/docs/UpdateApplication.md @@ -11,8 +11,12 @@ Name | Type | Description | Notes **CaseSensitivity** | Pointer to **string** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional] **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign | [optional] **Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] -**CampaignPriority** | Pointer to **string** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive) | [optional] +**CampaignPriority** | Pointer to **string** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional] +**ExclusiveCampaignsStrategy** | Pointer to **string** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional] +**EnableCascadingDiscounts** | Pointer to **bool** | Flag indicating if discounts should cascade for this application | [optional] +**EnableFlattenedCartItems** | Pointer to **bool** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one | [optional] **AttributesSettings** | Pointer to [**AttributesSettings**](AttributesSettings.md) | | [optional] +**Sandbox** | Pointer to **bool** | Flag indicating if this is a live or sandbox application | [optional] ## Methods @@ -216,6 +220,81 @@ HasCampaignPriority returns a boolean if a field has been set. SetCampaignPriority gets a reference to the given string and assigns it to the CampaignPriority field. +### GetExclusiveCampaignsStrategy + +`func (o *UpdateApplication) GetExclusiveCampaignsStrategy() string` + +GetExclusiveCampaignsStrategy returns the ExclusiveCampaignsStrategy field if non-nil, zero value otherwise. + +### GetExclusiveCampaignsStrategyOk + +`func (o *UpdateApplication) GetExclusiveCampaignsStrategyOk() (string, bool)` + +GetExclusiveCampaignsStrategyOk returns a tuple with the ExclusiveCampaignsStrategy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExclusiveCampaignsStrategy + +`func (o *UpdateApplication) HasExclusiveCampaignsStrategy() bool` + +HasExclusiveCampaignsStrategy returns a boolean if a field has been set. + +### SetExclusiveCampaignsStrategy + +`func (o *UpdateApplication) SetExclusiveCampaignsStrategy(v string)` + +SetExclusiveCampaignsStrategy gets a reference to the given string and assigns it to the ExclusiveCampaignsStrategy field. + +### GetEnableCascadingDiscounts + +`func (o *UpdateApplication) GetEnableCascadingDiscounts() bool` + +GetEnableCascadingDiscounts returns the EnableCascadingDiscounts field if non-nil, zero value otherwise. + +### GetEnableCascadingDiscountsOk + +`func (o *UpdateApplication) GetEnableCascadingDiscountsOk() (bool, bool)` + +GetEnableCascadingDiscountsOk returns a tuple with the EnableCascadingDiscounts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnableCascadingDiscounts + +`func (o *UpdateApplication) HasEnableCascadingDiscounts() bool` + +HasEnableCascadingDiscounts returns a boolean if a field has been set. + +### SetEnableCascadingDiscounts + +`func (o *UpdateApplication) SetEnableCascadingDiscounts(v bool)` + +SetEnableCascadingDiscounts gets a reference to the given bool and assigns it to the EnableCascadingDiscounts field. + +### GetEnableFlattenedCartItems + +`func (o *UpdateApplication) GetEnableFlattenedCartItems() bool` + +GetEnableFlattenedCartItems returns the EnableFlattenedCartItems field if non-nil, zero value otherwise. + +### GetEnableFlattenedCartItemsOk + +`func (o *UpdateApplication) GetEnableFlattenedCartItemsOk() (bool, bool)` + +GetEnableFlattenedCartItemsOk returns a tuple with the EnableFlattenedCartItems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnableFlattenedCartItems + +`func (o *UpdateApplication) HasEnableFlattenedCartItems() bool` + +HasEnableFlattenedCartItems returns a boolean if a field has been set. + +### SetEnableFlattenedCartItems + +`func (o *UpdateApplication) SetEnableFlattenedCartItems(v bool)` + +SetEnableFlattenedCartItems gets a reference to the given bool and assigns it to the EnableFlattenedCartItems field. + ### GetAttributesSettings `func (o *UpdateApplication) GetAttributesSettings() AttributesSettings` @@ -241,6 +320,31 @@ HasAttributesSettings returns a boolean if a field has been set. SetAttributesSettings gets a reference to the given AttributesSettings and assigns it to the AttributesSettings field. +### GetSandbox + +`func (o *UpdateApplication) GetSandbox() bool` + +GetSandbox returns the Sandbox field if non-nil, zero value otherwise. + +### GetSandboxOk + +`func (o *UpdateApplication) GetSandboxOk() (bool, bool)` + +GetSandboxOk returns a tuple with the Sandbox field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSandbox + +`func (o *UpdateApplication) HasSandbox() bool` + +HasSandbox returns a boolean if a field has been set. + +### SetSandbox + +`func (o *UpdateApplication) SetSandbox(v bool)` + +SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateAudience.md b/docs/UpdateAudience.md new file mode 100644 index 00000000..822969a2 --- /dev/null +++ b/docs/UpdateAudience.md @@ -0,0 +1,39 @@ +# UpdateAudience + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The human-friendly display name for this Audience. | + +## Methods + +### GetName + +`func (o *UpdateAudience) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UpdateAudience) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *UpdateAudience) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *UpdateAudience) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateCampaign.md b/docs/UpdateCampaign.md index 5f828cfe..58b48088 100644 --- a/docs/UpdateCampaign.md +++ b/docs/UpdateCampaign.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of limits that will operate for this campaign | +**CampaignGroups** | Pointer to **[]int32** | The IDs of the campaign groups that own this entity. | [optional] ## Methods @@ -319,6 +320,31 @@ HasLimits returns a boolean if a field has been set. SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. +### GetCampaignGroups + +`func (o *UpdateCampaign) GetCampaignGroups() []int32` + +GetCampaignGroups returns the CampaignGroups field if non-nil, zero value otherwise. + +### GetCampaignGroupsOk + +`func (o *UpdateCampaign) GetCampaignGroupsOk() ([]int32, bool)` + +GetCampaignGroupsOk returns a tuple with the CampaignGroups field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignGroups + +`func (o *UpdateCampaign) HasCampaignGroups() bool` + +HasCampaignGroups returns a boolean if a field has been set. + +### SetCampaignGroups + +`func (o *UpdateCampaign) SetCampaignGroups(v []int32)` + +SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UpdateCampaignGroup.md b/docs/UpdateCampaignGroup.md new file mode 100644 index 00000000..5edb3d02 --- /dev/null +++ b/docs/UpdateCampaignGroup.md @@ -0,0 +1,117 @@ +# UpdateCampaignGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of this campaign group. | +**Description** | Pointer to **string** | A longer description of the campaign group. | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this campaign group is enabled for | [optional] +**CampaignIds** | Pointer to **[]int32** | A list of the IDs of the campaigns that this campaign group owns | [optional] + +## Methods + +### GetName + +`func (o *UpdateCampaignGroup) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UpdateCampaignGroup) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *UpdateCampaignGroup) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *UpdateCampaignGroup) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *UpdateCampaignGroup) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *UpdateCampaignGroup) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *UpdateCampaignGroup) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *UpdateCampaignGroup) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetSubscribedApplicationsIds + +`func (o *UpdateCampaignGroup) GetSubscribedApplicationsIds() []int32` + +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. + +### GetSubscribedApplicationsIdsOk + +`func (o *UpdateCampaignGroup) GetSubscribedApplicationsIdsOk() ([]int32, bool)` + +GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubscribedApplicationsIds + +`func (o *UpdateCampaignGroup) HasSubscribedApplicationsIds() bool` + +HasSubscribedApplicationsIds returns a boolean if a field has been set. + +### SetSubscribedApplicationsIds + +`func (o *UpdateCampaignGroup) SetSubscribedApplicationsIds(v []int32)` + +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. + +### GetCampaignIds + +`func (o *UpdateCampaignGroup) GetCampaignIds() []int32` + +GetCampaignIds returns the CampaignIds field if non-nil, zero value otherwise. + +### GetCampaignIdsOk + +`func (o *UpdateCampaignGroup) GetCampaignIdsOk() ([]int32, bool)` + +GetCampaignIdsOk returns a tuple with the CampaignIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignIds + +`func (o *UpdateCampaignGroup) HasCampaignIds() bool` + +HasCampaignIds returns a boolean if a field has been set. + +### SetCampaignIds + +`func (o *UpdateCampaignGroup) SetCampaignIds(v []int32)` + +SetCampaignIds gets a reference to the given []int32 and assigns it to the CampaignIds field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateLoyaltyProgram.md b/docs/UpdateLoyaltyProgram.md index 207217ef..00f9b634 100644 --- a/docs/UpdateLoyaltyProgram.md +++ b/docs/UpdateLoyaltyProgram.md @@ -7,7 +7,8 @@ Name | Type | Description | Notes **Title** | Pointer to **string** | The display title for the Loyalty Program. | [optional] **Description** | Pointer to **string** | Description of our Loyalty Program. | [optional] **SubscribedApplications** | Pointer to **[]int32** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional] -**DefaultValidity** | Pointer to **string** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m' or '30d'. | [optional] +**DefaultValidity** | Pointer to **string** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. | [optional] +**DefaultPending** | Pointer to **string** | Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. | [optional] **AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program | [optional] ## Methods @@ -112,6 +113,31 @@ HasDefaultValidity returns a boolean if a field has been set. SetDefaultValidity gets a reference to the given string and assigns it to the DefaultValidity field. +### GetDefaultPending + +`func (o *UpdateLoyaltyProgram) GetDefaultPending() string` + +GetDefaultPending returns the DefaultPending field if non-nil, zero value otherwise. + +### GetDefaultPendingOk + +`func (o *UpdateLoyaltyProgram) GetDefaultPendingOk() (string, bool)` + +GetDefaultPendingOk returns a tuple with the DefaultPending field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDefaultPending + +`func (o *UpdateLoyaltyProgram) HasDefaultPending() bool` + +HasDefaultPending returns a boolean if a field has been set. + +### SetDefaultPending + +`func (o *UpdateLoyaltyProgram) SetDefaultPending(v string)` + +SetDefaultPending gets a reference to the given string and assigns it to the DefaultPending field. + ### GetAllowSubledger `func (o *UpdateLoyaltyProgram) GetAllowSubledger() bool` diff --git a/docs/UpdateUser.md b/docs/UpdateUser.md index 82983838..73fa46ef 100644 --- a/docs/UpdateUser.md +++ b/docs/UpdateUser.md @@ -7,8 +7,6 @@ Name | Type | Description | Notes **Name** | Pointer to **string** | Your name. | [optional] **Policy** | Pointer to **string** | a blob of acl json | [optional] **State** | Pointer to **string** | New state (\"deactivated\" or \"active\") for the user. Only usable by admins for the user. | [optional] -**ReleaseUpdate** | Pointer to **bool** | Update the user via email | [optional] -**LatestFeature** | Pointer to **string** | The latest feature you've been notified. | [optional] **Roles** | Pointer to **[]int32** | Update | [optional] **ApplicationNotificationSubscriptions** | Pointer to [**map[string]interface{}**](.md) | | [optional] @@ -89,56 +87,6 @@ HasState returns a boolean if a field has been set. SetState gets a reference to the given string and assigns it to the State field. -### GetReleaseUpdate - -`func (o *UpdateUser) GetReleaseUpdate() bool` - -GetReleaseUpdate returns the ReleaseUpdate field if non-nil, zero value otherwise. - -### GetReleaseUpdateOk - -`func (o *UpdateUser) GetReleaseUpdateOk() (bool, bool)` - -GetReleaseUpdateOk returns a tuple with the ReleaseUpdate field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasReleaseUpdate - -`func (o *UpdateUser) HasReleaseUpdate() bool` - -HasReleaseUpdate returns a boolean if a field has been set. - -### SetReleaseUpdate - -`func (o *UpdateUser) SetReleaseUpdate(v bool)` - -SetReleaseUpdate gets a reference to the given bool and assigns it to the ReleaseUpdate field. - -### GetLatestFeature - -`func (o *UpdateUser) GetLatestFeature() string` - -GetLatestFeature returns the LatestFeature field if non-nil, zero value otherwise. - -### GetLatestFeatureOk - -`func (o *UpdateUser) GetLatestFeatureOk() (string, bool)` - -GetLatestFeatureOk returns a tuple with the LatestFeature field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLatestFeature - -`func (o *UpdateUser) HasLatestFeature() bool` - -HasLatestFeature returns a boolean if a field has been set. - -### SetLatestFeature - -`func (o *UpdateUser) SetLatestFeature(v string)` - -SetLatestFeature gets a reference to the given string and assigns it to the LatestFeature field. - ### GetRoles `func (o *UpdateUser) GetRoles() []int32` diff --git a/docs/UpdateUserLatestFeedTimestamp.md b/docs/UpdateUserLatestFeedTimestamp.md new file mode 100644 index 00000000..268d4060 --- /dev/null +++ b/docs/UpdateUserLatestFeedTimestamp.md @@ -0,0 +1,39 @@ +# UpdateUserLatestFeedTimestamp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewLatestFeedTimestamp** | Pointer to [**time.Time**](time.Time.md) | New timestamp to update for the current user | + +## Methods + +### GetNewLatestFeedTimestamp + +`func (o *UpdateUserLatestFeedTimestamp) GetNewLatestFeedTimestamp() time.Time` + +GetNewLatestFeedTimestamp returns the NewLatestFeedTimestamp field if non-nil, zero value otherwise. + +### GetNewLatestFeedTimestampOk + +`func (o *UpdateUserLatestFeedTimestamp) GetNewLatestFeedTimestampOk() (time.Time, bool)` + +GetNewLatestFeedTimestampOk returns a tuple with the NewLatestFeedTimestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasNewLatestFeedTimestamp + +`func (o *UpdateUserLatestFeedTimestamp) HasNewLatestFeedTimestamp() bool` + +HasNewLatestFeedTimestamp returns a boolean if a field has been set. + +### SetNewLatestFeedTimestamp + +`func (o *UpdateUserLatestFeedTimestamp) SetNewLatestFeedTimestamp(v time.Time)` + +SetNewLatestFeedTimestamp gets a reference to the given time.Time and assigns it to the NewLatestFeedTimestamp field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/User.md b/docs/User.md index 928035ae..b22880d9 100644 --- a/docs/User.md +++ b/docs/User.md @@ -12,9 +12,8 @@ Name | Type | Description | Notes **InviteToken** | Pointer to **string** | Invite token, empty if the user as already accepted their invite. | **State** | Pointer to **string** | Current user state. | **Name** | Pointer to **string** | Full name | -**Policy** | Pointer to **string** | A blob of ACL JSON | -**ReleaseUpdate** | Pointer to **bool** | Update the user via email | -**LatestFeature** | Pointer to **string** | Latest feature the user has been notified. | [optional] +**Policy** | Pointer to [**map[string]interface{}**](.md) | User ACL Policy | +**LatestFeedTimestamp** | Pointer to [**time.Time**](time.Time.md) | Latest timestamp the user has been notified for feed. | [optional] **Roles** | Pointer to **[]int32** | Contains a list of all roles the user is a member of | [optional] **ApplicationNotificationSubscriptions** | Pointer to [**map[string]interface{}**](.md) | | [optional] **AuthMethod** | Pointer to **string** | The Authentication method for this user | [optional] @@ -223,13 +222,13 @@ SetName gets a reference to the given string and assigns it to the Name field. ### GetPolicy -`func (o *User) GetPolicy() string` +`func (o *User) GetPolicy() map[string]interface{}` GetPolicy returns the Policy field if non-nil, zero value otherwise. ### GetPolicyOk -`func (o *User) GetPolicyOk() (string, bool)` +`func (o *User) GetPolicyOk() (map[string]interface{}, bool)` GetPolicyOk returns a tuple with the Policy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -242,59 +241,34 @@ HasPolicy returns a boolean if a field has been set. ### SetPolicy -`func (o *User) SetPolicy(v string)` +`func (o *User) SetPolicy(v map[string]interface{})` -SetPolicy gets a reference to the given string and assigns it to the Policy field. +SetPolicy gets a reference to the given map[string]interface{} and assigns it to the Policy field. -### GetReleaseUpdate +### GetLatestFeedTimestamp -`func (o *User) GetReleaseUpdate() bool` +`func (o *User) GetLatestFeedTimestamp() time.Time` -GetReleaseUpdate returns the ReleaseUpdate field if non-nil, zero value otherwise. +GetLatestFeedTimestamp returns the LatestFeedTimestamp field if non-nil, zero value otherwise. -### GetReleaseUpdateOk +### GetLatestFeedTimestampOk -`func (o *User) GetReleaseUpdateOk() (bool, bool)` +`func (o *User) GetLatestFeedTimestampOk() (time.Time, bool)` -GetReleaseUpdateOk returns a tuple with the ReleaseUpdate field if it's non-nil, zero value otherwise +GetLatestFeedTimestampOk returns a tuple with the LatestFeedTimestamp field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasReleaseUpdate +### HasLatestFeedTimestamp -`func (o *User) HasReleaseUpdate() bool` +`func (o *User) HasLatestFeedTimestamp() bool` -HasReleaseUpdate returns a boolean if a field has been set. +HasLatestFeedTimestamp returns a boolean if a field has been set. -### SetReleaseUpdate +### SetLatestFeedTimestamp -`func (o *User) SetReleaseUpdate(v bool)` +`func (o *User) SetLatestFeedTimestamp(v time.Time)` -SetReleaseUpdate gets a reference to the given bool and assigns it to the ReleaseUpdate field. - -### GetLatestFeature - -`func (o *User) GetLatestFeature() string` - -GetLatestFeature returns the LatestFeature field if non-nil, zero value otherwise. - -### GetLatestFeatureOk - -`func (o *User) GetLatestFeatureOk() (string, bool)` - -GetLatestFeatureOk returns a tuple with the LatestFeature field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLatestFeature - -`func (o *User) HasLatestFeature() bool` - -HasLatestFeature returns a boolean if a field has been set. - -### SetLatestFeature - -`func (o *User) SetLatestFeature(v string)` - -SetLatestFeature gets a reference to the given string and assigns it to the LatestFeature field. +SetLatestFeedTimestamp gets a reference to the given time.Time and assigns it to the LatestFeedTimestamp field. ### GetRoles diff --git a/docs/UserFeedNotifications.md b/docs/UserFeedNotifications.md new file mode 100644 index 00000000..7cc4f520 --- /dev/null +++ b/docs/UserFeedNotifications.md @@ -0,0 +1,65 @@ +# UserFeedNotifications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LastUpdate** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the last request for this list | +**Notifications** | Pointer to [**[]FeedNotification**](FeedNotification.md) | List of all notifications to notify the user about | + +## Methods + +### GetLastUpdate + +`func (o *UserFeedNotifications) GetLastUpdate() time.Time` + +GetLastUpdate returns the LastUpdate field if non-nil, zero value otherwise. + +### GetLastUpdateOk + +`func (o *UserFeedNotifications) GetLastUpdateOk() (time.Time, bool)` + +GetLastUpdateOk returns a tuple with the LastUpdate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLastUpdate + +`func (o *UserFeedNotifications) HasLastUpdate() bool` + +HasLastUpdate returns a boolean if a field has been set. + +### SetLastUpdate + +`func (o *UserFeedNotifications) SetLastUpdate(v time.Time)` + +SetLastUpdate gets a reference to the given time.Time and assigns it to the LastUpdate field. + +### GetNotifications + +`func (o *UserFeedNotifications) GetNotifications() []FeedNotification` + +GetNotifications returns the Notifications field if non-nil, zero value otherwise. + +### GetNotificationsOk + +`func (o *UserFeedNotifications) GetNotificationsOk() ([]FeedNotification, bool)` + +GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasNotifications + +`func (o *UserFeedNotifications) HasNotifications() bool` + +HasNotifications returns a boolean if a field has been set. + +### SetNotifications + +`func (o *UserFeedNotifications) SetNotifications(v []FeedNotification)` + +SetNotifications gets a reference to the given []FeedNotification and assigns it to the Notifications field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/model_account_analytics.go b/model_account_analytics.go index e88645df..0b1bcc82 100644 --- a/model_account_analytics.go +++ b/model_account_analytics.go @@ -16,36 +16,42 @@ import ( // AccountAnalytics struct for AccountAnalytics type AccountAnalytics struct { - // Total Number of Applications inside the account + // Total number of applications in the account Applications int32 `json:"applications"` - // Total Number of Active Applications inside the account - ActiveCampaigns int32 `json:"activeCampaigns"` - // Total Number of campaigns inside the account + // Total number of live applications in the account + LiveApplications int32 `json:"liveApplications"` + // Total number of sandbox applications in the account + SandboxApplications int32 `json:"sandboxApplications"` + // Total number of campaigns in the account Campaigns int32 `json:"campaigns"` - // Total Number of coupons inside the account + // Total number of active campaigns in the account + ActiveCampaigns int32 `json:"activeCampaigns"` + // Total number of active campaigns in live applications in the account + LiveActiveCampaigns int32 `json:"liveActiveCampaigns"` + // Total number of coupons in the account Coupons int32 `json:"coupons"` - // Total Number of active coupons inside the account + // Total number of active coupons in the account ActiveCoupons int32 `json:"activeCoupons"` - // Total Number of expired coupons inside the account + // Total number of expired coupons in the account ExpiredCoupons int32 `json:"expiredCoupons"` - // Total Number of custom attributes inside the account - CustomAttributes int32 `json:"customAttributes"` - // Total Number of referral codes inside the account + // Total number of referral codes in the account ReferralCodes int32 `json:"referralCodes"` - // Total Number of active referral codes inside the account + // Total number of active referral codes in the account ActiveReferralCodes int32 `json:"activeReferralCodes"` - // Total Number of expired referral codes inside the account + // Total number of expired referral codes in the account ExpiredReferralCodes int32 `json:"expiredReferralCodes"` - // Total Number of users inside the account + // Total number of active rules in the account + ActiveRules int32 `json:"activeRules"` + // Total number of users in the account Users int32 `json:"users"` - // Total Number of roles inside the account + // Total number of roles in the account Roles int32 `json:"roles"` - // Total Number of webhooks inside the account + // Total number of custom attributes in the account + CustomAttributes int32 `json:"customAttributes"` + // Total number of webhooks in the account Webhooks int32 `json:"webhooks"` - // Total Number of loyalty programs inside the account + // Total number of loyalty programs in the account LoyaltyPrograms int32 `json:"loyaltyPrograms"` - // Total Number of active rules in the account - ActiveRules int32 `json:"activeRules"` } // GetApplications returns the Applications field value @@ -63,19 +69,34 @@ func (o *AccountAnalytics) SetApplications(v int32) { o.Applications = v } -// GetActiveCampaigns returns the ActiveCampaigns field value -func (o *AccountAnalytics) GetActiveCampaigns() int32 { +// GetLiveApplications returns the LiveApplications field value +func (o *AccountAnalytics) GetLiveApplications() int32 { if o == nil { var ret int32 return ret } - return o.ActiveCampaigns + return o.LiveApplications } -// SetActiveCampaigns sets field value -func (o *AccountAnalytics) SetActiveCampaigns(v int32) { - o.ActiveCampaigns = v +// SetLiveApplications sets field value +func (o *AccountAnalytics) SetLiveApplications(v int32) { + o.LiveApplications = v +} + +// GetSandboxApplications returns the SandboxApplications field value +func (o *AccountAnalytics) GetSandboxApplications() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.SandboxApplications +} + +// SetSandboxApplications sets field value +func (o *AccountAnalytics) SetSandboxApplications(v int32) { + o.SandboxApplications = v } // GetCampaigns returns the Campaigns field value @@ -93,6 +114,36 @@ func (o *AccountAnalytics) SetCampaigns(v int32) { o.Campaigns = v } +// GetActiveCampaigns returns the ActiveCampaigns field value +func (o *AccountAnalytics) GetActiveCampaigns() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ActiveCampaigns +} + +// SetActiveCampaigns sets field value +func (o *AccountAnalytics) SetActiveCampaigns(v int32) { + o.ActiveCampaigns = v +} + +// GetLiveActiveCampaigns returns the LiveActiveCampaigns field value +func (o *AccountAnalytics) GetLiveActiveCampaigns() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.LiveActiveCampaigns +} + +// SetLiveActiveCampaigns sets field value +func (o *AccountAnalytics) SetLiveActiveCampaigns(v int32) { + o.LiveActiveCampaigns = v +} + // GetCoupons returns the Coupons field value func (o *AccountAnalytics) GetCoupons() int32 { if o == nil { @@ -138,21 +189,6 @@ func (o *AccountAnalytics) SetExpiredCoupons(v int32) { o.ExpiredCoupons = v } -// GetCustomAttributes returns the CustomAttributes field value -func (o *AccountAnalytics) GetCustomAttributes() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.CustomAttributes -} - -// SetCustomAttributes sets field value -func (o *AccountAnalytics) SetCustomAttributes(v int32) { - o.CustomAttributes = v -} - // GetReferralCodes returns the ReferralCodes field value func (o *AccountAnalytics) GetReferralCodes() int32 { if o == nil { @@ -198,6 +234,21 @@ func (o *AccountAnalytics) SetExpiredReferralCodes(v int32) { o.ExpiredReferralCodes = v } +// GetActiveRules returns the ActiveRules field value +func (o *AccountAnalytics) GetActiveRules() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ActiveRules +} + +// SetActiveRules sets field value +func (o *AccountAnalytics) SetActiveRules(v int32) { + o.ActiveRules = v +} + // GetUsers returns the Users field value func (o *AccountAnalytics) GetUsers() int32 { if o == nil { @@ -228,6 +279,21 @@ func (o *AccountAnalytics) SetRoles(v int32) { o.Roles = v } +// GetCustomAttributes returns the CustomAttributes field value +func (o *AccountAnalytics) GetCustomAttributes() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CustomAttributes +} + +// SetCustomAttributes sets field value +func (o *AccountAnalytics) SetCustomAttributes(v int32) { + o.CustomAttributes = v +} + // GetWebhooks returns the Webhooks field value func (o *AccountAnalytics) GetWebhooks() int32 { if o == nil { @@ -258,21 +324,6 @@ func (o *AccountAnalytics) SetLoyaltyPrograms(v int32) { o.LoyaltyPrograms = v } -// GetActiveRules returns the ActiveRules field value -func (o *AccountAnalytics) GetActiveRules() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.ActiveRules -} - -// SetActiveRules sets field value -func (o *AccountAnalytics) SetActiveRules(v int32) { - o.ActiveRules = v -} - type NullableAccountAnalytics struct { Value AccountAnalytics ExplicitNull bool diff --git a/model_account_limits.go b/model_account_limits.go index 1aaf438b..5623fb68 100644 --- a/model_account_limits.go +++ b/model_account_limits.go @@ -16,29 +16,29 @@ import ( // AccountLimits struct for AccountLimits type AccountLimits struct { - // Total Number of allowed live applications in the account + // Total number of allowed live applications in the account LiveApplications int32 `json:"liveApplications"` - // Total Number of allowed sandbox applications in the account + // Total number of allowed sandbox applications in the account SandboxApplications int32 `json:"sandboxApplications"` - // Total Number of allowed active campaigns in the account + // Total number of allowed active campaigns in live applications in the account ActiveCampaigns int32 `json:"activeCampaigns"` - // Total Number of allowed coupons in the account + // Total number of allowed coupons in the account Coupons int32 `json:"coupons"` - // Total Number of allowed referral codes in the account + // Total number of allowed referral codes in the account ReferralCodes int32 `json:"referralCodes"` - // Total Number of allowed live loyalty programs in the account + // Total number of allowed active rulesets in the account + ActiveRules int32 `json:"activeRules"` + // Total number of allowed live loyalty programs in the account LiveLoyaltyPrograms int32 `json:"liveLoyaltyPrograms"` - // Total Number of allowed sandbox loyalty programs in the account + // Total number of allowed sandbox loyalty programs in the account SandboxLoyaltyPrograms int32 `json:"sandboxLoyaltyPrograms"` - // Total Number of allowed webhooks in the account + // Total number of allowed webhooks in the account Webhooks int32 `json:"webhooks"` - // Total Number of allowed users in the account + // Total number of allowed users in the account Users int32 `json:"users"` - // Total allowed api volume + // Allowed volume of API requests to the account ApiVolume int32 `json:"apiVolume"` - // Total allowed active rulesets - ActiveRules *int32 `json:"activeRules,omitempty"` - // array of rulesets where webhook is used + // Array of promotion types that are employed in the account PromotionTypes []string `json:"promotionTypes"` } @@ -117,6 +117,21 @@ func (o *AccountLimits) SetReferralCodes(v int32) { o.ReferralCodes = v } +// GetActiveRules returns the ActiveRules field value +func (o *AccountLimits) GetActiveRules() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ActiveRules +} + +// SetActiveRules sets field value +func (o *AccountLimits) SetActiveRules(v int32) { + o.ActiveRules = v +} + // GetLiveLoyaltyPrograms returns the LiveLoyaltyPrograms field value func (o *AccountLimits) GetLiveLoyaltyPrograms() int32 { if o == nil { @@ -192,39 +207,6 @@ func (o *AccountLimits) SetApiVolume(v int32) { o.ApiVolume = v } -// GetActiveRules returns the ActiveRules field value if set, zero value otherwise. -func (o *AccountLimits) GetActiveRules() int32 { - if o == nil || o.ActiveRules == nil { - var ret int32 - return ret - } - return *o.ActiveRules -} - -// GetActiveRulesOk returns a tuple with the ActiveRules field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *AccountLimits) GetActiveRulesOk() (int32, bool) { - if o == nil || o.ActiveRules == nil { - var ret int32 - return ret, false - } - return *o.ActiveRules, true -} - -// HasActiveRules returns a boolean if a field has been set. -func (o *AccountLimits) HasActiveRules() bool { - if o != nil && o.ActiveRules != nil { - return true - } - - return false -} - -// SetActiveRules gets a reference to the given int32 and assigns it to the ActiveRules field. -func (o *AccountLimits) SetActiveRules(v int32) { - o.ActiveRules = &v -} - // GetPromotionTypes returns the PromotionTypes field value func (o *AccountLimits) GetPromotionTypes() []string { if o == nil { diff --git a/model_add_loyalty_points_effect_props.go b/model_add_loyalty_points_effect_props.go index 5ee88613..823ac381 100644 --- a/model_add_loyalty_points_effect_props.go +++ b/model_add_loyalty_points_effect_props.go @@ -12,6 +12,7 @@ package talon import ( "bytes" "encoding/json" + "time" ) // AddLoyaltyPointsEffectProps The properties specific to the \"addLoyaltyPoints\" effect. This gets triggered whenever a validated rule contained an \"add loyalty\" effect. These points are automatically stored and managed inside Talon.One. @@ -26,8 +27,10 @@ type AddLoyaltyPointsEffectProps struct { Value float32 `json:"value"` // The user for whom these points were added RecipientIntegrationId string `json:"recipientIntegrationId"` - // The amount of time (in days) these points are valid - ExpiryCondition string `json:"expiryCondition"` + // Date after which points will be valid + StartDate *time.Time `json:"startDate,omitempty"` + // Date after which points will expire + ExpiryDate *time.Time `json:"expiryDate,omitempty"` } // GetName returns the Name field value @@ -105,19 +108,70 @@ func (o *AddLoyaltyPointsEffectProps) SetRecipientIntegrationId(v string) { o.RecipientIntegrationId = v } -// GetExpiryCondition returns the ExpiryCondition field value -func (o *AddLoyaltyPointsEffectProps) GetExpiryCondition() string { - if o == nil { - var ret string +// GetStartDate returns the StartDate field value if set, zero value otherwise. +func (o *AddLoyaltyPointsEffectProps) GetStartDate() time.Time { + if o == nil || o.StartDate == nil { + var ret time.Time return ret } + return *o.StartDate +} + +// GetStartDateOk returns a tuple with the StartDate field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddLoyaltyPointsEffectProps) GetStartDateOk() (time.Time, bool) { + if o == nil || o.StartDate == nil { + var ret time.Time + return ret, false + } + return *o.StartDate, true +} + +// HasStartDate returns a boolean if a field has been set. +func (o *AddLoyaltyPointsEffectProps) HasStartDate() bool { + if o != nil && o.StartDate != nil { + return true + } + + return false +} + +// SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. +func (o *AddLoyaltyPointsEffectProps) SetStartDate(v time.Time) { + o.StartDate = &v +} + +// GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise. +func (o *AddLoyaltyPointsEffectProps) GetExpiryDate() time.Time { + if o == nil || o.ExpiryDate == nil { + var ret time.Time + return ret + } + return *o.ExpiryDate +} + +// GetExpiryDateOk returns a tuple with the ExpiryDate field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *AddLoyaltyPointsEffectProps) GetExpiryDateOk() (time.Time, bool) { + if o == nil || o.ExpiryDate == nil { + var ret time.Time + return ret, false + } + return *o.ExpiryDate, true +} + +// HasExpiryDate returns a boolean if a field has been set. +func (o *AddLoyaltyPointsEffectProps) HasExpiryDate() bool { + if o != nil && o.ExpiryDate != nil { + return true + } - return o.ExpiryCondition + return false } -// SetExpiryCondition sets field value -func (o *AddLoyaltyPointsEffectProps) SetExpiryCondition(v string) { - o.ExpiryCondition = v +// SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +func (o *AddLoyaltyPointsEffectProps) SetExpiryDate(v time.Time) { + o.ExpiryDate = &v } type NullableAddLoyaltyPointsEffectProps struct { diff --git a/model_application.go b/model_application.go index 4389fadc..97eae3bf 100644 --- a/model_application.go +++ b/model_application.go @@ -39,9 +39,17 @@ type Application struct { Attributes *map[string]interface{} `json:"attributes,omitempty"` // Default limits for campaigns created in this application Limits *[]LimitConfig `json:"limits,omitempty"` - // Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive) - CampaignPriority *string `json:"campaignPriority,omitempty"` - AttributesSettings *AttributesSettings `json:"attributesSettings,omitempty"` + // Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" + CampaignPriority *string `json:"campaignPriority,omitempty"` + // The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" + ExclusiveCampaignsStrategy *string `json:"exclusiveCampaignsStrategy,omitempty"` + // Flag indicating if discounts should cascade for this application + EnableCascadingDiscounts *bool `json:"enableCascadingDiscounts,omitempty"` + // Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one + EnableFlattenedCartItems *bool `json:"enableFlattenedCartItems,omitempty"` + AttributesSettings *AttributesSettings `json:"attributesSettings,omitempty"` + // Flag indicating if this is a live or sandbox application + Sandbox *bool `json:"sandbox,omitempty"` // An array containing all the loyalty programs to which this application is subscribed LoyaltyPrograms []LoyaltyProgram `json:"loyaltyPrograms"` } @@ -316,6 +324,105 @@ func (o *Application) SetCampaignPriority(v string) { o.CampaignPriority = &v } +// GetExclusiveCampaignsStrategy returns the ExclusiveCampaignsStrategy field value if set, zero value otherwise. +func (o *Application) GetExclusiveCampaignsStrategy() string { + if o == nil || o.ExclusiveCampaignsStrategy == nil { + var ret string + return ret + } + return *o.ExclusiveCampaignsStrategy +} + +// GetExclusiveCampaignsStrategyOk returns a tuple with the ExclusiveCampaignsStrategy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Application) GetExclusiveCampaignsStrategyOk() (string, bool) { + if o == nil || o.ExclusiveCampaignsStrategy == nil { + var ret string + return ret, false + } + return *o.ExclusiveCampaignsStrategy, true +} + +// HasExclusiveCampaignsStrategy returns a boolean if a field has been set. +func (o *Application) HasExclusiveCampaignsStrategy() bool { + if o != nil && o.ExclusiveCampaignsStrategy != nil { + return true + } + + return false +} + +// SetExclusiveCampaignsStrategy gets a reference to the given string and assigns it to the ExclusiveCampaignsStrategy field. +func (o *Application) SetExclusiveCampaignsStrategy(v string) { + o.ExclusiveCampaignsStrategy = &v +} + +// GetEnableCascadingDiscounts returns the EnableCascadingDiscounts field value if set, zero value otherwise. +func (o *Application) GetEnableCascadingDiscounts() bool { + if o == nil || o.EnableCascadingDiscounts == nil { + var ret bool + return ret + } + return *o.EnableCascadingDiscounts +} + +// GetEnableCascadingDiscountsOk returns a tuple with the EnableCascadingDiscounts field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Application) GetEnableCascadingDiscountsOk() (bool, bool) { + if o == nil || o.EnableCascadingDiscounts == nil { + var ret bool + return ret, false + } + return *o.EnableCascadingDiscounts, true +} + +// HasEnableCascadingDiscounts returns a boolean if a field has been set. +func (o *Application) HasEnableCascadingDiscounts() bool { + if o != nil && o.EnableCascadingDiscounts != nil { + return true + } + + return false +} + +// SetEnableCascadingDiscounts gets a reference to the given bool and assigns it to the EnableCascadingDiscounts field. +func (o *Application) SetEnableCascadingDiscounts(v bool) { + o.EnableCascadingDiscounts = &v +} + +// GetEnableFlattenedCartItems returns the EnableFlattenedCartItems field value if set, zero value otherwise. +func (o *Application) GetEnableFlattenedCartItems() bool { + if o == nil || o.EnableFlattenedCartItems == nil { + var ret bool + return ret + } + return *o.EnableFlattenedCartItems +} + +// GetEnableFlattenedCartItemsOk returns a tuple with the EnableFlattenedCartItems field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Application) GetEnableFlattenedCartItemsOk() (bool, bool) { + if o == nil || o.EnableFlattenedCartItems == nil { + var ret bool + return ret, false + } + return *o.EnableFlattenedCartItems, true +} + +// HasEnableFlattenedCartItems returns a boolean if a field has been set. +func (o *Application) HasEnableFlattenedCartItems() bool { + if o != nil && o.EnableFlattenedCartItems != nil { + return true + } + + return false +} + +// SetEnableFlattenedCartItems gets a reference to the given bool and assigns it to the EnableFlattenedCartItems field. +func (o *Application) SetEnableFlattenedCartItems(v bool) { + o.EnableFlattenedCartItems = &v +} + // GetAttributesSettings returns the AttributesSettings field value if set, zero value otherwise. func (o *Application) GetAttributesSettings() AttributesSettings { if o == nil || o.AttributesSettings == nil { @@ -349,6 +456,39 @@ func (o *Application) SetAttributesSettings(v AttributesSettings) { o.AttributesSettings = &v } +// GetSandbox returns the Sandbox field value if set, zero value otherwise. +func (o *Application) GetSandbox() bool { + if o == nil || o.Sandbox == nil { + var ret bool + return ret + } + return *o.Sandbox +} + +// GetSandboxOk returns a tuple with the Sandbox field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Application) GetSandboxOk() (bool, bool) { + if o == nil || o.Sandbox == nil { + var ret bool + return ret, false + } + return *o.Sandbox, true +} + +// HasSandbox returns a boolean if a field has been set. +func (o *Application) HasSandbox() bool { + if o != nil && o.Sandbox != nil { + return true + } + + return false +} + +// SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. +func (o *Application) SetSandbox(v bool) { + o.Sandbox = &v +} + // GetLoyaltyPrograms returns the LoyaltyPrograms field value func (o *Application) GetLoyaltyPrograms() []LoyaltyProgram { if o == nil { diff --git a/model_application_api_key.go b/model_application_api_key.go index ef999e23..dd244cff 100644 --- a/model_application_api_key.go +++ b/model_application_api_key.go @@ -15,22 +15,87 @@ import ( "time" ) -// ApplicationApiKey struct for ApplicationApiKey +// ApplicationApiKey type ApplicationApiKey struct { + // Title for API Key + Title string `json:"title"` + // The date the API key expired + Expires time.Time `json:"expires"` + // Platform the API key is valid for. + Platform *string `json:"platform,omitempty"` // ID of the API Key Id int32 `json:"id"` // ID of user who created CreatedBy int32 `json:"createdBy"` - // Title for API Key - Title string `json:"title"` // ID of account the key is used for AccountID int32 `json:"accountID"` // ID of application the key is used for ApplicationID int32 `json:"applicationID"` // The date the API key was created Created time.Time `json:"created"` - // The date the API key expired - Expires time.Time `json:"expires"` +} + +// GetTitle returns the Title field value +func (o *ApplicationApiKey) GetTitle() string { + if o == nil { + var ret string + return ret + } + + return o.Title +} + +// SetTitle sets field value +func (o *ApplicationApiKey) SetTitle(v string) { + o.Title = v +} + +// GetExpires returns the Expires field value +func (o *ApplicationApiKey) GetExpires() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Expires +} + +// SetExpires sets field value +func (o *ApplicationApiKey) SetExpires(v time.Time) { + o.Expires = v +} + +// GetPlatform returns the Platform field value if set, zero value otherwise. +func (o *ApplicationApiKey) GetPlatform() string { + if o == nil || o.Platform == nil { + var ret string + return ret + } + return *o.Platform +} + +// GetPlatformOk returns a tuple with the Platform field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ApplicationApiKey) GetPlatformOk() (string, bool) { + if o == nil || o.Platform == nil { + var ret string + return ret, false + } + return *o.Platform, true +} + +// HasPlatform returns a boolean if a field has been set. +func (o *ApplicationApiKey) HasPlatform() bool { + if o != nil && o.Platform != nil { + return true + } + + return false +} + +// SetPlatform gets a reference to the given string and assigns it to the Platform field. +func (o *ApplicationApiKey) SetPlatform(v string) { + o.Platform = &v } // GetId returns the Id field value @@ -63,21 +128,6 @@ func (o *ApplicationApiKey) SetCreatedBy(v int32) { o.CreatedBy = v } -// GetTitle returns the Title field value -func (o *ApplicationApiKey) GetTitle() string { - if o == nil { - var ret string - return ret - } - - return o.Title -} - -// SetTitle sets field value -func (o *ApplicationApiKey) SetTitle(v string) { - o.Title = v -} - // GetAccountID returns the AccountID field value func (o *ApplicationApiKey) GetAccountID() int32 { if o == nil { @@ -123,21 +173,6 @@ func (o *ApplicationApiKey) SetCreated(v time.Time) { o.Created = v } -// GetExpires returns the Expires field value -func (o *ApplicationApiKey) GetExpires() time.Time { - if o == nil { - var ret time.Time - return ret - } - - return o.Expires -} - -// SetExpires sets field value -func (o *ApplicationApiKey) SetExpires(v time.Time) { - o.Expires = v -} - type NullableApplicationApiKey struct { Value ApplicationApiKey ExplicitNull bool diff --git a/model_application_customer.go b/model_application_customer.go index 7948a030..c11d1160 100644 --- a/model_application_customer.go +++ b/model_application_customer.go @@ -21,7 +21,7 @@ type ApplicationCustomer struct { Id int32 `json:"id"` // The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. Created time.Time `json:"created"` - // The ID used for this entity in the application system. The ID used for this entity in the application system. + // The integration ID for this entity sent to and used in the Talon.One system. The integration ID for this entity sent to and used in the Talon.One system. IntegrationId string `json:"integrationId"` // Arbitrary properties associated with this item Attributes map[string]interface{} `json:"attributes"` @@ -33,6 +33,8 @@ type ApplicationCustomer struct { TotalSales float32 `json:"totalSales"` // A list of loyalty programs joined by the customer LoyaltyMemberships *[]LoyaltyMembership `json:"loyaltyMemberships,omitempty"` + // A list of audiences the customer belongs to + AudienceMemberships *[]AudienceMembership `json:"audienceMemberships,omitempty"` // Timestamp of the most recent event received from this customer LastActivity time.Time `json:"lastActivity"` } @@ -175,6 +177,39 @@ func (o *ApplicationCustomer) SetLoyaltyMemberships(v []LoyaltyMembership) { o.LoyaltyMemberships = &v } +// GetAudienceMemberships returns the AudienceMemberships field value if set, zero value otherwise. +func (o *ApplicationCustomer) GetAudienceMemberships() []AudienceMembership { + if o == nil || o.AudienceMemberships == nil { + var ret []AudienceMembership + return ret + } + return *o.AudienceMemberships +} + +// GetAudienceMembershipsOk returns a tuple with the AudienceMemberships field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ApplicationCustomer) GetAudienceMembershipsOk() ([]AudienceMembership, bool) { + if o == nil || o.AudienceMemberships == nil { + var ret []AudienceMembership + return ret, false + } + return *o.AudienceMemberships, true +} + +// HasAudienceMemberships returns a boolean if a field has been set. +func (o *ApplicationCustomer) HasAudienceMemberships() bool { + if o != nil && o.AudienceMemberships != nil { + return true + } + + return false +} + +// SetAudienceMemberships gets a reference to the given []AudienceMembership and assigns it to the AudienceMemberships field. +func (o *ApplicationCustomer) SetAudienceMemberships(v []AudienceMembership) { + o.AudienceMemberships = &v +} + // GetLastActivity returns the LastActivity field value func (o *ApplicationCustomer) GetLastActivity() time.Time { if o == nil { diff --git a/model_application_session.go b/model_application_session.go index bd66202f..5de8626c 100644 --- a/model_application_session.go +++ b/model_application_session.go @@ -25,7 +25,7 @@ type ApplicationSession struct { ApplicationId int32 `json:"applicationId"` // The globally unique Talon.One ID of the customer that created this entity. ProfileId *int32 `json:"profileId,omitempty"` - // The ID used for this entity in the application system. + // The integration ID for this entity sent to and used in the Talon.One system. IntegrationId string `json:"integrationId"` // Integration ID of the customer for the session. Profileintegrationid *string `json:"profileintegrationid,omitempty"` diff --git a/model_audience.go b/model_audience.go new file mode 100644 index 00000000..453d7251 --- /dev/null +++ b/model_audience.go @@ -0,0 +1,145 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// Audience +type Audience struct { + // The ID of the account that owns this entity. + AccountId int32 `json:"accountId"` + // Unique ID for this entity. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The human-friendly display name for this Audience. + Name string `json:"name"` + // Integration that this audience was created in. + Integration string `json:"integration"` + // The ID of this Audience in the third-party integration + IntegrationId string `json:"integrationId"` +} + +// GetAccountId returns the AccountId field value +func (o *Audience) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *Audience) SetAccountId(v int32) { + o.AccountId = v +} + +// GetId returns the Id field value +func (o *Audience) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *Audience) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *Audience) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *Audience) SetCreated(v time.Time) { + o.Created = v +} + +// GetName returns the Name field value +func (o *Audience) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *Audience) SetName(v string) { + o.Name = v +} + +// GetIntegration returns the Integration field value +func (o *Audience) GetIntegration() string { + if o == nil { + var ret string + return ret + } + + return o.Integration +} + +// SetIntegration sets field value +func (o *Audience) SetIntegration(v string) { + o.Integration = v +} + +// GetIntegrationId returns the IntegrationId field value +func (o *Audience) GetIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.IntegrationId +} + +// SetIntegrationId sets field value +func (o *Audience) SetIntegrationId(v string) { + o.IntegrationId = v +} + +type NullableAudience struct { + Value Audience + ExplicitNull bool +} + +func (v NullableAudience) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAudience) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_audience_membership.go b/model_audience_membership.go new file mode 100644 index 00000000..0f50f93d --- /dev/null +++ b/model_audience_membership.go @@ -0,0 +1,76 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// AudienceMembership struct for AudienceMembership +type AudienceMembership struct { + // The ID of the audience belonging to this entity. + Id int32 `json:"id"` + // The Name of the audience belonging to this entity. + Name string `json:"name"` +} + +// GetId returns the Id field value +func (o *AudienceMembership) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *AudienceMembership) SetId(v int32) { + o.Id = v +} + +// GetName returns the Name field value +func (o *AudienceMembership) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *AudienceMembership) SetName(v string) { + o.Name = v +} + +type NullableAudienceMembership struct { + Value AudienceMembership + ExplicitNull bool +} + +func (v NullableAudienceMembership) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAudienceMembership) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign.go b/model_campaign.go index 5eecfeb7..474893f1 100644 --- a/model_campaign.go +++ b/model_campaign.go @@ -47,6 +47,8 @@ type Campaign struct { ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` // The set of limits that will operate for this campaign Limits []LimitConfig `json:"limits"` + // The IDs of the campaign groups that own this entity. + CampaignGroups *[]int32 `json:"campaignGroups,omitempty"` // Number of coupons redeemed in the campaign. CouponRedemptionCount *int32 `json:"couponRedemptionCount,omitempty"` // Number of referral codes redeemed in the campaign. @@ -415,6 +417,39 @@ func (o *Campaign) SetLimits(v []LimitConfig) { o.Limits = v } +// GetCampaignGroups returns the CampaignGroups field value if set, zero value otherwise. +func (o *Campaign) GetCampaignGroups() []int32 { + if o == nil || o.CampaignGroups == nil { + var ret []int32 + return ret + } + return *o.CampaignGroups +} + +// GetCampaignGroupsOk returns a tuple with the CampaignGroups field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Campaign) GetCampaignGroupsOk() ([]int32, bool) { + if o == nil || o.CampaignGroups == nil { + var ret []int32 + return ret, false + } + return *o.CampaignGroups, true +} + +// HasCampaignGroups returns a boolean if a field has been set. +func (o *Campaign) HasCampaignGroups() bool { + if o != nil && o.CampaignGroups != nil { + return true + } + + return false +} + +// SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. +func (o *Campaign) SetCampaignGroups(v []int32) { + o.CampaignGroups = &v +} + // GetCouponRedemptionCount returns the CouponRedemptionCount field value if set, zero value otherwise. func (o *Campaign) GetCouponRedemptionCount() int32 { if o == nil || o.CouponRedemptionCount == nil { diff --git a/model_campaign_analytics.go b/model_campaign_analytics.go index 092fbd8e..db19c3d7 100644 --- a/model_campaign_analytics.go +++ b/model_campaign_analytics.go @@ -58,6 +58,14 @@ type CampaignAnalytics struct { ReferralsCreated int32 `json:"referralsCreated"` // Number of referrals created in the campaign by the rule engine since it began. TotalReferralsCreated int32 `json:"totalReferralsCreated"` + // Number of added loyalty points in the campaign in a specific interval. + AddedLoyaltyPoints float32 `json:"addedLoyaltyPoints"` + // Number of added loyalty points in the campaign since it began. + TotalAddedLoyaltyPoints float32 `json:"totalAddedLoyaltyPoints"` + // Number of deducted loyalty points in the campaign in a specific interval. + DeductedLoyaltyPoints float32 `json:"deductedLoyaltyPoints"` + // Number of deducted loyalty points in the campaign since it began. + TotalDeductedLoyaltyPoints float32 `json:"totalDeductedLoyaltyPoints"` } // GetDate returns the Date field value @@ -375,6 +383,66 @@ func (o *CampaignAnalytics) SetTotalReferralsCreated(v int32) { o.TotalReferralsCreated = v } +// GetAddedLoyaltyPoints returns the AddedLoyaltyPoints field value +func (o *CampaignAnalytics) GetAddedLoyaltyPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.AddedLoyaltyPoints +} + +// SetAddedLoyaltyPoints sets field value +func (o *CampaignAnalytics) SetAddedLoyaltyPoints(v float32) { + o.AddedLoyaltyPoints = v +} + +// GetTotalAddedLoyaltyPoints returns the TotalAddedLoyaltyPoints field value +func (o *CampaignAnalytics) GetTotalAddedLoyaltyPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalAddedLoyaltyPoints +} + +// SetTotalAddedLoyaltyPoints sets field value +func (o *CampaignAnalytics) SetTotalAddedLoyaltyPoints(v float32) { + o.TotalAddedLoyaltyPoints = v +} + +// GetDeductedLoyaltyPoints returns the DeductedLoyaltyPoints field value +func (o *CampaignAnalytics) GetDeductedLoyaltyPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.DeductedLoyaltyPoints +} + +// SetDeductedLoyaltyPoints sets field value +func (o *CampaignAnalytics) SetDeductedLoyaltyPoints(v float32) { + o.DeductedLoyaltyPoints = v +} + +// GetTotalDeductedLoyaltyPoints returns the TotalDeductedLoyaltyPoints field value +func (o *CampaignAnalytics) GetTotalDeductedLoyaltyPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalDeductedLoyaltyPoints +} + +// SetTotalDeductedLoyaltyPoints sets field value +func (o *CampaignAnalytics) SetTotalDeductedLoyaltyPoints(v float32) { + o.TotalDeductedLoyaltyPoints = v +} + type NullableCampaignAnalytics struct { Value CampaignAnalytics ExplicitNull bool diff --git a/model_campaign_copy.go b/model_campaign_copy.go index 24fda38e..c1c8e5cc 100644 --- a/model_campaign_copy.go +++ b/model_campaign_copy.go @@ -20,7 +20,7 @@ type CampaignCopy struct { // Name of the copied campaign (Defaults to \"Copy of original campaign name\") Name *string `json:"name,omitempty"` // Application IDs of the applications to which a campaign should be copied to - ApplicationIds []string `json:"applicationIds"` + ApplicationIds []int32 `json:"applicationIds"` // A detailed description of the campaign. Description *string `json:"description,omitempty"` // Datetime when the campaign will become active. @@ -65,9 +65,9 @@ func (o *CampaignCopy) SetName(v string) { } // GetApplicationIds returns the ApplicationIds field value -func (o *CampaignCopy) GetApplicationIds() []string { +func (o *CampaignCopy) GetApplicationIds() []int32 { if o == nil { - var ret []string + var ret []int32 return ret } @@ -75,7 +75,7 @@ func (o *CampaignCopy) GetApplicationIds() []string { } // SetApplicationIds sets field value -func (o *CampaignCopy) SetApplicationIds(v []string) { +func (o *CampaignCopy) SetApplicationIds(v []int32) { o.ApplicationIds = v } diff --git a/model_campaign_group.go b/model_campaign_group.go new file mode 100644 index 00000000..514552b7 --- /dev/null +++ b/model_campaign_group.go @@ -0,0 +1,233 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// CampaignGroup +type CampaignGroup struct { + // Unique ID for this entity. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The exact moment this entity was last modified. + Modified time.Time `json:"modified"` + // The ID of the account that owns this entity. + AccountId int32 `json:"accountId"` + // The name of this campaign group. + Name string `json:"name"` + // A longer description of the campaign group. + Description *string `json:"description,omitempty"` + // A list of the IDs of the applications that this campaign group is enabled for + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // A list of the IDs of the campaigns that this campaign group owns + CampaignIds *[]int32 `json:"campaignIds,omitempty"` +} + +// GetId returns the Id field value +func (o *CampaignGroup) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *CampaignGroup) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *CampaignGroup) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *CampaignGroup) SetCreated(v time.Time) { + o.Created = v +} + +// GetModified returns the Modified field value +func (o *CampaignGroup) GetModified() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Modified +} + +// SetModified sets field value +func (o *CampaignGroup) SetModified(v time.Time) { + o.Modified = v +} + +// GetAccountId returns the AccountId field value +func (o *CampaignGroup) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *CampaignGroup) SetAccountId(v int32) { + o.AccountId = v +} + +// GetName returns the Name field value +func (o *CampaignGroup) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *CampaignGroup) SetName(v string) { + o.Name = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *CampaignGroup) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignGroup) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *CampaignGroup) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *CampaignGroup) SetDescription(v string) { + o.Description = &v +} + +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *CampaignGroup) GetSubscribedApplicationsIds() []int32 { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret + } + return *o.SubscribedApplicationsIds +} + +// GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignGroup) GetSubscribedApplicationsIdsOk() ([]int32, bool) { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret, false + } + return *o.SubscribedApplicationsIds, true +} + +// HasSubscribedApplicationsIds returns a boolean if a field has been set. +func (o *CampaignGroup) HasSubscribedApplicationsIds() bool { + if o != nil && o.SubscribedApplicationsIds != nil { + return true + } + + return false +} + +// SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +func (o *CampaignGroup) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +// GetCampaignIds returns the CampaignIds field value if set, zero value otherwise. +func (o *CampaignGroup) GetCampaignIds() []int32 { + if o == nil || o.CampaignIds == nil { + var ret []int32 + return ret + } + return *o.CampaignIds +} + +// GetCampaignIdsOk returns a tuple with the CampaignIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignGroup) GetCampaignIdsOk() ([]int32, bool) { + if o == nil || o.CampaignIds == nil { + var ret []int32 + return ret, false + } + return *o.CampaignIds, true +} + +// HasCampaignIds returns a boolean if a field has been set. +func (o *CampaignGroup) HasCampaignIds() bool { + if o != nil && o.CampaignIds != nil { + return true + } + + return false +} + +// SetCampaignIds gets a reference to the given []int32 and assigns it to the CampaignIds field. +func (o *CampaignGroup) SetCampaignIds(v []int32) { + o.CampaignIds = &v +} + +type NullableCampaignGroup struct { + Value CampaignGroup + ExplicitNull bool +} + +func (v NullableCampaignGroup) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignGroup) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_group_entity.go b/model_campaign_group_entity.go new file mode 100644 index 00000000..fa78254e --- /dev/null +++ b/model_campaign_group_entity.go @@ -0,0 +1,77 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignGroupEntity struct for CampaignGroupEntity +type CampaignGroupEntity struct { + // The IDs of the campaign groups that own this entity. + CampaignGroups *[]int32 `json:"campaignGroups,omitempty"` +} + +// GetCampaignGroups returns the CampaignGroups field value if set, zero value otherwise. +func (o *CampaignGroupEntity) GetCampaignGroups() []int32 { + if o == nil || o.CampaignGroups == nil { + var ret []int32 + return ret + } + return *o.CampaignGroups +} + +// GetCampaignGroupsOk returns a tuple with the CampaignGroups field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignGroupEntity) GetCampaignGroupsOk() ([]int32, bool) { + if o == nil || o.CampaignGroups == nil { + var ret []int32 + return ret, false + } + return *o.CampaignGroups, true +} + +// HasCampaignGroups returns a boolean if a field has been set. +func (o *CampaignGroupEntity) HasCampaignGroups() bool { + if o != nil && o.CampaignGroups != nil { + return true + } + + return false +} + +// SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. +func (o *CampaignGroupEntity) SetCampaignGroups(v []int32) { + o.CampaignGroups = &v +} + +type NullableCampaignGroupEntity struct { + Value CampaignGroupEntity + ExplicitNull bool +} + +func (v NullableCampaignGroupEntity) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignGroupEntity) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_create_application_api_key.go b/model_create_application_api_key.go index bc21be3c..33dc0ac2 100644 --- a/model_create_application_api_key.go +++ b/model_create_application_api_key.go @@ -21,6 +21,8 @@ type CreateApplicationApiKey struct { Title string `json:"title"` // The date the API key expired Expires time.Time `json:"expires"` + // Platform the API key is valid for. + Platform *string `json:"platform,omitempty"` } // GetTitle returns the Title field value @@ -53,6 +55,39 @@ func (o *CreateApplicationApiKey) SetExpires(v time.Time) { o.Expires = v } +// GetPlatform returns the Platform field value if set, zero value otherwise. +func (o *CreateApplicationApiKey) GetPlatform() string { + if o == nil || o.Platform == nil { + var ret string + return ret + } + return *o.Platform +} + +// GetPlatformOk returns a tuple with the Platform field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CreateApplicationApiKey) GetPlatformOk() (string, bool) { + if o == nil || o.Platform == nil { + var ret string + return ret, false + } + return *o.Platform, true +} + +// HasPlatform returns a boolean if a field has been set. +func (o *CreateApplicationApiKey) HasPlatform() bool { + if o != nil && o.Platform != nil { + return true + } + + return false +} + +// SetPlatform gets a reference to the given string and assigns it to the Platform field. +func (o *CreateApplicationApiKey) SetPlatform(v string) { + o.Platform = &v +} + type NullableCreateApplicationApiKey struct { Value CreateApplicationApiKey ExplicitNull bool diff --git a/model_customer_activity_report.go b/model_customer_activity_report.go index 287ffe3b..0975a4e0 100644 --- a/model_customer_activity_report.go +++ b/model_customer_activity_report.go @@ -17,7 +17,7 @@ import ( // CustomerActivityReport type CustomerActivityReport struct { - // The ID used for this entity in the application system. + // The integration ID for this entity sent to and used in the Talon.One system. IntegrationId string `json:"integrationId"` // The exact moment this entity was created. Created time.Time `json:"created"` diff --git a/model_customer_inventory.go b/model_customer_inventory.go index fa2f3bd2..19336599 100644 --- a/model_customer_inventory.go +++ b/model_customer_inventory.go @@ -17,6 +17,7 @@ import ( // CustomerInventory struct for CustomerInventory type CustomerInventory struct { Profile *CustomerProfile `json:"profile,omitempty"` + Loyalty *Loyalty `json:"loyalty,omitempty"` Referrals *[]Referral `json:"referrals,omitempty"` Coupons *[]Coupon `json:"coupons,omitempty"` } @@ -54,6 +55,39 @@ func (o *CustomerInventory) SetProfile(v CustomerProfile) { o.Profile = &v } +// GetLoyalty returns the Loyalty field value if set, zero value otherwise. +func (o *CustomerInventory) GetLoyalty() Loyalty { + if o == nil || o.Loyalty == nil { + var ret Loyalty + return ret + } + return *o.Loyalty +} + +// GetLoyaltyOk returns a tuple with the Loyalty field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CustomerInventory) GetLoyaltyOk() (Loyalty, bool) { + if o == nil || o.Loyalty == nil { + var ret Loyalty + return ret, false + } + return *o.Loyalty, true +} + +// HasLoyalty returns a boolean if a field has been set. +func (o *CustomerInventory) HasLoyalty() bool { + if o != nil && o.Loyalty != nil { + return true + } + + return false +} + +// SetLoyalty gets a reference to the given Loyalty and assigns it to the Loyalty field. +func (o *CustomerInventory) SetLoyalty(v Loyalty) { + o.Loyalty = &v +} + // GetReferrals returns the Referrals field value if set, zero value otherwise. func (o *CustomerInventory) GetReferrals() []Referral { if o == nil || o.Referrals == nil { diff --git a/model_customer_profile.go b/model_customer_profile.go index 68f33c51..7bdb0351 100644 --- a/model_customer_profile.go +++ b/model_customer_profile.go @@ -17,7 +17,7 @@ import ( // CustomerProfile type CustomerProfile struct { - // The ID used for this entity in the application system. + // The integration ID for this entity sent to and used in the Talon.One system. IntegrationId string `json:"integrationId"` // The exact moment this entity was created. Created time.Time `json:"created"` @@ -31,6 +31,8 @@ type CustomerProfile struct { TotalSales float32 `json:"totalSales"` // A list of loyalty programs joined by the customer LoyaltyMemberships *[]LoyaltyMembership `json:"loyaltyMemberships,omitempty"` + // A list of audiences the customer belongs to + AudienceMemberships *[]AudienceMembership `json:"audienceMemberships,omitempty"` // Timestamp of the most recent event received from this customer LastActivity time.Time `json:"lastActivity"` } @@ -158,6 +160,39 @@ func (o *CustomerProfile) SetLoyaltyMemberships(v []LoyaltyMembership) { o.LoyaltyMemberships = &v } +// GetAudienceMemberships returns the AudienceMemberships field value if set, zero value otherwise. +func (o *CustomerProfile) GetAudienceMemberships() []AudienceMembership { + if o == nil || o.AudienceMemberships == nil { + var ret []AudienceMembership + return ret + } + return *o.AudienceMemberships +} + +// GetAudienceMembershipsOk returns a tuple with the AudienceMemberships field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CustomerProfile) GetAudienceMembershipsOk() ([]AudienceMembership, bool) { + if o == nil || o.AudienceMemberships == nil { + var ret []AudienceMembership + return ret, false + } + return *o.AudienceMemberships, true +} + +// HasAudienceMemberships returns a boolean if a field has been set. +func (o *CustomerProfile) HasAudienceMemberships() bool { + if o != nil && o.AudienceMemberships != nil { + return true + } + + return false +} + +// SetAudienceMemberships gets a reference to the given []AudienceMembership and assigns it to the AudienceMemberships field. +func (o *CustomerProfile) SetAudienceMemberships(v []AudienceMembership) { + o.AudienceMemberships = &v +} + // GetLastActivity returns the LastActivity field value func (o *CustomerProfile) GetLastActivity() time.Time { if o == nil { diff --git a/model_customer_profile_audience_request.go b/model_customer_profile_audience_request.go new file mode 100644 index 00000000..f9b3b0ba --- /dev/null +++ b/model_customer_profile_audience_request.go @@ -0,0 +1,76 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CustomerProfileAudienceRequest struct for CustomerProfileAudienceRequest +type CustomerProfileAudienceRequest struct { + Data *[]CustomerProfileAudienceRequestItem `json:"data,omitempty"` +} + +// GetData returns the Data field value if set, zero value otherwise. +func (o *CustomerProfileAudienceRequest) GetData() []CustomerProfileAudienceRequestItem { + if o == nil || o.Data == nil { + var ret []CustomerProfileAudienceRequestItem + return ret + } + return *o.Data +} + +// GetDataOk returns a tuple with the Data field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CustomerProfileAudienceRequest) GetDataOk() ([]CustomerProfileAudienceRequestItem, bool) { + if o == nil || o.Data == nil { + var ret []CustomerProfileAudienceRequestItem + return ret, false + } + return *o.Data, true +} + +// HasData returns a boolean if a field has been set. +func (o *CustomerProfileAudienceRequest) HasData() bool { + if o != nil && o.Data != nil { + return true + } + + return false +} + +// SetData gets a reference to the given []CustomerProfileAudienceRequestItem and assigns it to the Data field. +func (o *CustomerProfileAudienceRequest) SetData(v []CustomerProfileAudienceRequestItem) { + o.Data = &v +} + +type NullableCustomerProfileAudienceRequest struct { + Value CustomerProfileAudienceRequest + ExplicitNull bool +} + +func (v NullableCustomerProfileAudienceRequest) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCustomerProfileAudienceRequest) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_customer_profile_audience_request_item.go b/model_customer_profile_audience_request_item.go new file mode 100644 index 00000000..63bb14b1 --- /dev/null +++ b/model_customer_profile_audience_request_item.go @@ -0,0 +1,90 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CustomerProfileAudienceRequestItem struct for CustomerProfileAudienceRequestItem +type CustomerProfileAudienceRequestItem struct { + Action string `json:"action"` + ProfileIntegrationId string `json:"profileIntegrationId"` + AudienceId int32 `json:"audienceId"` +} + +// GetAction returns the Action field value +func (o *CustomerProfileAudienceRequestItem) GetAction() string { + if o == nil { + var ret string + return ret + } + + return o.Action +} + +// SetAction sets field value +func (o *CustomerProfileAudienceRequestItem) SetAction(v string) { + o.Action = v +} + +// GetProfileIntegrationId returns the ProfileIntegrationId field value +func (o *CustomerProfileAudienceRequestItem) GetProfileIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.ProfileIntegrationId +} + +// SetProfileIntegrationId sets field value +func (o *CustomerProfileAudienceRequestItem) SetProfileIntegrationId(v string) { + o.ProfileIntegrationId = v +} + +// GetAudienceId returns the AudienceId field value +func (o *CustomerProfileAudienceRequestItem) GetAudienceId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AudienceId +} + +// SetAudienceId sets field value +func (o *CustomerProfileAudienceRequestItem) SetAudienceId(v int32) { + o.AudienceId = v +} + +type NullableCustomerProfileAudienceRequestItem struct { + Value CustomerProfileAudienceRequestItem + ExplicitNull bool +} + +func (v NullableCustomerProfileAudienceRequestItem) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCustomerProfileAudienceRequestItem) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_customer_profile_integration_request_v2.go b/model_customer_profile_integration_request_v2.go new file mode 100644 index 00000000..81303683 --- /dev/null +++ b/model_customer_profile_integration_request_v2.go @@ -0,0 +1,112 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CustomerProfileIntegrationRequestV2 +type CustomerProfileIntegrationRequestV2 struct { + // Arbitrary properties associated with this item + Attributes *map[string]interface{} `json:"attributes,omitempty"` + // Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\" and \"event\". + ResponseContent *[]string `json:"responseContent,omitempty"` +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *CustomerProfileIntegrationRequestV2) GetAttributes() map[string]interface{} { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CustomerProfileIntegrationRequestV2) GetAttributesOk() (map[string]interface{}, bool) { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *CustomerProfileIntegrationRequestV2) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. +func (o *CustomerProfileIntegrationRequestV2) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +// GetResponseContent returns the ResponseContent field value if set, zero value otherwise. +func (o *CustomerProfileIntegrationRequestV2) GetResponseContent() []string { + if o == nil || o.ResponseContent == nil { + var ret []string + return ret + } + return *o.ResponseContent +} + +// GetResponseContentOk returns a tuple with the ResponseContent field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CustomerProfileIntegrationRequestV2) GetResponseContentOk() ([]string, bool) { + if o == nil || o.ResponseContent == nil { + var ret []string + return ret, false + } + return *o.ResponseContent, true +} + +// HasResponseContent returns a boolean if a field has been set. +func (o *CustomerProfileIntegrationRequestV2) HasResponseContent() bool { + if o != nil && o.ResponseContent != nil { + return true + } + + return false +} + +// SetResponseContent gets a reference to the given []string and assigns it to the ResponseContent field. +func (o *CustomerProfileIntegrationRequestV2) SetResponseContent(v []string) { + o.ResponseContent = &v +} + +type NullableCustomerProfileIntegrationRequestV2 struct { + Value CustomerProfileIntegrationRequestV2 + ExplicitNull bool +} + +func (v NullableCustomerProfileIntegrationRequestV2) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCustomerProfileIntegrationRequestV2) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_customer_session.go b/model_customer_session.go index 4800ca67..f4b4999d 100644 --- a/model_customer_session.go +++ b/model_customer_session.go @@ -17,7 +17,7 @@ import ( // CustomerSession type CustomerSession struct { - // The ID used for this entity in the application system. + // The integration ID for this entity sent to and used in the Talon.One system. IntegrationId string `json:"integrationId"` // The exact moment this entity was created. Created time.Time `json:"created"` diff --git a/model_customer_session_v2.go b/model_customer_session_v2.go index 1460f599..7527d2aa 100644 --- a/model_customer_session_v2.go +++ b/model_customer_session_v2.go @@ -17,7 +17,7 @@ import ( // CustomerSessionV2 type CustomerSessionV2 struct { - // The ID used for this entity in the application system. + // The integration ID for this entity sent to and used in the Talon.One system. IntegrationId string `json:"integrationId"` // The exact moment this entity was created. Created time.Time `json:"created"` diff --git a/model_entity_with_talang_visible_id.go b/model_entity_with_talang_visible_id.go new file mode 100644 index 00000000..aed104b3 --- /dev/null +++ b/model_entity_with_talang_visible_id.go @@ -0,0 +1,77 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// EntityWithTalangVisibleId struct for EntityWithTalangVisibleId +type EntityWithTalangVisibleId struct { + // Unique ID for this entity. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` +} + +// GetId returns the Id field value +func (o *EntityWithTalangVisibleId) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *EntityWithTalangVisibleId) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *EntityWithTalangVisibleId) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *EntityWithTalangVisibleId) SetCreated(v time.Time) { + o.Created = v +} + +type NullableEntityWithTalangVisibleId struct { + Value EntityWithTalangVisibleId + ExplicitNull bool +} + +func (v NullableEntityWithTalangVisibleId) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableEntityWithTalangVisibleId) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_feed_notification.go b/model_feed_notification.go new file mode 100644 index 00000000..a3aa3051 --- /dev/null +++ b/model_feed_notification.go @@ -0,0 +1,145 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// FeedNotification A feed notification for CAMA users +type FeedNotification struct { + // Title of the feed notification + Title string `json:"title"` + // Timestamp of the moment this feed notification was created + Created time.Time `json:"created"` + // Timestamp of the moment this feed notification was last updated + Updated time.Time `json:"updated"` + // URL to the feed notification in the help center + ArticleUrl string `json:"articleUrl"` + // The type of the feed notification + Type string `json:"type"` + // Body of the feed notification + Body string `json:"body"` +} + +// GetTitle returns the Title field value +func (o *FeedNotification) GetTitle() string { + if o == nil { + var ret string + return ret + } + + return o.Title +} + +// SetTitle sets field value +func (o *FeedNotification) SetTitle(v string) { + o.Title = v +} + +// GetCreated returns the Created field value +func (o *FeedNotification) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *FeedNotification) SetCreated(v time.Time) { + o.Created = v +} + +// GetUpdated returns the Updated field value +func (o *FeedNotification) GetUpdated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Updated +} + +// SetUpdated sets field value +func (o *FeedNotification) SetUpdated(v time.Time) { + o.Updated = v +} + +// GetArticleUrl returns the ArticleUrl field value +func (o *FeedNotification) GetArticleUrl() string { + if o == nil { + var ret string + return ret + } + + return o.ArticleUrl +} + +// SetArticleUrl sets field value +func (o *FeedNotification) SetArticleUrl(v string) { + o.ArticleUrl = v +} + +// GetType returns the Type field value +func (o *FeedNotification) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *FeedNotification) SetType(v string) { + o.Type = v +} + +// GetBody returns the Body field value +func (o *FeedNotification) GetBody() string { + if o == nil { + var ret string + return ret + } + + return o.Body +} + +// SetBody sets field value +func (o *FeedNotification) SetBody(v string) { + o.Body = v +} + +type NullableFeedNotification struct { + Value FeedNotification + ExplicitNull bool +} + +func (v NullableFeedNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableFeedNotification) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_inline_response_200_12.go b/model_inline_response_200_12.go index d0269750..bfe9903f 100644 --- a/model_inline_response_200_12.go +++ b/model_inline_response_200_12.go @@ -16,23 +16,75 @@ import ( // InlineResponse20012 struct for InlineResponse20012 type InlineResponse20012 struct { - TotalResultSize int32 `json:"totalResultSize"` + TotalResultSize *int32 `json:"totalResultSize,omitempty"` + HasMore *bool `json:"hasMore,omitempty"` Data []ApplicationCustomer `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value +// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. func (o *InlineResponse20012) GetTotalResultSize() int32 { - if o == nil { + if o == nil || o.TotalResultSize == nil { var ret int32 return ret } + return *o.TotalResultSize +} - return o.TotalResultSize +// GetTotalResultSizeOk returns a tuple with the TotalResultSize field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InlineResponse20012) GetTotalResultSizeOk() (int32, bool) { + if o == nil || o.TotalResultSize == nil { + var ret int32 + return ret, false + } + return *o.TotalResultSize, true } -// SetTotalResultSize sets field value +// HasTotalResultSize returns a boolean if a field has been set. +func (o *InlineResponse20012) HasTotalResultSize() bool { + if o != nil && o.TotalResultSize != nil { + return true + } + + return false +} + +// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. func (o *InlineResponse20012) SetTotalResultSize(v int32) { - o.TotalResultSize = v + o.TotalResultSize = &v +} + +// GetHasMore returns the HasMore field value if set, zero value otherwise. +func (o *InlineResponse20012) GetHasMore() bool { + if o == nil || o.HasMore == nil { + var ret bool + return ret + } + return *o.HasMore +} + +// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InlineResponse20012) GetHasMoreOk() (bool, bool) { + if o == nil || o.HasMore == nil { + var ret bool + return ret, false + } + return *o.HasMore, true +} + +// HasHasMore returns a boolean if a field has been set. +func (o *InlineResponse20012) HasHasMore() bool { + if o != nil && o.HasMore != nil { + return true + } + + return false +} + +// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +func (o *InlineResponse20012) SetHasMore(v bool) { + o.HasMore = &v } // GetData returns the Data field value diff --git a/model_integration_entity.go b/model_integration_entity.go index cb4e127a..746dc7d6 100644 --- a/model_integration_entity.go +++ b/model_integration_entity.go @@ -17,7 +17,7 @@ import ( // IntegrationEntity struct for IntegrationEntity type IntegrationEntity struct { - // The ID used for this entity in the application system. + // The integration ID for this entity sent to and used in the Talon.One system. IntegrationId string `json:"integrationId"` // The exact moment this entity was created. Created time.Time `json:"created"` diff --git a/model_loyalty_ledger_entry.go b/model_loyalty_ledger_entry.go index 24926fc3..a404162d 100644 --- a/model_loyalty_ledger_entry.go +++ b/model_loyalty_ledger_entry.go @@ -25,6 +25,7 @@ type LoyaltyLedgerEntry struct { // The type of the ledger transaction. Possible values are addition, subtraction, expire or expiring (for expiring points ledgers) Type string `json:"type"` Amount float32 `json:"amount"` + StartDate *time.Time `json:"startDate,omitempty"` ExpiryDate *time.Time `json:"expiryDate,omitempty"` // A name referencing the condition or effect that added this entry, or the specific name provided in an API call. Name string `json:"name"` @@ -175,6 +176,39 @@ func (o *LoyaltyLedgerEntry) SetAmount(v float32) { o.Amount = v } +// GetStartDate returns the StartDate field value if set, zero value otherwise. +func (o *LoyaltyLedgerEntry) GetStartDate() time.Time { + if o == nil || o.StartDate == nil { + var ret time.Time + return ret + } + return *o.StartDate +} + +// GetStartDateOk returns a tuple with the StartDate field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyLedgerEntry) GetStartDateOk() (time.Time, bool) { + if o == nil || o.StartDate == nil { + var ret time.Time + return ret, false + } + return *o.StartDate, true +} + +// HasStartDate returns a boolean if a field has been set. +func (o *LoyaltyLedgerEntry) HasStartDate() bool { + if o != nil && o.StartDate != nil { + return true + } + + return false +} + +// SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. +func (o *LoyaltyLedgerEntry) SetStartDate(v time.Time) { + o.StartDate = &v +} + // GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise. func (o *LoyaltyLedgerEntry) GetExpiryDate() time.Time { if o == nil || o.ExpiryDate == nil { diff --git a/model_loyalty_points.go b/model_loyalty_points.go index 5b8df5bc..70beccbf 100644 --- a/model_loyalty_points.go +++ b/model_loyalty_points.go @@ -20,8 +20,10 @@ type LoyaltyPoints struct { Points float32 `json:"points"` // Allows to specify a name for the addition or deduction Name *string `json:"name,omitempty"` - // Indicates the duration after which the added loyalty points should expire. The format is a number followed by one letter indicating the unit, like '1h' or '40m' or '30d'. - ExpiryDuration *string `json:"expiryDuration,omitempty"` + // Indicates the duration after which the added loyalty points should expire. The format is a number followed by one letter indicating the time unit, like '1h' or '40m' (defined by Go time package). + ValidityDuration *string `json:"validityDuration,omitempty"` + // Indicates the amount of time before the points are considered valid. The format is a number followed by one letter indicating the time unit, like '1h' or '40m' (defined by Go time package). + PendingDuration *string `json:"pendingDuration,omitempty"` // This specifies if we are adding loyalty points to the main ledger or a subledger SubLedgerID *string `json:"subLedgerID,omitempty"` } @@ -74,37 +76,70 @@ func (o *LoyaltyPoints) SetName(v string) { o.Name = &v } -// GetExpiryDuration returns the ExpiryDuration field value if set, zero value otherwise. -func (o *LoyaltyPoints) GetExpiryDuration() string { - if o == nil || o.ExpiryDuration == nil { +// GetValidityDuration returns the ValidityDuration field value if set, zero value otherwise. +func (o *LoyaltyPoints) GetValidityDuration() string { + if o == nil || o.ValidityDuration == nil { var ret string return ret } - return *o.ExpiryDuration + return *o.ValidityDuration } -// GetExpiryDurationOk returns a tuple with the ExpiryDuration field value if set, zero value otherwise +// GetValidityDurationOk returns a tuple with the ValidityDuration field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *LoyaltyPoints) GetExpiryDurationOk() (string, bool) { - if o == nil || o.ExpiryDuration == nil { +func (o *LoyaltyPoints) GetValidityDurationOk() (string, bool) { + if o == nil || o.ValidityDuration == nil { var ret string return ret, false } - return *o.ExpiryDuration, true + return *o.ValidityDuration, true } -// HasExpiryDuration returns a boolean if a field has been set. -func (o *LoyaltyPoints) HasExpiryDuration() bool { - if o != nil && o.ExpiryDuration != nil { +// HasValidityDuration returns a boolean if a field has been set. +func (o *LoyaltyPoints) HasValidityDuration() bool { + if o != nil && o.ValidityDuration != nil { return true } return false } -// SetExpiryDuration gets a reference to the given string and assigns it to the ExpiryDuration field. -func (o *LoyaltyPoints) SetExpiryDuration(v string) { - o.ExpiryDuration = &v +// SetValidityDuration gets a reference to the given string and assigns it to the ValidityDuration field. +func (o *LoyaltyPoints) SetValidityDuration(v string) { + o.ValidityDuration = &v +} + +// GetPendingDuration returns the PendingDuration field value if set, zero value otherwise. +func (o *LoyaltyPoints) GetPendingDuration() string { + if o == nil || o.PendingDuration == nil { + var ret string + return ret + } + return *o.PendingDuration +} + +// GetPendingDurationOk returns a tuple with the PendingDuration field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyPoints) GetPendingDurationOk() (string, bool) { + if o == nil || o.PendingDuration == nil { + var ret string + return ret, false + } + return *o.PendingDuration, true +} + +// HasPendingDuration returns a boolean if a field has been set. +func (o *LoyaltyPoints) HasPendingDuration() bool { + if o != nil && o.PendingDuration != nil { + return true + } + + return false +} + +// SetPendingDuration gets a reference to the given string and assigns it to the PendingDuration field. +func (o *LoyaltyPoints) SetPendingDuration(v string) { + o.PendingDuration = &v } // GetSubLedgerID returns the SubLedgerID field value if set, zero value otherwise. diff --git a/model_loyalty_program.go b/model_loyalty_program.go index 45a229dd..3433b7c9 100644 --- a/model_loyalty_program.go +++ b/model_loyalty_program.go @@ -28,8 +28,10 @@ type LoyaltyProgram struct { Description string `json:"description"` // A list containing the IDs of all applications that are subscribed to this Loyalty Program. SubscribedApplications []int32 `json:"subscribedApplications"` - // Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m' or '30d'. + // Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. DefaultValidity string `json:"defaultValidity"` + // Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. + DefaultPending string `json:"defaultPending"` // Indicates if this program supports subledgers inside the program AllowSubledger bool `json:"allowSubledger"` } @@ -139,6 +141,21 @@ func (o *LoyaltyProgram) SetDefaultValidity(v string) { o.DefaultValidity = v } +// GetDefaultPending returns the DefaultPending field value +func (o *LoyaltyProgram) GetDefaultPending() string { + if o == nil { + var ret string + return ret + } + + return o.DefaultPending +} + +// SetDefaultPending sets field value +func (o *LoyaltyProgram) SetDefaultPending(v string) { + o.DefaultPending = v +} + // GetAllowSubledger returns the AllowSubledger field value func (o *LoyaltyProgram) GetAllowSubledger() bool { if o == nil { diff --git a/model_loyalty_statistics.go b/model_loyalty_statistics.go new file mode 100644 index 00000000..f611d99c --- /dev/null +++ b/model_loyalty_statistics.go @@ -0,0 +1,110 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// LoyaltyStatistics +type LoyaltyStatistics struct { + // Total of active points for this loyalty program + TotalActivePoints float32 `json:"totalActivePoints"` + // Total of pending points for this loyalty program + TotalPendingPoints float32 `json:"totalPendingPoints"` + // Total of spent points for this loyalty program + TotalSpentPoints float32 `json:"totalSpentPoints"` + // Total of expired points for this loyalty program + TotalExpiredPoints float32 `json:"totalExpiredPoints"` +} + +// GetTotalActivePoints returns the TotalActivePoints field value +func (o *LoyaltyStatistics) GetTotalActivePoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalActivePoints +} + +// SetTotalActivePoints sets field value +func (o *LoyaltyStatistics) SetTotalActivePoints(v float32) { + o.TotalActivePoints = v +} + +// GetTotalPendingPoints returns the TotalPendingPoints field value +func (o *LoyaltyStatistics) GetTotalPendingPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalPendingPoints +} + +// SetTotalPendingPoints sets field value +func (o *LoyaltyStatistics) SetTotalPendingPoints(v float32) { + o.TotalPendingPoints = v +} + +// GetTotalSpentPoints returns the TotalSpentPoints field value +func (o *LoyaltyStatistics) GetTotalSpentPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalSpentPoints +} + +// SetTotalSpentPoints sets field value +func (o *LoyaltyStatistics) SetTotalSpentPoints(v float32) { + o.TotalSpentPoints = v +} + +// GetTotalExpiredPoints returns the TotalExpiredPoints field value +func (o *LoyaltyStatistics) GetTotalExpiredPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalExpiredPoints +} + +// SetTotalExpiredPoints sets field value +func (o *LoyaltyStatistics) SetTotalExpiredPoints(v float32) { + o.TotalExpiredPoints = v +} + +type NullableLoyaltyStatistics struct { + Value LoyaltyStatistics + ExplicitNull bool +} + +func (v NullableLoyaltyStatistics) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyStatistics) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_loyalty_sub_ledger.go b/model_loyalty_sub_ledger.go index 6517f5b7..5b68d2bc 100644 --- a/model_loyalty_sub_ledger.go +++ b/model_loyalty_sub_ledger.go @@ -16,11 +16,26 @@ import ( // LoyaltySubLedger Ledger of Balance in Loyalty Program for a Customer type LoyaltySubLedger struct { + // ⚠️ Deprecated: Please use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance Total float32 `json:"total"` - // Transactions contains a list of all events that have happened such as additions, subtractions and expiries + // Total amount of currently active and available points in the customer's balance + TotalActivePoints float32 `json:"totalActivePoints"` + // Total amount of pending points, which are not active yet but will become active in the future + TotalPendingPoints float32 `json:"totalPendingPoints"` + // Total amount of points already spent by this customer + TotalSpentPoints float32 `json:"totalSpentPoints"` + // Total amount of points, that expired without ever being spent + TotalExpiredPoints float32 `json:"totalExpiredPoints"` + // List of all events that have happened such as additions, subtractions and expiries Transactions *[]LoyaltyLedgerEntry `json:"transactions,omitempty"` - // ExpiringPoints contains a list of all points that will expiry and when + // List of all points that will expire ExpiringPoints *[]LoyaltyLedgerEntry `json:"expiringPoints,omitempty"` + // List of all currently active points + ActivePoints *[]LoyaltyLedgerEntry `json:"activePoints,omitempty"` + // List of all points pending activation + PendingPoints *[]LoyaltyLedgerEntry `json:"pendingPoints,omitempty"` + // List of expired points + ExpiredPoints *[]LoyaltyLedgerEntry `json:"expiredPoints,omitempty"` } // GetTotal returns the Total field value @@ -38,6 +53,66 @@ func (o *LoyaltySubLedger) SetTotal(v float32) { o.Total = v } +// GetTotalActivePoints returns the TotalActivePoints field value +func (o *LoyaltySubLedger) GetTotalActivePoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalActivePoints +} + +// SetTotalActivePoints sets field value +func (o *LoyaltySubLedger) SetTotalActivePoints(v float32) { + o.TotalActivePoints = v +} + +// GetTotalPendingPoints returns the TotalPendingPoints field value +func (o *LoyaltySubLedger) GetTotalPendingPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalPendingPoints +} + +// SetTotalPendingPoints sets field value +func (o *LoyaltySubLedger) SetTotalPendingPoints(v float32) { + o.TotalPendingPoints = v +} + +// GetTotalSpentPoints returns the TotalSpentPoints field value +func (o *LoyaltySubLedger) GetTotalSpentPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalSpentPoints +} + +// SetTotalSpentPoints sets field value +func (o *LoyaltySubLedger) SetTotalSpentPoints(v float32) { + o.TotalSpentPoints = v +} + +// GetTotalExpiredPoints returns the TotalExpiredPoints field value +func (o *LoyaltySubLedger) GetTotalExpiredPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.TotalExpiredPoints +} + +// SetTotalExpiredPoints sets field value +func (o *LoyaltySubLedger) SetTotalExpiredPoints(v float32) { + o.TotalExpiredPoints = v +} + // GetTransactions returns the Transactions field value if set, zero value otherwise. func (o *LoyaltySubLedger) GetTransactions() []LoyaltyLedgerEntry { if o == nil || o.Transactions == nil { @@ -104,6 +179,105 @@ func (o *LoyaltySubLedger) SetExpiringPoints(v []LoyaltyLedgerEntry) { o.ExpiringPoints = &v } +// GetActivePoints returns the ActivePoints field value if set, zero value otherwise. +func (o *LoyaltySubLedger) GetActivePoints() []LoyaltyLedgerEntry { + if o == nil || o.ActivePoints == nil { + var ret []LoyaltyLedgerEntry + return ret + } + return *o.ActivePoints +} + +// GetActivePointsOk returns a tuple with the ActivePoints field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltySubLedger) GetActivePointsOk() ([]LoyaltyLedgerEntry, bool) { + if o == nil || o.ActivePoints == nil { + var ret []LoyaltyLedgerEntry + return ret, false + } + return *o.ActivePoints, true +} + +// HasActivePoints returns a boolean if a field has been set. +func (o *LoyaltySubLedger) HasActivePoints() bool { + if o != nil && o.ActivePoints != nil { + return true + } + + return false +} + +// SetActivePoints gets a reference to the given []LoyaltyLedgerEntry and assigns it to the ActivePoints field. +func (o *LoyaltySubLedger) SetActivePoints(v []LoyaltyLedgerEntry) { + o.ActivePoints = &v +} + +// GetPendingPoints returns the PendingPoints field value if set, zero value otherwise. +func (o *LoyaltySubLedger) GetPendingPoints() []LoyaltyLedgerEntry { + if o == nil || o.PendingPoints == nil { + var ret []LoyaltyLedgerEntry + return ret + } + return *o.PendingPoints +} + +// GetPendingPointsOk returns a tuple with the PendingPoints field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltySubLedger) GetPendingPointsOk() ([]LoyaltyLedgerEntry, bool) { + if o == nil || o.PendingPoints == nil { + var ret []LoyaltyLedgerEntry + return ret, false + } + return *o.PendingPoints, true +} + +// HasPendingPoints returns a boolean if a field has been set. +func (o *LoyaltySubLedger) HasPendingPoints() bool { + if o != nil && o.PendingPoints != nil { + return true + } + + return false +} + +// SetPendingPoints gets a reference to the given []LoyaltyLedgerEntry and assigns it to the PendingPoints field. +func (o *LoyaltySubLedger) SetPendingPoints(v []LoyaltyLedgerEntry) { + o.PendingPoints = &v +} + +// GetExpiredPoints returns the ExpiredPoints field value if set, zero value otherwise. +func (o *LoyaltySubLedger) GetExpiredPoints() []LoyaltyLedgerEntry { + if o == nil || o.ExpiredPoints == nil { + var ret []LoyaltyLedgerEntry + return ret + } + return *o.ExpiredPoints +} + +// GetExpiredPointsOk returns a tuple with the ExpiredPoints field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltySubLedger) GetExpiredPointsOk() ([]LoyaltyLedgerEntry, bool) { + if o == nil || o.ExpiredPoints == nil { + var ret []LoyaltyLedgerEntry + return ret, false + } + return *o.ExpiredPoints, true +} + +// HasExpiredPoints returns a boolean if a field has been set. +func (o *LoyaltySubLedger) HasExpiredPoints() bool { + if o != nil && o.ExpiredPoints != nil { + return true + } + + return false +} + +// SetExpiredPoints gets a reference to the given []LoyaltyLedgerEntry and assigns it to the ExpiredPoints field. +func (o *LoyaltySubLedger) SetExpiredPoints(v []LoyaltyLedgerEntry) { + o.ExpiredPoints = &v +} + type NullableLoyaltySubLedger struct { Value LoyaltySubLedger ExplicitNull bool diff --git a/model_meta.go b/model_meta.go index a11832c7..662154be 100644 --- a/model_meta.go +++ b/model_meta.go @@ -22,7 +22,8 @@ type Meta struct { Coupons *map[string]interface{} `json:"coupons,omitempty"` CouponRejectionReason *CouponRejectionReason `json:"couponRejectionReason,omitempty"` ReferralRejectionReason *ReferralRejectionReason `json:"referralRejectionReason,omitempty"` - Warnings *map[string]interface{} `json:"warnings,omitempty"` + // Contains warnings about possible misuse. + Warnings *map[string]interface{} `json:"warnings,omitempty"` } // GetCampaigns returns the Campaigns field value if set, zero value otherwise. diff --git a/model_misc_update_user_latest_feature.go b/model_misc_update_user_latest_feature.go deleted file mode 100644 index 375af2df..00000000 --- a/model_misc_update_user_latest_feature.go +++ /dev/null @@ -1,76 +0,0 @@ -/* - * Talon.One API - * - * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put - * - * API version: 1.0.0 - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// MiscUpdateUserLatestFeature struct for MiscUpdateUserLatestFeature -type MiscUpdateUserLatestFeature struct { - LatestFeature *string `json:"latestFeature,omitempty"` -} - -// GetLatestFeature returns the LatestFeature field value if set, zero value otherwise. -func (o *MiscUpdateUserLatestFeature) GetLatestFeature() string { - if o == nil || o.LatestFeature == nil { - var ret string - return ret - } - return *o.LatestFeature -} - -// GetLatestFeatureOk returns a tuple with the LatestFeature field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *MiscUpdateUserLatestFeature) GetLatestFeatureOk() (string, bool) { - if o == nil || o.LatestFeature == nil { - var ret string - return ret, false - } - return *o.LatestFeature, true -} - -// HasLatestFeature returns a boolean if a field has been set. -func (o *MiscUpdateUserLatestFeature) HasLatestFeature() bool { - if o != nil && o.LatestFeature != nil { - return true - } - - return false -} - -// SetLatestFeature gets a reference to the given string and assigns it to the LatestFeature field. -func (o *MiscUpdateUserLatestFeature) SetLatestFeature(v string) { - o.LatestFeature = &v -} - -type NullableMiscUpdateUserLatestFeature struct { - Value MiscUpdateUserLatestFeature - ExplicitNull bool -} - -func (v NullableMiscUpdateUserLatestFeature) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableMiscUpdateUserLatestFeature) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_multiple_customer_profile_integration_request.go b/model_multiple_customer_profile_integration_request.go new file mode 100644 index 00000000..40102bbb --- /dev/null +++ b/model_multiple_customer_profile_integration_request.go @@ -0,0 +1,76 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// MultipleCustomerProfileIntegrationRequest struct for MultipleCustomerProfileIntegrationRequest +type MultipleCustomerProfileIntegrationRequest struct { + CustomerProfiles *[]MultipleCustomerProfileIntegrationRequestItem `json:"customerProfiles,omitempty"` +} + +// GetCustomerProfiles returns the CustomerProfiles field value if set, zero value otherwise. +func (o *MultipleCustomerProfileIntegrationRequest) GetCustomerProfiles() []MultipleCustomerProfileIntegrationRequestItem { + if o == nil || o.CustomerProfiles == nil { + var ret []MultipleCustomerProfileIntegrationRequestItem + return ret + } + return *o.CustomerProfiles +} + +// GetCustomerProfilesOk returns a tuple with the CustomerProfiles field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *MultipleCustomerProfileIntegrationRequest) GetCustomerProfilesOk() ([]MultipleCustomerProfileIntegrationRequestItem, bool) { + if o == nil || o.CustomerProfiles == nil { + var ret []MultipleCustomerProfileIntegrationRequestItem + return ret, false + } + return *o.CustomerProfiles, true +} + +// HasCustomerProfiles returns a boolean if a field has been set. +func (o *MultipleCustomerProfileIntegrationRequest) HasCustomerProfiles() bool { + if o != nil && o.CustomerProfiles != nil { + return true + } + + return false +} + +// SetCustomerProfiles gets a reference to the given []MultipleCustomerProfileIntegrationRequestItem and assigns it to the CustomerProfiles field. +func (o *MultipleCustomerProfileIntegrationRequest) SetCustomerProfiles(v []MultipleCustomerProfileIntegrationRequestItem) { + o.CustomerProfiles = &v +} + +type NullableMultipleCustomerProfileIntegrationRequest struct { + Value MultipleCustomerProfileIntegrationRequest + ExplicitNull bool +} + +func (v NullableMultipleCustomerProfileIntegrationRequest) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableMultipleCustomerProfileIntegrationRequest) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_multiple_customer_profile_integration_request_item.go b/model_multiple_customer_profile_integration_request_item.go new file mode 100644 index 00000000..9fc0f4a8 --- /dev/null +++ b/model_multiple_customer_profile_integration_request_item.go @@ -0,0 +1,94 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// MultipleCustomerProfileIntegrationRequestItem +type MultipleCustomerProfileIntegrationRequestItem struct { + // Arbitrary properties associated with this item + Attributes *map[string]interface{} `json:"attributes,omitempty"` + // The custom identifier for this profile, must be unique within the account. + IntegrationId string `json:"integrationId"` +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *MultipleCustomerProfileIntegrationRequestItem) GetAttributes() map[string]interface{} { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *MultipleCustomerProfileIntegrationRequestItem) GetAttributesOk() (map[string]interface{}, bool) { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *MultipleCustomerProfileIntegrationRequestItem) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. +func (o *MultipleCustomerProfileIntegrationRequestItem) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +// GetIntegrationId returns the IntegrationId field value +func (o *MultipleCustomerProfileIntegrationRequestItem) GetIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.IntegrationId +} + +// SetIntegrationId sets field value +func (o *MultipleCustomerProfileIntegrationRequestItem) SetIntegrationId(v string) { + o.IntegrationId = v +} + +type NullableMultipleCustomerProfileIntegrationRequestItem struct { + Value MultipleCustomerProfileIntegrationRequestItem + ExplicitNull bool +} + +func (v NullableMultipleCustomerProfileIntegrationRequestItem) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableMultipleCustomerProfileIntegrationRequestItem) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_multiple_customer_profile_integration_response_v2.go b/model_multiple_customer_profile_integration_response_v2.go new file mode 100644 index 00000000..97faa992 --- /dev/null +++ b/model_multiple_customer_profile_integration_response_v2.go @@ -0,0 +1,76 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// MultipleCustomerProfileIntegrationResponseV2 struct for MultipleCustomerProfileIntegrationResponseV2 +type MultipleCustomerProfileIntegrationResponseV2 struct { + IntegrationStates *[]IntegrationStateV2 `json:"integrationStates,omitempty"` +} + +// GetIntegrationStates returns the IntegrationStates field value if set, zero value otherwise. +func (o *MultipleCustomerProfileIntegrationResponseV2) GetIntegrationStates() []IntegrationStateV2 { + if o == nil || o.IntegrationStates == nil { + var ret []IntegrationStateV2 + return ret + } + return *o.IntegrationStates +} + +// GetIntegrationStatesOk returns a tuple with the IntegrationStates field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *MultipleCustomerProfileIntegrationResponseV2) GetIntegrationStatesOk() ([]IntegrationStateV2, bool) { + if o == nil || o.IntegrationStates == nil { + var ret []IntegrationStateV2 + return ret, false + } + return *o.IntegrationStates, true +} + +// HasIntegrationStates returns a boolean if a field has been set. +func (o *MultipleCustomerProfileIntegrationResponseV2) HasIntegrationStates() bool { + if o != nil && o.IntegrationStates != nil { + return true + } + + return false +} + +// SetIntegrationStates gets a reference to the given []IntegrationStateV2 and assigns it to the IntegrationStates field. +func (o *MultipleCustomerProfileIntegrationResponseV2) SetIntegrationStates(v []IntegrationStateV2) { + o.IntegrationStates = &v +} + +type NullableMultipleCustomerProfileIntegrationResponseV2 struct { + Value MultipleCustomerProfileIntegrationResponseV2 + ExplicitNull bool +} + +func (v NullableMultipleCustomerProfileIntegrationResponseV2) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableMultipleCustomerProfileIntegrationResponseV2) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_application.go b/model_new_application.go index 424159c0..131be441 100644 --- a/model_new_application.go +++ b/model_new_application.go @@ -30,9 +30,17 @@ type NewApplication struct { Attributes *map[string]interface{} `json:"attributes,omitempty"` // Default limits for campaigns created in this application Limits *[]LimitConfig `json:"limits,omitempty"` - // Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive) - CampaignPriority *string `json:"campaignPriority,omitempty"` - AttributesSettings *AttributesSettings `json:"attributesSettings,omitempty"` + // Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" + CampaignPriority *string `json:"campaignPriority,omitempty"` + // The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" + ExclusiveCampaignsStrategy *string `json:"exclusiveCampaignsStrategy,omitempty"` + // Flag indicating if discounts should cascade for this application + EnableCascadingDiscounts *bool `json:"enableCascadingDiscounts,omitempty"` + // Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one + EnableFlattenedCartItems *bool `json:"enableFlattenedCartItems,omitempty"` + AttributesSettings *AttributesSettings `json:"attributesSettings,omitempty"` + // Flag indicating if this is a live or sandbox application + Sandbox *bool `json:"sandbox,omitempty"` // Hex key for HMAC-signing API calls as coming from this application (16 hex digits) Key *string `json:"key,omitempty"` } @@ -247,6 +255,105 @@ func (o *NewApplication) SetCampaignPriority(v string) { o.CampaignPriority = &v } +// GetExclusiveCampaignsStrategy returns the ExclusiveCampaignsStrategy field value if set, zero value otherwise. +func (o *NewApplication) GetExclusiveCampaignsStrategy() string { + if o == nil || o.ExclusiveCampaignsStrategy == nil { + var ret string + return ret + } + return *o.ExclusiveCampaignsStrategy +} + +// GetExclusiveCampaignsStrategyOk returns a tuple with the ExclusiveCampaignsStrategy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplication) GetExclusiveCampaignsStrategyOk() (string, bool) { + if o == nil || o.ExclusiveCampaignsStrategy == nil { + var ret string + return ret, false + } + return *o.ExclusiveCampaignsStrategy, true +} + +// HasExclusiveCampaignsStrategy returns a boolean if a field has been set. +func (o *NewApplication) HasExclusiveCampaignsStrategy() bool { + if o != nil && o.ExclusiveCampaignsStrategy != nil { + return true + } + + return false +} + +// SetExclusiveCampaignsStrategy gets a reference to the given string and assigns it to the ExclusiveCampaignsStrategy field. +func (o *NewApplication) SetExclusiveCampaignsStrategy(v string) { + o.ExclusiveCampaignsStrategy = &v +} + +// GetEnableCascadingDiscounts returns the EnableCascadingDiscounts field value if set, zero value otherwise. +func (o *NewApplication) GetEnableCascadingDiscounts() bool { + if o == nil || o.EnableCascadingDiscounts == nil { + var ret bool + return ret + } + return *o.EnableCascadingDiscounts +} + +// GetEnableCascadingDiscountsOk returns a tuple with the EnableCascadingDiscounts field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplication) GetEnableCascadingDiscountsOk() (bool, bool) { + if o == nil || o.EnableCascadingDiscounts == nil { + var ret bool + return ret, false + } + return *o.EnableCascadingDiscounts, true +} + +// HasEnableCascadingDiscounts returns a boolean if a field has been set. +func (o *NewApplication) HasEnableCascadingDiscounts() bool { + if o != nil && o.EnableCascadingDiscounts != nil { + return true + } + + return false +} + +// SetEnableCascadingDiscounts gets a reference to the given bool and assigns it to the EnableCascadingDiscounts field. +func (o *NewApplication) SetEnableCascadingDiscounts(v bool) { + o.EnableCascadingDiscounts = &v +} + +// GetEnableFlattenedCartItems returns the EnableFlattenedCartItems field value if set, zero value otherwise. +func (o *NewApplication) GetEnableFlattenedCartItems() bool { + if o == nil || o.EnableFlattenedCartItems == nil { + var ret bool + return ret + } + return *o.EnableFlattenedCartItems +} + +// GetEnableFlattenedCartItemsOk returns a tuple with the EnableFlattenedCartItems field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplication) GetEnableFlattenedCartItemsOk() (bool, bool) { + if o == nil || o.EnableFlattenedCartItems == nil { + var ret bool + return ret, false + } + return *o.EnableFlattenedCartItems, true +} + +// HasEnableFlattenedCartItems returns a boolean if a field has been set. +func (o *NewApplication) HasEnableFlattenedCartItems() bool { + if o != nil && o.EnableFlattenedCartItems != nil { + return true + } + + return false +} + +// SetEnableFlattenedCartItems gets a reference to the given bool and assigns it to the EnableFlattenedCartItems field. +func (o *NewApplication) SetEnableFlattenedCartItems(v bool) { + o.EnableFlattenedCartItems = &v +} + // GetAttributesSettings returns the AttributesSettings field value if set, zero value otherwise. func (o *NewApplication) GetAttributesSettings() AttributesSettings { if o == nil || o.AttributesSettings == nil { @@ -280,6 +387,39 @@ func (o *NewApplication) SetAttributesSettings(v AttributesSettings) { o.AttributesSettings = &v } +// GetSandbox returns the Sandbox field value if set, zero value otherwise. +func (o *NewApplication) GetSandbox() bool { + if o == nil || o.Sandbox == nil { + var ret bool + return ret + } + return *o.Sandbox +} + +// GetSandboxOk returns a tuple with the Sandbox field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplication) GetSandboxOk() (bool, bool) { + if o == nil || o.Sandbox == nil { + var ret bool + return ret, false + } + return *o.Sandbox, true +} + +// HasSandbox returns a boolean if a field has been set. +func (o *NewApplication) HasSandbox() bool { + if o != nil && o.Sandbox != nil { + return true + } + + return false +} + +// SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. +func (o *NewApplication) SetSandbox(v bool) { + o.Sandbox = &v +} + // GetKey returns the Key field value if set, zero value otherwise. func (o *NewApplication) GetKey() string { if o == nil || o.Key == nil { diff --git a/model_new_application_api_key.go b/model_new_application_api_key.go index e8336707..c829699c 100644 --- a/model_new_application_api_key.go +++ b/model_new_application_api_key.go @@ -17,24 +17,89 @@ import ( // NewApplicationApiKey type NewApplicationApiKey struct { + // Title for API Key + Title string `json:"title"` + // The date the API key expired + Expires time.Time `json:"expires"` + // Platform the API key is valid for. + Platform *string `json:"platform,omitempty"` // ID of the API Key Id int32 `json:"id"` // ID of user who created CreatedBy int32 `json:"createdBy"` - // Title for API Key - Title string `json:"title"` // ID of account the key is used for AccountID int32 `json:"accountID"` // ID of application the key is used for ApplicationID int32 `json:"applicationID"` // The date the API key was created Created time.Time `json:"created"` - // The date the API key expired - Expires time.Time `json:"expires"` // Raw API Key Key string `json:"key"` } +// GetTitle returns the Title field value +func (o *NewApplicationApiKey) GetTitle() string { + if o == nil { + var ret string + return ret + } + + return o.Title +} + +// SetTitle sets field value +func (o *NewApplicationApiKey) SetTitle(v string) { + o.Title = v +} + +// GetExpires returns the Expires field value +func (o *NewApplicationApiKey) GetExpires() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Expires +} + +// SetExpires sets field value +func (o *NewApplicationApiKey) SetExpires(v time.Time) { + o.Expires = v +} + +// GetPlatform returns the Platform field value if set, zero value otherwise. +func (o *NewApplicationApiKey) GetPlatform() string { + if o == nil || o.Platform == nil { + var ret string + return ret + } + return *o.Platform +} + +// GetPlatformOk returns a tuple with the Platform field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplicationApiKey) GetPlatformOk() (string, bool) { + if o == nil || o.Platform == nil { + var ret string + return ret, false + } + return *o.Platform, true +} + +// HasPlatform returns a boolean if a field has been set. +func (o *NewApplicationApiKey) HasPlatform() bool { + if o != nil && o.Platform != nil { + return true + } + + return false +} + +// SetPlatform gets a reference to the given string and assigns it to the Platform field. +func (o *NewApplicationApiKey) SetPlatform(v string) { + o.Platform = &v +} + // GetId returns the Id field value func (o *NewApplicationApiKey) GetId() int32 { if o == nil { @@ -65,21 +130,6 @@ func (o *NewApplicationApiKey) SetCreatedBy(v int32) { o.CreatedBy = v } -// GetTitle returns the Title field value -func (o *NewApplicationApiKey) GetTitle() string { - if o == nil { - var ret string - return ret - } - - return o.Title -} - -// SetTitle sets field value -func (o *NewApplicationApiKey) SetTitle(v string) { - o.Title = v -} - // GetAccountID returns the AccountID field value func (o *NewApplicationApiKey) GetAccountID() int32 { if o == nil { @@ -125,21 +175,6 @@ func (o *NewApplicationApiKey) SetCreated(v time.Time) { o.Created = v } -// GetExpires returns the Expires field value -func (o *NewApplicationApiKey) GetExpires() time.Time { - if o == nil { - var ret time.Time - return ret - } - - return o.Expires -} - -// SetExpires sets field value -func (o *NewApplicationApiKey) SetExpires(v time.Time) { - o.Expires = v -} - // GetKey returns the Key field value func (o *NewApplicationApiKey) GetKey() string { if o == nil { diff --git a/model_new_audience.go b/model_new_audience.go new file mode 100644 index 00000000..74199ee4 --- /dev/null +++ b/model_new_audience.go @@ -0,0 +1,93 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewAudience struct for NewAudience +type NewAudience struct { + // The human-friendly display name for this Audience. + Name string `json:"name"` + // Integration that this audience was created in. + Integration string `json:"integration"` + // The ID of this Audience in the third-party integration + IntegrationId string `json:"integrationId"` +} + +// GetName returns the Name field value +func (o *NewAudience) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *NewAudience) SetName(v string) { + o.Name = v +} + +// GetIntegration returns the Integration field value +func (o *NewAudience) GetIntegration() string { + if o == nil { + var ret string + return ret + } + + return o.Integration +} + +// SetIntegration sets field value +func (o *NewAudience) SetIntegration(v string) { + o.Integration = v +} + +// GetIntegrationId returns the IntegrationId field value +func (o *NewAudience) GetIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.IntegrationId +} + +// SetIntegrationId sets field value +func (o *NewAudience) SetIntegrationId(v string) { + o.IntegrationId = v +} + +type NullableNewAudience struct { + Value NewAudience + ExplicitNull bool +} + +func (v NullableNewAudience) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewAudience) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_campaign.go b/model_new_campaign.go index 9e44e209..31920c17 100644 --- a/model_new_campaign.go +++ b/model_new_campaign.go @@ -39,6 +39,8 @@ type NewCampaign struct { ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` // The set of limits that will operate for this campaign Limits []LimitConfig `json:"limits"` + // The IDs of the campaign groups that own this entity. + CampaignGroups *[]int32 `json:"campaignGroups,omitempty"` } // GetName returns the Name field value @@ -347,6 +349,39 @@ func (o *NewCampaign) SetLimits(v []LimitConfig) { o.Limits = v } +// GetCampaignGroups returns the CampaignGroups field value if set, zero value otherwise. +func (o *NewCampaign) GetCampaignGroups() []int32 { + if o == nil || o.CampaignGroups == nil { + var ret []int32 + return ret + } + return *o.CampaignGroups +} + +// GetCampaignGroupsOk returns a tuple with the CampaignGroups field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCampaign) GetCampaignGroupsOk() ([]int32, bool) { + if o == nil || o.CampaignGroups == nil { + var ret []int32 + return ret, false + } + return *o.CampaignGroups, true +} + +// HasCampaignGroups returns a boolean if a field has been set. +func (o *NewCampaign) HasCampaignGroups() bool { + if o != nil && o.CampaignGroups != nil { + return true + } + + return false +} + +// SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. +func (o *NewCampaign) SetCampaignGroups(v []int32) { + o.CampaignGroups = &v +} + type NullableNewCampaign struct { Value NewCampaign ExplicitNull bool diff --git a/model_new_campaign_group.go b/model_new_campaign_group.go new file mode 100644 index 00000000..42507fa7 --- /dev/null +++ b/model_new_campaign_group.go @@ -0,0 +1,164 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewCampaignGroup struct for NewCampaignGroup +type NewCampaignGroup struct { + // The name of this campaign group. + Name string `json:"name"` + // A longer description of the campaign group. + Description *string `json:"description,omitempty"` + // A list of the IDs of the applications that this campaign group is enabled for + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // A list of the IDs of the campaigns that this campaign group owns + CampaignIds *[]int32 `json:"campaignIds,omitempty"` +} + +// GetName returns the Name field value +func (o *NewCampaignGroup) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *NewCampaignGroup) SetName(v string) { + o.Name = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *NewCampaignGroup) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCampaignGroup) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *NewCampaignGroup) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *NewCampaignGroup) SetDescription(v string) { + o.Description = &v +} + +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *NewCampaignGroup) GetSubscribedApplicationsIds() []int32 { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret + } + return *o.SubscribedApplicationsIds +} + +// GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCampaignGroup) GetSubscribedApplicationsIdsOk() ([]int32, bool) { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret, false + } + return *o.SubscribedApplicationsIds, true +} + +// HasSubscribedApplicationsIds returns a boolean if a field has been set. +func (o *NewCampaignGroup) HasSubscribedApplicationsIds() bool { + if o != nil && o.SubscribedApplicationsIds != nil { + return true + } + + return false +} + +// SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +func (o *NewCampaignGroup) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +// GetCampaignIds returns the CampaignIds field value if set, zero value otherwise. +func (o *NewCampaignGroup) GetCampaignIds() []int32 { + if o == nil || o.CampaignIds == nil { + var ret []int32 + return ret + } + return *o.CampaignIds +} + +// GetCampaignIdsOk returns a tuple with the CampaignIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCampaignGroup) GetCampaignIdsOk() ([]int32, bool) { + if o == nil || o.CampaignIds == nil { + var ret []int32 + return ret, false + } + return *o.CampaignIds, true +} + +// HasCampaignIds returns a boolean if a field has been set. +func (o *NewCampaignGroup) HasCampaignIds() bool { + if o != nil && o.CampaignIds != nil { + return true + } + + return false +} + +// SetCampaignIds gets a reference to the given []int32 and assigns it to the CampaignIds field. +func (o *NewCampaignGroup) SetCampaignIds(v []int32) { + o.CampaignIds = &v +} + +type NullableNewCampaignGroup struct { + Value NewCampaignGroup + ExplicitNull bool +} + +func (v NullableNewCampaignGroup) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewCampaignGroup) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_loyalty_program.go b/model_new_loyalty_program.go index 1827b521..3f50c083 100644 --- a/model_new_loyalty_program.go +++ b/model_new_loyalty_program.go @@ -24,8 +24,10 @@ type NewLoyaltyProgram struct { Description *string `json:"description,omitempty"` // A list containing the IDs of all applications that are subscribed to this Loyalty Program. SubscribedApplications *[]int32 `json:"subscribedApplications,omitempty"` - // Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m' or '30d'. + // Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. DefaultValidity string `json:"defaultValidity"` + // Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. + DefaultPending string `json:"defaultPending"` // Indicates if this program supports subledgers inside the program AllowSubledger bool `json:"allowSubledger"` } @@ -141,6 +143,21 @@ func (o *NewLoyaltyProgram) SetDefaultValidity(v string) { o.DefaultValidity = v } +// GetDefaultPending returns the DefaultPending field value +func (o *NewLoyaltyProgram) GetDefaultPending() string { + if o == nil { + var ret string + return ret + } + + return o.DefaultPending +} + +// SetDefaultPending sets field value +func (o *NewLoyaltyProgram) SetDefaultPending(v string) { + o.DefaultPending = v +} + // GetAllowSubledger returns the AllowSubledger field value func (o *NewLoyaltyProgram) GetAllowSubledger() bool { if o == nil { diff --git a/model_role.go b/model_role.go index 02a49985..96b32a2d 100644 --- a/model_role.go +++ b/model_role.go @@ -20,14 +20,16 @@ type Role struct { Id int32 `json:"id"` // The ID of the Talon.One account that owns this role. AccountID int32 `json:"accountID"` + // The ID of the Campaign Group this role was created for. + CampaignGroupID *int32 `json:"campaignGroupID,omitempty"` // Name of the role Name *string `json:"name,omitempty"` // Description of the role Description *string `json:"description,omitempty"` // A list of user identifiers assigned to this role Members *[]int32 `json:"members,omitempty"` - // Role Policy this should be a stringified blob of json - Acl *string `json:"acl,omitempty"` + // Role ACL Policy + Acl *map[string]interface{} `json:"acl,omitempty"` } // GetId returns the Id field value @@ -60,6 +62,39 @@ func (o *Role) SetAccountID(v int32) { o.AccountID = v } +// GetCampaignGroupID returns the CampaignGroupID field value if set, zero value otherwise. +func (o *Role) GetCampaignGroupID() int32 { + if o == nil || o.CampaignGroupID == nil { + var ret int32 + return ret + } + return *o.CampaignGroupID +} + +// GetCampaignGroupIDOk returns a tuple with the CampaignGroupID field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Role) GetCampaignGroupIDOk() (int32, bool) { + if o == nil || o.CampaignGroupID == nil { + var ret int32 + return ret, false + } + return *o.CampaignGroupID, true +} + +// HasCampaignGroupID returns a boolean if a field has been set. +func (o *Role) HasCampaignGroupID() bool { + if o != nil && o.CampaignGroupID != nil { + return true + } + + return false +} + +// SetCampaignGroupID gets a reference to the given int32 and assigns it to the CampaignGroupID field. +func (o *Role) SetCampaignGroupID(v int32) { + o.CampaignGroupID = &v +} + // GetName returns the Name field value if set, zero value otherwise. func (o *Role) GetName() string { if o == nil || o.Name == nil { @@ -160,9 +195,9 @@ func (o *Role) SetMembers(v []int32) { } // GetAcl returns the Acl field value if set, zero value otherwise. -func (o *Role) GetAcl() string { +func (o *Role) GetAcl() map[string]interface{} { if o == nil || o.Acl == nil { - var ret string + var ret map[string]interface{} return ret } return *o.Acl @@ -170,9 +205,9 @@ func (o *Role) GetAcl() string { // GetAclOk returns a tuple with the Acl field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *Role) GetAclOk() (string, bool) { +func (o *Role) GetAclOk() (map[string]interface{}, bool) { if o == nil || o.Acl == nil { - var ret string + var ret map[string]interface{} return ret, false } return *o.Acl, true @@ -187,8 +222,8 @@ func (o *Role) HasAcl() bool { return false } -// SetAcl gets a reference to the given string and assigns it to the Acl field. -func (o *Role) SetAcl(v string) { +// SetAcl gets a reference to the given map[string]interface{} and assigns it to the Acl field. +func (o *Role) SetAcl(v map[string]interface{}) { o.Acl = &v } diff --git a/model_set_discount_effect_props.go b/model_set_discount_effect_props.go index 9184a356..fdb9a55a 100644 --- a/model_set_discount_effect_props.go +++ b/model_set_discount_effect_props.go @@ -14,12 +14,14 @@ import ( "encoding/json" ) -// SetDiscountEffectProps The properties specific to the \"setDiscount\" effect. This gets triggered whenever a validated rule contained a \"set discount\" effect. This is a discount that should be applied globally on the session total. +// SetDiscountEffectProps The properties specific to the \"setDiscount\" effect. This gets triggered whenever a validated rule contained a \"set discount\" effect. This is a discount that should be applied on the scope of defined with it. type SetDiscountEffectProps struct { // The name/description of this discount Name string `json:"name"` // The total monetary value of the discount Value float32 `json:"value"` + // The scope which the discount was applied on, can be one of (cartItems,additionalCosts,sessionTotal) + Scope *string `json:"scope,omitempty"` } // GetName returns the Name field value @@ -52,6 +54,39 @@ func (o *SetDiscountEffectProps) SetValue(v float32) { o.Value = v } +// GetScope returns the Scope field value if set, zero value otherwise. +func (o *SetDiscountEffectProps) GetScope() string { + if o == nil || o.Scope == nil { + var ret string + return ret + } + return *o.Scope +} + +// GetScopeOk returns a tuple with the Scope field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *SetDiscountEffectProps) GetScopeOk() (string, bool) { + if o == nil || o.Scope == nil { + var ret string + return ret, false + } + return *o.Scope, true +} + +// HasScope returns a boolean if a field has been set. +func (o *SetDiscountEffectProps) HasScope() bool { + if o != nil && o.Scope != nil { + return true + } + + return false +} + +// SetScope gets a reference to the given string and assigns it to the Scope field. +func (o *SetDiscountEffectProps) SetScope(v string) { + o.Scope = &v +} + type NullableSetDiscountEffectProps struct { Value SetDiscountEffectProps ExplicitNull bool diff --git a/model_set_discount_per_item_effect_props.go b/model_set_discount_per_item_effect_props.go index 207a572e..e0278b9f 100644 --- a/model_set_discount_per_item_effect_props.go +++ b/model_set_discount_per_item_effect_props.go @@ -22,6 +22,8 @@ type SetDiscountPerItemEffectProps struct { Value float32 `json:"value"` // The index of the item in the cart items list on which this discount should be applied Position float32 `json:"position"` + // The sub-index of the item in an item stack on which this discount should be applied + SubPosition *float32 `json:"subPosition,omitempty"` } // GetName returns the Name field value @@ -69,6 +71,39 @@ func (o *SetDiscountPerItemEffectProps) SetPosition(v float32) { o.Position = v } +// GetSubPosition returns the SubPosition field value if set, zero value otherwise. +func (o *SetDiscountPerItemEffectProps) GetSubPosition() float32 { + if o == nil || o.SubPosition == nil { + var ret float32 + return ret + } + return *o.SubPosition +} + +// GetSubPositionOk returns a tuple with the SubPosition field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *SetDiscountPerItemEffectProps) GetSubPositionOk() (float32, bool) { + if o == nil || o.SubPosition == nil { + var ret float32 + return ret, false + } + return *o.SubPosition, true +} + +// HasSubPosition returns a boolean if a field has been set. +func (o *SetDiscountPerItemEffectProps) HasSubPosition() bool { + if o != nil && o.SubPosition != nil { + return true + } + + return false +} + +// SetSubPosition gets a reference to the given float32 and assigns it to the SubPosition field. +func (o *SetDiscountPerItemEffectProps) SetSubPosition(v float32) { + o.SubPosition = &v +} + type NullableSetDiscountPerItemEffectProps struct { Value SetDiscountPerItemEffectProps ExplicitNull bool diff --git a/model_update_application.go b/model_update_application.go index 1260ada1..5432fac7 100644 --- a/model_update_application.go +++ b/model_update_application.go @@ -30,9 +30,17 @@ type UpdateApplication struct { Attributes *map[string]interface{} `json:"attributes,omitempty"` // Default limits for campaigns created in this application Limits *[]LimitConfig `json:"limits,omitempty"` - // Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive) - CampaignPriority *string `json:"campaignPriority,omitempty"` - AttributesSettings *AttributesSettings `json:"attributesSettings,omitempty"` + // Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" + CampaignPriority *string `json:"campaignPriority,omitempty"` + // The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" + ExclusiveCampaignsStrategy *string `json:"exclusiveCampaignsStrategy,omitempty"` + // Flag indicating if discounts should cascade for this application + EnableCascadingDiscounts *bool `json:"enableCascadingDiscounts,omitempty"` + // Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one + EnableFlattenedCartItems *bool `json:"enableFlattenedCartItems,omitempty"` + AttributesSettings *AttributesSettings `json:"attributesSettings,omitempty"` + // Flag indicating if this is a live or sandbox application + Sandbox *bool `json:"sandbox,omitempty"` } // GetName returns the Name field value @@ -245,6 +253,105 @@ func (o *UpdateApplication) SetCampaignPriority(v string) { o.CampaignPriority = &v } +// GetExclusiveCampaignsStrategy returns the ExclusiveCampaignsStrategy field value if set, zero value otherwise. +func (o *UpdateApplication) GetExclusiveCampaignsStrategy() string { + if o == nil || o.ExclusiveCampaignsStrategy == nil { + var ret string + return ret + } + return *o.ExclusiveCampaignsStrategy +} + +// GetExclusiveCampaignsStrategyOk returns a tuple with the ExclusiveCampaignsStrategy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateApplication) GetExclusiveCampaignsStrategyOk() (string, bool) { + if o == nil || o.ExclusiveCampaignsStrategy == nil { + var ret string + return ret, false + } + return *o.ExclusiveCampaignsStrategy, true +} + +// HasExclusiveCampaignsStrategy returns a boolean if a field has been set. +func (o *UpdateApplication) HasExclusiveCampaignsStrategy() bool { + if o != nil && o.ExclusiveCampaignsStrategy != nil { + return true + } + + return false +} + +// SetExclusiveCampaignsStrategy gets a reference to the given string and assigns it to the ExclusiveCampaignsStrategy field. +func (o *UpdateApplication) SetExclusiveCampaignsStrategy(v string) { + o.ExclusiveCampaignsStrategy = &v +} + +// GetEnableCascadingDiscounts returns the EnableCascadingDiscounts field value if set, zero value otherwise. +func (o *UpdateApplication) GetEnableCascadingDiscounts() bool { + if o == nil || o.EnableCascadingDiscounts == nil { + var ret bool + return ret + } + return *o.EnableCascadingDiscounts +} + +// GetEnableCascadingDiscountsOk returns a tuple with the EnableCascadingDiscounts field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateApplication) GetEnableCascadingDiscountsOk() (bool, bool) { + if o == nil || o.EnableCascadingDiscounts == nil { + var ret bool + return ret, false + } + return *o.EnableCascadingDiscounts, true +} + +// HasEnableCascadingDiscounts returns a boolean if a field has been set. +func (o *UpdateApplication) HasEnableCascadingDiscounts() bool { + if o != nil && o.EnableCascadingDiscounts != nil { + return true + } + + return false +} + +// SetEnableCascadingDiscounts gets a reference to the given bool and assigns it to the EnableCascadingDiscounts field. +func (o *UpdateApplication) SetEnableCascadingDiscounts(v bool) { + o.EnableCascadingDiscounts = &v +} + +// GetEnableFlattenedCartItems returns the EnableFlattenedCartItems field value if set, zero value otherwise. +func (o *UpdateApplication) GetEnableFlattenedCartItems() bool { + if o == nil || o.EnableFlattenedCartItems == nil { + var ret bool + return ret + } + return *o.EnableFlattenedCartItems +} + +// GetEnableFlattenedCartItemsOk returns a tuple with the EnableFlattenedCartItems field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateApplication) GetEnableFlattenedCartItemsOk() (bool, bool) { + if o == nil || o.EnableFlattenedCartItems == nil { + var ret bool + return ret, false + } + return *o.EnableFlattenedCartItems, true +} + +// HasEnableFlattenedCartItems returns a boolean if a field has been set. +func (o *UpdateApplication) HasEnableFlattenedCartItems() bool { + if o != nil && o.EnableFlattenedCartItems != nil { + return true + } + + return false +} + +// SetEnableFlattenedCartItems gets a reference to the given bool and assigns it to the EnableFlattenedCartItems field. +func (o *UpdateApplication) SetEnableFlattenedCartItems(v bool) { + o.EnableFlattenedCartItems = &v +} + // GetAttributesSettings returns the AttributesSettings field value if set, zero value otherwise. func (o *UpdateApplication) GetAttributesSettings() AttributesSettings { if o == nil || o.AttributesSettings == nil { @@ -278,6 +385,39 @@ func (o *UpdateApplication) SetAttributesSettings(v AttributesSettings) { o.AttributesSettings = &v } +// GetSandbox returns the Sandbox field value if set, zero value otherwise. +func (o *UpdateApplication) GetSandbox() bool { + if o == nil || o.Sandbox == nil { + var ret bool + return ret + } + return *o.Sandbox +} + +// GetSandboxOk returns a tuple with the Sandbox field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateApplication) GetSandboxOk() (bool, bool) { + if o == nil || o.Sandbox == nil { + var ret bool + return ret, false + } + return *o.Sandbox, true +} + +// HasSandbox returns a boolean if a field has been set. +func (o *UpdateApplication) HasSandbox() bool { + if o != nil && o.Sandbox != nil { + return true + } + + return false +} + +// SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. +func (o *UpdateApplication) SetSandbox(v bool) { + o.Sandbox = &v +} + type NullableUpdateApplication struct { Value UpdateApplication ExplicitNull bool diff --git a/model_customer_profile_update.go b/model_update_audience.go similarity index 61% rename from model_customer_profile_update.go rename to model_update_audience.go index b2d7b63d..552942ed 100644 --- a/model_customer_profile_update.go +++ b/model_update_audience.go @@ -14,32 +14,33 @@ import ( "encoding/json" ) -// CustomerProfileUpdate struct for CustomerProfileUpdate -type CustomerProfileUpdate struct { - CustomerProfile CustomerProfile `json:"customerProfile"` +// UpdateAudience struct for UpdateAudience +type UpdateAudience struct { + // The human-friendly display name for this Audience. + Name string `json:"name"` } -// GetCustomerProfile returns the CustomerProfile field value -func (o *CustomerProfileUpdate) GetCustomerProfile() CustomerProfile { +// GetName returns the Name field value +func (o *UpdateAudience) GetName() string { if o == nil { - var ret CustomerProfile + var ret string return ret } - return o.CustomerProfile + return o.Name } -// SetCustomerProfile sets field value -func (o *CustomerProfileUpdate) SetCustomerProfile(v CustomerProfile) { - o.CustomerProfile = v +// SetName sets field value +func (o *UpdateAudience) SetName(v string) { + o.Name = v } -type NullableCustomerProfileUpdate struct { - Value CustomerProfileUpdate +type NullableUpdateAudience struct { + Value UpdateAudience ExplicitNull bool } -func (v NullableCustomerProfileUpdate) MarshalJSON() ([]byte, error) { +func (v NullableUpdateAudience) MarshalJSON() ([]byte, error) { switch { case v.ExplicitNull: return []byte("null"), nil @@ -48,7 +49,7 @@ func (v NullableCustomerProfileUpdate) MarshalJSON() ([]byte, error) { } } -func (v *NullableCustomerProfileUpdate) UnmarshalJSON(src []byte) error { +func (v *NullableUpdateAudience) UnmarshalJSON(src []byte) error { if bytes.Equal(src, []byte("null")) { v.ExplicitNull = true return nil diff --git a/model_update_campaign.go b/model_update_campaign.go index 1e1cf239..27d1aa02 100644 --- a/model_update_campaign.go +++ b/model_update_campaign.go @@ -39,6 +39,8 @@ type UpdateCampaign struct { ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` // The set of limits that will operate for this campaign Limits []LimitConfig `json:"limits"` + // The IDs of the campaign groups that own this entity. + CampaignGroups *[]int32 `json:"campaignGroups,omitempty"` } // GetName returns the Name field value @@ -365,6 +367,39 @@ func (o *UpdateCampaign) SetLimits(v []LimitConfig) { o.Limits = v } +// GetCampaignGroups returns the CampaignGroups field value if set, zero value otherwise. +func (o *UpdateCampaign) GetCampaignGroups() []int32 { + if o == nil || o.CampaignGroups == nil { + var ret []int32 + return ret + } + return *o.CampaignGroups +} + +// GetCampaignGroupsOk returns a tuple with the CampaignGroups field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCampaign) GetCampaignGroupsOk() ([]int32, bool) { + if o == nil || o.CampaignGroups == nil { + var ret []int32 + return ret, false + } + return *o.CampaignGroups, true +} + +// HasCampaignGroups returns a boolean if a field has been set. +func (o *UpdateCampaign) HasCampaignGroups() bool { + if o != nil && o.CampaignGroups != nil { + return true + } + + return false +} + +// SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. +func (o *UpdateCampaign) SetCampaignGroups(v []int32) { + o.CampaignGroups = &v +} + type NullableUpdateCampaign struct { Value UpdateCampaign ExplicitNull bool diff --git a/model_update_campaign_group.go b/model_update_campaign_group.go new file mode 100644 index 00000000..980c2941 --- /dev/null +++ b/model_update_campaign_group.go @@ -0,0 +1,164 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// UpdateCampaignGroup +type UpdateCampaignGroup struct { + // The name of this campaign group. + Name string `json:"name"` + // A longer description of the campaign group. + Description *string `json:"description,omitempty"` + // A list of the IDs of the applications that this campaign group is enabled for + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // A list of the IDs of the campaigns that this campaign group owns + CampaignIds *[]int32 `json:"campaignIds,omitempty"` +} + +// GetName returns the Name field value +func (o *UpdateCampaignGroup) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *UpdateCampaignGroup) SetName(v string) { + o.Name = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *UpdateCampaignGroup) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCampaignGroup) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *UpdateCampaignGroup) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *UpdateCampaignGroup) SetDescription(v string) { + o.Description = &v +} + +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *UpdateCampaignGroup) GetSubscribedApplicationsIds() []int32 { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret + } + return *o.SubscribedApplicationsIds +} + +// GetSubscribedApplicationsIdsOk returns a tuple with the SubscribedApplicationsIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCampaignGroup) GetSubscribedApplicationsIdsOk() ([]int32, bool) { + if o == nil || o.SubscribedApplicationsIds == nil { + var ret []int32 + return ret, false + } + return *o.SubscribedApplicationsIds, true +} + +// HasSubscribedApplicationsIds returns a boolean if a field has been set. +func (o *UpdateCampaignGroup) HasSubscribedApplicationsIds() bool { + if o != nil && o.SubscribedApplicationsIds != nil { + return true + } + + return false +} + +// SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. +func (o *UpdateCampaignGroup) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +// GetCampaignIds returns the CampaignIds field value if set, zero value otherwise. +func (o *UpdateCampaignGroup) GetCampaignIds() []int32 { + if o == nil || o.CampaignIds == nil { + var ret []int32 + return ret + } + return *o.CampaignIds +} + +// GetCampaignIdsOk returns a tuple with the CampaignIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCampaignGroup) GetCampaignIdsOk() ([]int32, bool) { + if o == nil || o.CampaignIds == nil { + var ret []int32 + return ret, false + } + return *o.CampaignIds, true +} + +// HasCampaignIds returns a boolean if a field has been set. +func (o *UpdateCampaignGroup) HasCampaignIds() bool { + if o != nil && o.CampaignIds != nil { + return true + } + + return false +} + +// SetCampaignIds gets a reference to the given []int32 and assigns it to the CampaignIds field. +func (o *UpdateCampaignGroup) SetCampaignIds(v []int32) { + o.CampaignIds = &v +} + +type NullableUpdateCampaignGroup struct { + Value UpdateCampaignGroup + ExplicitNull bool +} + +func (v NullableUpdateCampaignGroup) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableUpdateCampaignGroup) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_update_loyalty_program.go b/model_update_loyalty_program.go index b70515a4..b08bc062 100644 --- a/model_update_loyalty_program.go +++ b/model_update_loyalty_program.go @@ -22,8 +22,10 @@ type UpdateLoyaltyProgram struct { Description *string `json:"description,omitempty"` // A list containing the IDs of all applications that are subscribed to this Loyalty Program. SubscribedApplications *[]int32 `json:"subscribedApplications,omitempty"` - // Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m' or '30d'. + // Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. DefaultValidity *string `json:"defaultValidity,omitempty"` + // Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. + DefaultPending *string `json:"defaultPending,omitempty"` // Indicates if this program supports subledgers inside the program AllowSubledger *bool `json:"allowSubledger,omitempty"` } @@ -160,6 +162,39 @@ func (o *UpdateLoyaltyProgram) SetDefaultValidity(v string) { o.DefaultValidity = &v } +// GetDefaultPending returns the DefaultPending field value if set, zero value otherwise. +func (o *UpdateLoyaltyProgram) GetDefaultPending() string { + if o == nil || o.DefaultPending == nil { + var ret string + return ret + } + return *o.DefaultPending +} + +// GetDefaultPendingOk returns a tuple with the DefaultPending field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateLoyaltyProgram) GetDefaultPendingOk() (string, bool) { + if o == nil || o.DefaultPending == nil { + var ret string + return ret, false + } + return *o.DefaultPending, true +} + +// HasDefaultPending returns a boolean if a field has been set. +func (o *UpdateLoyaltyProgram) HasDefaultPending() bool { + if o != nil && o.DefaultPending != nil { + return true + } + + return false +} + +// SetDefaultPending gets a reference to the given string and assigns it to the DefaultPending field. +func (o *UpdateLoyaltyProgram) SetDefaultPending(v string) { + o.DefaultPending = &v +} + // GetAllowSubledger returns the AllowSubledger field value if set, zero value otherwise. func (o *UpdateLoyaltyProgram) GetAllowSubledger() bool { if o == nil || o.AllowSubledger == nil { diff --git a/model_update_user.go b/model_update_user.go index 289874b1..c1fb21d2 100644 --- a/model_update_user.go +++ b/model_update_user.go @@ -22,10 +22,6 @@ type UpdateUser struct { Policy *string `json:"policy,omitempty"` // New state (\"deactivated\" or \"active\") for the user. Only usable by admins for the user. State *string `json:"state,omitempty"` - // Update the user via email - ReleaseUpdate *bool `json:"releaseUpdate,omitempty"` - // The latest feature you've been notified. - LatestFeature *string `json:"latestFeature,omitempty"` // Update Roles *[]int32 `json:"roles,omitempty"` ApplicationNotificationSubscriptions *map[string]interface{} `json:"applicationNotificationSubscriptions,omitempty"` @@ -130,72 +126,6 @@ func (o *UpdateUser) SetState(v string) { o.State = &v } -// GetReleaseUpdate returns the ReleaseUpdate field value if set, zero value otherwise. -func (o *UpdateUser) GetReleaseUpdate() bool { - if o == nil || o.ReleaseUpdate == nil { - var ret bool - return ret - } - return *o.ReleaseUpdate -} - -// GetReleaseUpdateOk returns a tuple with the ReleaseUpdate field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *UpdateUser) GetReleaseUpdateOk() (bool, bool) { - if o == nil || o.ReleaseUpdate == nil { - var ret bool - return ret, false - } - return *o.ReleaseUpdate, true -} - -// HasReleaseUpdate returns a boolean if a field has been set. -func (o *UpdateUser) HasReleaseUpdate() bool { - if o != nil && o.ReleaseUpdate != nil { - return true - } - - return false -} - -// SetReleaseUpdate gets a reference to the given bool and assigns it to the ReleaseUpdate field. -func (o *UpdateUser) SetReleaseUpdate(v bool) { - o.ReleaseUpdate = &v -} - -// GetLatestFeature returns the LatestFeature field value if set, zero value otherwise. -func (o *UpdateUser) GetLatestFeature() string { - if o == nil || o.LatestFeature == nil { - var ret string - return ret - } - return *o.LatestFeature -} - -// GetLatestFeatureOk returns a tuple with the LatestFeature field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *UpdateUser) GetLatestFeatureOk() (string, bool) { - if o == nil || o.LatestFeature == nil { - var ret string - return ret, false - } - return *o.LatestFeature, true -} - -// HasLatestFeature returns a boolean if a field has been set. -func (o *UpdateUser) HasLatestFeature() bool { - if o != nil && o.LatestFeature != nil { - return true - } - - return false -} - -// SetLatestFeature gets a reference to the given string and assigns it to the LatestFeature field. -func (o *UpdateUser) SetLatestFeature(v string) { - o.LatestFeature = &v -} - // GetRoles returns the Roles field value if set, zero value otherwise. func (o *UpdateUser) GetRoles() []int32 { if o == nil || o.Roles == nil { diff --git a/model_update_user_latest_feed_timestamp.go b/model_update_user_latest_feed_timestamp.go new file mode 100644 index 00000000..6b458df5 --- /dev/null +++ b/model_update_user_latest_feed_timestamp.go @@ -0,0 +1,60 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// UpdateUserLatestFeedTimestamp Updates current user's latest seen notifications timestamp +type UpdateUserLatestFeedTimestamp struct { + // New timestamp to update for the current user + NewLatestFeedTimestamp time.Time `json:"newLatestFeedTimestamp"` +} + +// GetNewLatestFeedTimestamp returns the NewLatestFeedTimestamp field value +func (o *UpdateUserLatestFeedTimestamp) GetNewLatestFeedTimestamp() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.NewLatestFeedTimestamp +} + +// SetNewLatestFeedTimestamp sets field value +func (o *UpdateUserLatestFeedTimestamp) SetNewLatestFeedTimestamp(v time.Time) { + o.NewLatestFeedTimestamp = v +} + +type NullableUpdateUserLatestFeedTimestamp struct { + Value UpdateUserLatestFeedTimestamp + ExplicitNull bool +} + +func (v NullableUpdateUserLatestFeedTimestamp) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableUpdateUserLatestFeedTimestamp) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_user.go b/model_user.go index 92424823..ff3c8553 100644 --- a/model_user.go +++ b/model_user.go @@ -33,12 +33,10 @@ type User struct { State string `json:"state"` // Full name Name string `json:"name"` - // A blob of ACL JSON - Policy string `json:"policy"` - // Update the user via email - ReleaseUpdate bool `json:"releaseUpdate"` - // Latest feature the user has been notified. - LatestFeature *string `json:"latestFeature,omitempty"` + // User ACL Policy + Policy map[string]interface{} `json:"policy"` + // Latest timestamp the user has been notified for feed. + LatestFeedTimestamp *time.Time `json:"latestFeedTimestamp,omitempty"` // Contains a list of all roles the user is a member of Roles *[]int32 `json:"roles,omitempty"` ApplicationNotificationSubscriptions *map[string]interface{} `json:"applicationNotificationSubscriptions,omitempty"` @@ -167,9 +165,9 @@ func (o *User) SetName(v string) { } // GetPolicy returns the Policy field value -func (o *User) GetPolicy() string { +func (o *User) GetPolicy() map[string]interface{} { if o == nil { - var ret string + var ret map[string]interface{} return ret } @@ -177,56 +175,41 @@ func (o *User) GetPolicy() string { } // SetPolicy sets field value -func (o *User) SetPolicy(v string) { +func (o *User) SetPolicy(v map[string]interface{}) { o.Policy = v } -// GetReleaseUpdate returns the ReleaseUpdate field value -func (o *User) GetReleaseUpdate() bool { - if o == nil { - var ret bool - return ret - } - - return o.ReleaseUpdate -} - -// SetReleaseUpdate sets field value -func (o *User) SetReleaseUpdate(v bool) { - o.ReleaseUpdate = v -} - -// GetLatestFeature returns the LatestFeature field value if set, zero value otherwise. -func (o *User) GetLatestFeature() string { - if o == nil || o.LatestFeature == nil { - var ret string +// GetLatestFeedTimestamp returns the LatestFeedTimestamp field value if set, zero value otherwise. +func (o *User) GetLatestFeedTimestamp() time.Time { + if o == nil || o.LatestFeedTimestamp == nil { + var ret time.Time return ret } - return *o.LatestFeature + return *o.LatestFeedTimestamp } -// GetLatestFeatureOk returns a tuple with the LatestFeature field value if set, zero value otherwise +// GetLatestFeedTimestampOk returns a tuple with the LatestFeedTimestamp field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *User) GetLatestFeatureOk() (string, bool) { - if o == nil || o.LatestFeature == nil { - var ret string +func (o *User) GetLatestFeedTimestampOk() (time.Time, bool) { + if o == nil || o.LatestFeedTimestamp == nil { + var ret time.Time return ret, false } - return *o.LatestFeature, true + return *o.LatestFeedTimestamp, true } -// HasLatestFeature returns a boolean if a field has been set. -func (o *User) HasLatestFeature() bool { - if o != nil && o.LatestFeature != nil { +// HasLatestFeedTimestamp returns a boolean if a field has been set. +func (o *User) HasLatestFeedTimestamp() bool { + if o != nil && o.LatestFeedTimestamp != nil { return true } return false } -// SetLatestFeature gets a reference to the given string and assigns it to the LatestFeature field. -func (o *User) SetLatestFeature(v string) { - o.LatestFeature = &v +// SetLatestFeedTimestamp gets a reference to the given time.Time and assigns it to the LatestFeedTimestamp field. +func (o *User) SetLatestFeedTimestamp(v time.Time) { + o.LatestFeedTimestamp = &v } // GetRoles returns the Roles field value if set, zero value otherwise. diff --git a/model_user_feed_notifications.go b/model_user_feed_notifications.go new file mode 100644 index 00000000..8722a01f --- /dev/null +++ b/model_user_feed_notifications.go @@ -0,0 +1,77 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put + * + * API version: 1.0.0 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// UserFeedNotifications notifications to notify CAMA user about +type UserFeedNotifications struct { + // Timestamp of the last request for this list + LastUpdate time.Time `json:"lastUpdate"` + // List of all notifications to notify the user about + Notifications []FeedNotification `json:"notifications"` +} + +// GetLastUpdate returns the LastUpdate field value +func (o *UserFeedNotifications) GetLastUpdate() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.LastUpdate +} + +// SetLastUpdate sets field value +func (o *UserFeedNotifications) SetLastUpdate(v time.Time) { + o.LastUpdate = v +} + +// GetNotifications returns the Notifications field value +func (o *UserFeedNotifications) GetNotifications() []FeedNotification { + if o == nil { + var ret []FeedNotification + return ret + } + + return o.Notifications +} + +// SetNotifications sets field value +func (o *UserFeedNotifications) SetNotifications(v []FeedNotification) { + o.Notifications = v +} + +type NullableUserFeedNotifications struct { + Value UserFeedNotifications + ExplicitNull bool +} + +func (v NullableUserFeedNotifications) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableUserFeedNotifications) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +}