diff --git a/README.md b/README.md index 44ed38cf..e49bf5de 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.3.0 +- Package version: 2.4.0 - Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen ## Installation @@ -339,6 +339,7 @@ Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *IntegrationApi* | [**CreateCouponReservation**](docs/IntegrationApi.md#createcouponreservation) | **Post** /v1/coupon_reservations/{couponValue} | Create a new coupon reservation *IntegrationApi* | [**CreateReferral**](docs/IntegrationApi.md#createreferral) | **Post** /v1/referrals | Create a referral code for an advocate +*IntegrationApi* | [**CreateReferralsForMultipleAdvocates**](docs/IntegrationApi.md#createreferralsformultipleadvocates) | **Post** /v1/referrals_for_multiple_advocates | Create referral codes for multiple advocates *IntegrationApi* | [**DeleteCouponReservation**](docs/IntegrationApi.md#deletecouponreservation) | **Delete** /v1/coupon_reservations/{couponValue} | Delete coupon reservations *IntegrationApi* | [**DeleteCustomerData**](docs/IntegrationApi.md#deletecustomerdata) | **Delete** /v1/customer_data/{integrationId} | Delete the personal data of a customer *IntegrationApi* | [**GetCustomerInventory**](docs/IntegrationApi.md#getcustomerinventory) | **Get** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile @@ -426,6 +427,10 @@ Class | Method | HTTP request | Description *ManagementApi* | [**GetWebhookActivationLogs**](docs/ManagementApi.md#getwebhookactivationlogs) | **Get** /v1/webhook_activation_logs | List Webhook activation Log Entries *ManagementApi* | [**GetWebhookLogs**](docs/ManagementApi.md#getwebhooklogs) | **Get** /v1/webhook_logs | List Webhook Log Entries *ManagementApi* | [**GetWebhooks**](docs/ManagementApi.md#getwebhooks) | **Get** /v1/webhooks | List Webhooks +*ManagementApi* | [**ImportCoupons**](docs/ManagementApi.md#importcoupons) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons via CSV file +*ManagementApi* | [**ImportLoyaltyPoints**](docs/ManagementApi.md#importloyaltypoints) | **Post** /v1/loyalty_programs/{programID}/import_points | Import loyalty points via CSV file +*ManagementApi* | [**ImportPoolGiveaways**](docs/ManagementApi.md#importpoolgiveaways) | **Post** /v1/giveaways/pools/{poolId}/import | Import giveaways codes into a giveaways pool +*ManagementApi* | [**ImportReferrals**](docs/ManagementApi.md#importreferrals) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals via CSV file *ManagementApi* | [**RemoveLoyaltyPoints**](docs/ManagementApi.md#removeloyaltypoints) | **Put** /v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points | Deduct points in a certain loyalty program for the specified customer *ManagementApi* | [**ResetPassword**](docs/ManagementApi.md#resetpassword) | **Post** /v1/reset_password | Reset password *ManagementApi* | [**SearchCouponsAdvanced**](docs/ManagementApi.md#searchcouponsadvanced) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced | Get a list of the coupons that match the given attributes (with total count) @@ -437,6 +442,7 @@ Class | Method | HTTP request | Description *ManagementApi* | [**UpdateCampaign**](docs/ManagementApi.md#updatecampaign) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign *ManagementApi* | [**UpdateCoupon**](docs/ManagementApi.md#updatecoupon) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon *ManagementApi* | [**UpdateCouponBatch**](docs/ManagementApi.md#updatecouponbatch) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update a Batch of Coupons +*ManagementApi* | [**UpdateReferral**](docs/ManagementApi.md#updatereferral) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update one Referral *ManagementApi* | [**UpdateRuleset**](docs/ManagementApi.md#updateruleset) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Update a Ruleset @@ -457,11 +463,13 @@ Class | Method | HTTP request | Description - [Application](docs/Application.md) - [ApplicationApiHealth](docs/ApplicationApiHealth.md) - [ApplicationApiKey](docs/ApplicationApiKey.md) + - [ApplicationCampaignStats](docs/ApplicationCampaignStats.md) - [ApplicationCustomer](docs/ApplicationCustomer.md) - [ApplicationCustomerEntity](docs/ApplicationCustomerEntity.md) - [ApplicationCustomerSearch](docs/ApplicationCustomerSearch.md) - [ApplicationEntity](docs/ApplicationEntity.md) - [ApplicationEvent](docs/ApplicationEvent.md) + - [ApplicationReferee](docs/ApplicationReferee.md) - [ApplicationSession](docs/ApplicationSession.md) - [ApplicationSessionEntity](docs/ApplicationSessionEntity.md) - [Attribute](docs/Attribute.md) @@ -469,6 +477,7 @@ Class | Method | HTTP request | Description - [AttributesSettings](docs/AttributesSettings.md) - [Audience](docs/Audience.md) - [AudienceMembership](docs/AudienceMembership.md) + - [AwardGiveawayEffectProps](docs/AwardGiveawayEffectProps.md) - [BaseSamlConnection](docs/BaseSamlConnection.md) - [Binding](docs/Binding.md) - [Campaign](docs/Campaign.md) @@ -494,6 +503,8 @@ Class | Method | HTTP request | Description - [CouponSearch](docs/CouponSearch.md) - [CouponValue](docs/CouponValue.md) - [CreateApplicationApiKey](docs/CreateApplicationApiKey.md) + - [CustomEffect](docs/CustomEffect.md) + - [CustomEffectProps](docs/CustomEffectProps.md) - [CustomerActivityReport](docs/CustomerActivityReport.md) - [CustomerAnalytics](docs/CustomerAnalytics.md) - [CustomerInventory](docs/CustomerInventory.md) @@ -523,7 +534,10 @@ Class | Method | HTTP request | Description - [FeedNotification](docs/FeedNotification.md) - [FuncArgDef](docs/FuncArgDef.md) - [FunctionDef](docs/FunctionDef.md) + - [Giveaway](docs/Giveaway.md) + - [GiveawaysPool](docs/GiveawaysPool.md) - [Import](docs/Import.md) + - [ImportEntity](docs/ImportEntity.md) - [InlineResponse200](docs/InlineResponse200.md) - [InlineResponse2001](docs/InlineResponse2001.md) - [InlineResponse20010](docs/InlineResponse20010.md) @@ -548,19 +562,20 @@ Class | Method | HTTP request | Description - [InlineResponse20028](docs/InlineResponse20028.md) - [InlineResponse20029](docs/InlineResponse20029.md) - [InlineResponse2003](docs/InlineResponse2003.md) - - [InlineResponse20030](docs/InlineResponse20030.md) - [InlineResponse2004](docs/InlineResponse2004.md) - [InlineResponse2005](docs/InlineResponse2005.md) - [InlineResponse2006](docs/InlineResponse2006.md) - [InlineResponse2007](docs/InlineResponse2007.md) - [InlineResponse2008](docs/InlineResponse2008.md) - [InlineResponse2009](docs/InlineResponse2009.md) + - [InlineResponse201](docs/InlineResponse201.md) - [IntegrationEntity](docs/IntegrationEntity.md) - [IntegrationEvent](docs/IntegrationEvent.md) - [IntegrationProfileEntity](docs/IntegrationProfileEntity.md) - [IntegrationRequest](docs/IntegrationRequest.md) - [IntegrationState](docs/IntegrationState.md) - [IntegrationStateV2](docs/IntegrationStateV2.md) + - [InventoryCoupon](docs/InventoryCoupon.md) - [LedgerEntry](docs/LedgerEntry.md) - [LibraryAttribute](docs/LibraryAttribute.md) - [LimitConfig](docs/LimitConfig.md) @@ -572,9 +587,11 @@ Class | Method | HTTP request | Description - [LoyaltyPoints](docs/LoyaltyPoints.md) - [LoyaltyProgram](docs/LoyaltyProgram.md) - [LoyaltyProgramBalance](docs/LoyaltyProgramBalance.md) + - [LoyaltyProgramEntity](docs/LoyaltyProgramEntity.md) - [LoyaltyProgramLedgers](docs/LoyaltyProgramLedgers.md) - [LoyaltyStatistics](docs/LoyaltyStatistics.md) - [LoyaltySubLedger](docs/LoyaltySubLedger.md) + - [LoyaltyTier](docs/LoyaltyTier.md) - [ManagerConfig](docs/ManagerConfig.md) - [Meta](docs/Meta.md) - [MultiApplicationEntity](docs/MultiApplicationEntity.md) @@ -594,18 +611,22 @@ Class | Method | HTTP request | Description - [NewCampaignSet](docs/NewCampaignSet.md) - [NewCoupons](docs/NewCoupons.md) - [NewCouponsForMultipleRecipients](docs/NewCouponsForMultipleRecipients.md) + - [NewCustomEffect](docs/NewCustomEffect.md) - [NewCustomerProfile](docs/NewCustomerProfile.md) - [NewCustomerSession](docs/NewCustomerSession.md) - [NewCustomerSessionV2](docs/NewCustomerSessionV2.md) - [NewEvent](docs/NewEvent.md) - [NewEventType](docs/NewEventType.md) - [NewFeatureFlags](docs/NewFeatureFlags.md) + - [NewGiveawaysPool](docs/NewGiveawaysPool.md) - [NewInvitation](docs/NewInvitation.md) - [NewInviteEmail](docs/NewInviteEmail.md) - [NewLoyaltyProgram](docs/NewLoyaltyProgram.md) + - [NewLoyaltyTier](docs/NewLoyaltyTier.md) - [NewPassword](docs/NewPassword.md) - [NewPasswordEmail](docs/NewPasswordEmail.md) - [NewReferral](docs/NewReferral.md) + - [NewReferralsForMultipleAdvocates](docs/NewReferralsForMultipleAdvocates.md) - [NewRole](docs/NewRole.md) - [NewRuleset](docs/NewRuleset.md) - [NewSamlConnection](docs/NewSamlConnection.md) @@ -616,6 +637,7 @@ Class | Method | HTTP request | Description - [ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md) - [RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md) - [Referral](docs/Referral.md) + - [ReferralConstraints](docs/ReferralConstraints.md) - [ReferralCreatedEffectProps](docs/ReferralCreatedEffectProps.md) - [ReferralRejectionReason](docs/ReferralRejectionReason.md) - [RejectCouponEffectProps](docs/RejectCouponEffectProps.md) @@ -651,7 +673,10 @@ Class | Method | HTTP request | Description - [UpdateCampaignGroup](docs/UpdateCampaignGroup.md) - [UpdateCoupon](docs/UpdateCoupon.md) - [UpdateCouponBatch](docs/UpdateCouponBatch.md) + - [UpdateCustomEffect](docs/UpdateCustomEffect.md) - [UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md) + - [UpdateLoyaltyTier](docs/UpdateLoyaltyTier.md) + - [UpdateReferral](docs/UpdateReferral.md) - [UpdateRole](docs/UpdateRole.md) - [UpdateUser](docs/UpdateUser.md) - [UpdateUserLatestFeedTimestamp](docs/UpdateUserLatestFeedTimestamp.md) @@ -661,6 +686,7 @@ Class | Method | HTTP request | Description - [Webhook](docs/Webhook.md) - [WebhookActivationLogEntry](docs/WebhookActivationLogEntry.md) - [WebhookLogEntry](docs/WebhookLogEntry.md) + - [WillAwardGiveawayEffectProps](docs/WillAwardGiveawayEffectProps.md) ## Documentation For Authorization diff --git a/api/openapi.yaml b/api/openapi.yaml index 15fda09c..a4a8bb99 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -30,9 +30,9 @@ tags: Operations for logging in/out of the Campaign Manager. name: Sessions - description: | - Applications are the highest level of organization in your Talon.One account. - You may have multiple applications within one account, for example staging and production, or different international markets. + Every request to the Integration API comes from an application. An application is typically an e-commerce site, a mobile app, or some other source of customer actions. An application is the owner of the API key used to send integration data. + You may have multiple applications within one account, for example staging and production, or different international markets. name: Applications - description: | Analytics are used to retrieve statistical data about the performance of campaigns within an application. @@ -43,9 +43,8 @@ tags: - description: | Coupons are unique codes belonging to a particular campaign. They don't define any behavior on their own, instead the campaign ruleset can include rules that validate coupons and carry out particular effects. name: Coupons -- description: Talon.One is extremely customizable. These API operations allow you - to alter the data model and rule builder to better suit Talon.One to the needs - of your business. +- description: Operations to alter the data model and Rule Engine to better suit Talon.One + to the needs of your business. name: Customization - description: | Campaign Analytics are used to retrieve statistical data about the performance of a specific campaign. @@ -54,11 +53,18 @@ tags: Customer Data operations are used to retrieve data about customers/sessions/events for reporting and debugging in the Campaign Manager. name: Customer Data - description: | - The Talon.One API records all incoming and outgoing requests. These API operations allow you to query those logs. + Operations to query the Talon.One logs. They contain all incomming and outgoing requests. name: Logs - description: | Operations for updating account information such as billing email addresses, inviting users, etc. name: Accounts & Users +- description: | + A referral is a code shared between a customer and a prospect. + A referral is defined by an advocate, a friend and a referral code. The advocate is the person who + invited their friend via referral program. The friend is the person who receives the invite from an advocate + The referral code is a code which is generated similar to a coupon code the code can be redeemed by + either one or multiple referrers. + name: Referrals paths: /v2/customer_sessions/{customerSessionId}: put: @@ -88,8 +94,8 @@ paths: 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. operationId: updateCustomerSessionV2 parameters: - - description: Indicates whether to skip persisting the changes or not (Will - not persist if set to 'true'). + - description: Indicates whether to persist the changes. Changes are ignored + when `dry=true`. in: query name: dry schema: @@ -187,7 +193,8 @@ paths: default: false type: boolean - description: | - Indicates whether to persist the changes. Changes are persisted with `true`. Only used when `runRuleEngine` is set to `true`. + Indicates whether to persist the changes. Changes are ignored when `dry=true`. + Only used when `runRuleEngine` is set to `true`. in: query name: dry schema: @@ -248,8 +255,8 @@ paths: [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons operationId: updateCustomerProfile parameters: - - description: Indicates whether to skip persisting the changes or not (Will - not persist if set to 'true'). + - description: Indicates whether to persist the changes. Changes are ignored + when `dry=true`. in: query name: dry schema: @@ -308,8 +315,8 @@ paths: 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. operationId: updateCustomerSession parameters: - - description: Indicates whether to skip persisting the changes or not (Will - not persist if set to 'true'). + - description: Indicates whether to persist the changes. Changes are ignored + when `dry=true`. in: query name: dry schema: @@ -353,8 +360,8 @@ paths: Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. operationId: trackEvent parameters: - - description: Indicates whether to skip persisting the changes or not (Will - not persist if set to 'true'). + - description: Indicates whether to persist the changes. Changes are ignored + when `dry=true`. in: query name: dry schema: @@ -404,6 +411,41 @@ paths: tags: - integration x-codegen-request-body-name: body + v1/referrals_for_multiple_advocates: + post: + description: | + Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. + operationId: createReferralsForMultipleAdvocates + parameters: + - description: If set to `yes`, response will be an empty 204, otherwise a list + of integration states will be generated (up to 1000). + in: query + name: silent + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NewReferralsForMultipleAdvocates' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_201' + description: Created + "204": + content: {} + description: No Content + security: + - api_key_v1: [] + - integration_auth: [] + summary: Create referral codes for multiple advocates + tags: + - integration + x-codegen-request-body-name: body /v1/customer_data/{integrationId}: delete: description: | @@ -551,6 +593,12 @@ paths: name: loyalty schema: type: boolean + - description: optional flag to decide if you would like giveaways information + in the response + in: query + name: giveaways + schema: + type: boolean responses: "200": content: @@ -1061,8 +1109,8 @@ paths: description: Create coupons according to some pattern for up to 1000 recipients. operationId: createCouponsForMultipleRecipients parameters: - - description: If set to 'yes', response will be an empty 204, otherwise a list - of the coupons generated (to to 1000). + - description: If set to `yes`, response will be an empty 204, otherwise a list + of integration states will be generated (up to 1000). in: query name: silent schema: @@ -1364,8 +1412,8 @@ paths: up to 200.000 coupons can be created. operationId: createCoupons parameters: - - description: If set to 'yes', response will be an empty 204, otherwise a list - of the coupons generated (to to 1000). + - description: If set to `yes`, response will be an empty 204, otherwise a list + of integration states will be generated (up to 1000). in: query name: silent schema: @@ -2430,7 +2478,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_6' + $ref: '#/components/schemas/inline_response_201' description: OK summary: List Referrals (with total count) tags: @@ -2462,6 +2510,42 @@ paths: summary: Delete one Referral tags: - management + put: + operationId: updateReferral + parameters: + - in: path + name: applicationId + required: true + schema: + type: integer + - in: path + name: campaignId + required: true + schema: + type: integer + - description: The ID of the referral code to delete + in: path + name: referralId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReferral' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Referral' + description: OK + summary: Update one Referral + tags: + - management + x-codegen-request-body-name: body /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total: get: operationId: getReferralsWithoutTotalCount @@ -2548,7 +2632,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_7' + $ref: '#/components/schemas/inline_response_200_6' description: OK summary: List Referrals tags: @@ -2561,7 +2645,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_8' + $ref: '#/components/schemas/inline_response_200_7' description: OK summary: List all loyalty Programs tags: @@ -2574,7 +2658,7 @@ paths: name: programID required: true schema: - type: string + type: integer responses: "200": content: @@ -2585,6 +2669,37 @@ paths: summary: Get a loyalty program tags: - management + /v1/loyalty_programs/{programID}/import_points: + post: + description: Upload a CSV file containing the loyalty points that should be + created. The file should be sent as multipart data. + operationId: importLoyaltyPoints + parameters: + - in: path + name: programID + required: true + schema: + type: integer + requestBody: + content: + multipart/form-data: + schema: + properties: + upFile: + description: The file with the information about the data that should + be imported. + format: csv + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Import' + description: OK + summary: Import loyalty points via CSV file + tags: + - management /v1/loyalty_programs/{programID}/profile/{integrationID}: get: description: Get the Loyalty Ledger for this profile integration ID. @@ -2761,6 +2876,47 @@ paths: summary: Export customer loyalty balance to a CSV file tags: - management + /v1/giveaways/pools/{poolId}/import: + post: + description: | + Upload a CSV file containing the giveaways codes that should be created. Send the file as multipart data. + + The CSV file can contain the following columns: + - `code` (required): the code of your giveaway, for instance, a gift card redemption code. + - `startdate`: the start date in RFC3339 of the code redemption period. + - `enddate`: the last date in RFC3339 of the code redemption period. + - `attributes`: A json object describing _custom_ giveaways attribute names and their values. Double the double-quotes in the object. + For example, if you created a custom attribute called `provider`, set it with `"{""provider"": ""myPartnerCompany""}"`. + + The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. + You can use the timezone of your choice. It is converted to UTC internally by Talon.One. + operationId: importPoolGiveaways + parameters: + - in: path + name: poolId + required: true + schema: + type: integer + requestBody: + content: + multipart/form-data: + schema: + properties: + upFile: + description: The file with the information about the data that should + be imported. + format: csv + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Import' + description: OK + summary: Import giveaways codes into a giveaways pool + tags: + - management /v1/applications/{applicationId}/health_report: get: operationId: getApplicationApiHealth @@ -2855,7 +3011,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_9' + $ref: '#/components/schemas/inline_response_200_8' description: OK summary: Get access logs for application (with total count) tags: @@ -2935,7 +3091,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_10' + $ref: '#/components/schemas/inline_response_200_9' description: OK summary: Get access logs for application tags: @@ -3012,7 +3168,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_9' + $ref: '#/components/schemas/inline_response_200_8' description: OK summary: Get all access logs tags: @@ -3063,7 +3219,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_11' + $ref: '#/components/schemas/inline_response_200_10' description: OK summary: Get analytics of campaigns tags: @@ -3097,8 +3253,8 @@ paths: 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. + With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. + With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. in: query name: withTotalResultSize schema: @@ -3108,7 +3264,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_12' + $ref: '#/components/schemas/inline_response_200_11' description: OK summary: List Application Customers tags: @@ -3146,7 +3302,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_13' + $ref: '#/components/schemas/inline_response_200_12' description: OK summary: Get a list of the customer profiles that match the given attributes tags: @@ -3192,7 +3348,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_13' + $ref: '#/components/schemas/inline_response_200_12' description: OK summary: List Customer Profiles tags: @@ -3218,7 +3374,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_13' + $ref: '#/components/schemas/inline_response_200_12' description: OK security: - integration_auth: [] @@ -3322,7 +3478,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_14' + $ref: '#/components/schemas/inline_response_200_13' description: OK summary: Get Activity Reports for Application Customers (with total count) tags: @@ -3399,7 +3555,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_15' + $ref: '#/components/schemas/inline_response_200_14' description: OK summary: Get Activity Reports for Application Customers tags: @@ -3578,7 +3734,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_16' + $ref: '#/components/schemas/inline_response_200_15' description: OK summary: List Application Sessions tags: @@ -3705,7 +3861,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_17' + $ref: '#/components/schemas/inline_response_200_16' description: OK summary: List Applications Events (with total count) tags: @@ -3808,7 +3964,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_18' + $ref: '#/components/schemas/inline_response_200_17' description: OK summary: List Applications Events tags: @@ -3850,7 +4006,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_19' + $ref: '#/components/schemas/inline_response_200_18' description: OK summary: List Applications Event Types tags: @@ -3882,8 +4038,8 @@ paths: type: string - description: | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. - With this flag set to true, hasMore will be 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. + With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. + With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. in: query name: withTotalResultSize schema: @@ -3893,7 +4049,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_20' + $ref: '#/components/schemas/inline_response_200_19' description: OK summary: Get all audiences tags: @@ -3923,12 +4079,17 @@ paths: name: sort schema: type: string + - description: Returned attributes will be filtered by supplied entity + in: query + name: entity + schema: + type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_21' + $ref: '#/components/schemas/inline_response_200_20' description: OK summary: List custom attributes tags: @@ -4036,7 +4197,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_22' + $ref: '#/components/schemas/inline_response_200_21' description: OK summary: List additional costs tags: @@ -4145,7 +4306,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_23' + $ref: '#/components/schemas/inline_response_200_22' description: OK summary: List Webhooks tags: @@ -4234,7 +4395,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_24' + $ref: '#/components/schemas/inline_response_200_23' description: OK summary: List Webhook activation Log Entries tags: @@ -4310,7 +4471,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_25' + $ref: '#/components/schemas/inline_response_200_24' description: OK summary: List Webhook Log Entries tags: @@ -4362,11 +4523,47 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_26' + $ref: '#/components/schemas/inline_response_200_25' description: OK summary: List Event Types tags: - management + /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons: + post: + description: Upload a CSV file containing the coupons that should be created. + The file should be sent as multipart data. + operationId: importCoupons + parameters: + - in: path + name: applicationId + required: true + schema: + type: integer + - in: path + name: campaignId + required: true + schema: + type: integer + requestBody: + content: + multipart/form-data: + schema: + properties: + upFile: + description: The file with the information about the data that should + be imported. + format: csv + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Import' + description: OK + summary: Import coupons via CSV file + tags: + - management /v1/applications/{applicationId}/export_coupons: get: description: Download a file with the coupons that match the given attributes. @@ -4597,6 +4794,55 @@ paths: summary: Export Customer Sessions to a CSV file tags: - management + /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals: + post: + description: | + Upload a CSV file containing the referrals that should be created. + The file should be sent as multipart data. + + The CSV file can contain the following colums: + + - `code` (required): the referral code. + - `advocateprofileintegrationid` (required): The profile ID of the advocate. + - `startdate`: the start date in RFC3339 of the code redemption period. + - `expirydate`: the end date in RFC3339 of the code redemption period. + - `limitval`: The maximum amount of redemptions of this code. Unlimited (0) when blank. + - `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. + For example, if you created a custom attribute called `category`, set it with `"{""category"": ""10_off""}"`. + + You can use the timezone of your choice. It is converted to UTC internally by Talon.One. + operationId: importReferrals + parameters: + - in: path + name: applicationId + required: true + schema: + type: integer + - in: path + name: campaignId + required: true + schema: + type: integer + requestBody: + content: + multipart/form-data: + schema: + properties: + upFile: + description: The file with the information about the data that should + be imported. + format: csv + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Import' + description: OK + summary: Import referrals via CSV file + tags: + - management /v1/users: get: description: | @@ -4627,7 +4873,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_27' + $ref: '#/components/schemas/inline_response_200_26' description: OK summary: List Users in your account tags: @@ -4710,8 +4956,8 @@ paths: type: string - description: | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. - With this flag set to true, hasMore will be 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. + With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. + With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. in: query name: withTotalResultSize schema: @@ -4727,7 +4973,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_28' + $ref: '#/components/schemas/inline_response_200_27' description: OK summary: Get audit log for an account tags: @@ -4882,13 +5128,15 @@ paths: - Coupon - Effect - CustomerSession + - LoyaltyLedger + - LoyaltyLedgerLog type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_29' + $ref: '#/components/schemas/inline_response_200_28' description: OK summary: Get Exports tags: @@ -4901,7 +5149,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_30' + $ref: '#/components/schemas/inline_response_200_29' description: OK summary: Get all roles tags: @@ -5092,6 +5340,14 @@ components: required: - applicationId type: object + LoyaltyProgramEntity: + properties: + programID: + description: The ID of the loyalty program that owns this entity. + type: integer + required: + - programID + type: object CampaignGroupEntity: properties: campaignGroups: @@ -5471,6 +5727,17 @@ components: - accountID: 5 defaultValidity: defaultValidity defaultPending: defaultPending + tiers: + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 allowSubledger: true name: name description: description @@ -5482,6 +5749,17 @@ components: - accountID: 5 defaultValidity: defaultValidity defaultPending: defaultPending + tiers: + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 allowSubledger: true name: name description: description @@ -5501,12 +5779,12 @@ components: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action properties: id: @@ -5737,12 +6015,12 @@ components: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action properties: name: @@ -5793,6 +6071,7 @@ components: - coupons - referrals - loyalty + - giveaways type: string maxItems: 3 minItems: 0 @@ -5854,12 +6133,12 @@ components: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action properties: name: @@ -5910,6 +6189,7 @@ components: - coupons - referrals - loyalty + - giveaways type: string maxItems: 3 minItems: 0 @@ -5937,53 +6217,54 @@ components: Campaign: description: "" example: - createdLoyaltyPointsEffectCount: 5 - discountCount: 9.132027271330688 + createdLoyaltyPointsEffectCount: 6 + discountCount: 0.8774076871421566 description: description features: - coupons - coupons - coupons - createdLoyaltyPointsCount: 7.933506881737151 + createdLoyaltyPointsCount: 4.86315908102884 couponSettings: couponPattern: couponPattern validCharacters: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 3 + id: 4 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - activeRulesetId: 6 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 0 - couponRedemptionCount: 4 - userId: 0 - couponCreationCount: 9 + referralCreationCount: 7 + couponRedemptionCount: 7 + userId: 6 + couponCreationCount: 0 campaignGroups: - - 1 - - 1 + - 4 + - 4 tags: - tags - tags - tags - tags - tags - redeemedLoyaltyPointsEffectCount: 6 - discountEffectCount: 0 + awardedGiveawaysCount: 5 + redeemedLoyaltyPointsEffectCount: 4 + discountEffectCount: 9 createdBy: createdBy - redeemedLoyaltyPointsCount: 4.86315908102884 + redeemedLoyaltyPointsCount: 8.251625748923757 name: name referralSettings: couponPattern: couponPattern @@ -5993,8 +6274,8 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 4 - referralRedemptionCount: 7 + applicationId: 0 + referralRedemptionCount: 9 updated: 2000-01-23T04:56:07.000+00:00 properties: id: @@ -6058,6 +6339,7 @@ components: - coupons - referrals - loyalty + - giveaways type: string maxItems: 3 minItems: 0 @@ -6094,6 +6376,9 @@ components: referralCreationCount: description: Total number of referrals created by rules in this campaign. type: integer + awardedGiveawaysCount: + description: Total number of giveaways awarded by rules in this campaign. + type: integer createdLoyaltyPointsCount: description: Total number of loyalty points created by rules in this campaign. type: number @@ -6409,7 +6694,7 @@ components: entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action properties: action: @@ -6525,27 +6810,38 @@ components: - set - version type: object - NewReferral: - example: - expiryDate: 2000-01-23T04:56:07.000+00:00 - friendProfileIntegrationId: friendProfileIntegrationId - campaignId: 0 - advocateProfileIntegrationId: advocateProfileIntegrationId - startDate: 2000-01-23T04:56:07.000+00:00 + ReferralConstraints: properties: - campaignId: - description: ID of the campaign from which the referral received the referral - code. - title: Referral's Campaign ID - type: integer - advocateProfileIntegrationId: - description: The Integration Id of the Advocate's Profile - title: Advocate's Profile id - type: string - friendProfileIntegrationId: - description: An optional Integration ID of the Friend's Profile - title: Friend's Profile ID + startDate: + description: Timestamp at which point the referral code becomes valid. + format: date-time + title: Referral code valid from + type: string + expiryDate: + description: Expiry date of the referral code. Referral never expires if + this is omitted, zero, or negative. + format: date-time + title: Referral code valid until type: string + usageLimit: + description: | + The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + maximum: 999999 + minimum: 0 + title: Referral code Usage Limit + type: integer + type: object + NewReferral: + description: "" + example: + expiryDate: 2000-01-23T04:56:07.000+00:00 + friendProfileIntegrationId: friendProfileIntegrationId + usageLimit: 80082 + campaignId: 6 + attributes: '{}' + startDate: 2000-01-23T04:56:07.000+00:00 + advocateProfileIntegrationId: advocateProfileIntegrationId + properties: startDate: description: Timestamp at which point the referral code becomes valid. format: date-time @@ -6557,22 +6853,55 @@ components: format: date-time title: Referral code valid until type: string + usageLimit: + description: | + The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + maximum: 999999 + minimum: 0 + title: Referral code Usage Limit + type: integer + campaignId: + description: ID of the campaign from which the referral received the referral + code. + title: Referral's Campaign ID + type: integer + advocateProfileIntegrationId: + description: The Integration ID of the Advocate's Profile. + title: Advocate's Profile ID + type: string + friendProfileIntegrationId: + description: An optional Integration ID of the Friend's Profile + title: Friend's Profile ID + type: string + attributes: + description: Arbitrary properties associated with this item. + properties: {} + type: object required: - advocateProfileIntegrationId - campaignId type: object + ImportEntity: + properties: + importId: + description: The ID of the Import which created this referral. + type: integer + type: object Referral: description: "" example: - expiryDate: 2000-01-23T04:56:07.000+00:00 code: code - friendProfileIntegrationId: friendProfileIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 7 - usageLimit: 0 - id: 3 - usageCounter: 0 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 + friendProfileIntegrationId: friendProfileIntegrationId + attributes: '{}' + id: 3 startDate: 2000-01-23T04:56:07.000+00:00 properties: id: @@ -6582,15 +6911,75 @@ components: description: The exact moment this entity was created. format: date-time type: string + startDate: + description: Timestamp at which point the referral code becomes valid. + format: date-time + title: Referral code valid from + type: string + expiryDate: + description: Expiry date of the referral code. Referral never expires if + this is omitted, zero, or negative. + format: date-time + title: Referral code valid until + type: string + usageLimit: + description: | + The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + maximum: 999999 + minimum: 0 + title: Referral code Usage Limit + type: integer campaignId: description: ID of the campaign from which the referral received the referral code. title: Referral's Campaign ID type: integer advocateProfileIntegrationId: - description: The Integration Id of the Advocate's Profile - title: Advocate's Profile id + description: The Integration ID of the Advocate's Profile. + title: Advocate's Profile ID + type: string + friendProfileIntegrationId: + description: An optional Integration ID of the Friend's Profile + title: Friend's Profile ID + type: string + attributes: + description: Arbitrary properties associated with this item. + properties: {} + type: object + importId: + description: The ID of the Import which created this referral. + type: integer + code: + description: The actual referral code. + minLength: 4 + title: Referral code + type: string + usageCounter: + description: The number of times this referral code has been successfully + used. + title: Referral code Usages + type: integer + batchId: + description: The ID of the batch the referrals belong to. + title: Batch ID type: string + required: + - advocateProfileIntegrationId + - campaignId + - code + - created + - id + - usageCounter + - usageLimit + type: object + UpdateReferral: + example: + expiryDate: 2000-01-23T04:56:07.000+00:00 + friendProfileIntegrationId: friendProfileIntegrationId + usageLimit: 80082 + attributes: '{}' + startDate: 2000-01-23T04:56:07.000+00:00 + properties: friendProfileIntegrationId: description: An optional Integration ID of the Friend's Profile title: Friend's Profile ID @@ -6606,29 +6995,87 @@ components: format: date-time title: Referral code valid until type: string - code: - description: The actual referral code. - minLength: 4 - title: Referral code - type: string - usageCounter: - description: The number of times this referral code has been successfully - used. - title: Referral code Usages + usageLimit: + description: | + The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + maximum: 999999 + minimum: 0 + title: Referral code Usage Limit type: integer + attributes: + description: Arbitrary properties associated with this item + properties: {} + type: object + type: object + NewReferralsForMultipleAdvocates: + description: "" + example: + expiryDate: 2000-01-23T04:56:07.000+00:00 + advocateProfileIntegrationIds: + - advocateProfileIntegrationIds + - advocateProfileIntegrationIds + - advocateProfileIntegrationIds + - advocateProfileIntegrationIds + - advocateProfileIntegrationIds + validCharacters: + - validCharacters + - validCharacters + usageLimit: 80082 + campaignId: 6 + referralPattern: referralPattern + attributes: '{}' + startDate: 2000-01-23T04:56:07.000+00:00 + properties: + startDate: + description: Timestamp at which point the referral code becomes valid. + format: date-time + title: Referral code valid from + type: string + expiryDate: + description: Expiry date of the referral code. Referral never expires if + this is omitted, zero, or negative. + format: date-time + title: Referral code valid until + type: string usageLimit: description: | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + maximum: 999999 minimum: 0 title: Referral code Usage Limit type: integer + campaignId: + description: The ID of the campaign from which the referral received the + referral code. + title: Referral's Campaign ID + type: integer + advocateProfileIntegrationIds: + description: An array containing all the respective advocate profiles. + items: + type: string + maxItems: 1000 + minItems: 1 + title: Advocate Profile List + type: array + attributes: + description: Arbitrary properties associated with this item. + properties: {} + type: object + validCharacters: + description: Set of characters to be used when generating random part of + code. Defaults to [A-Z, 0-9] (in terms of RegExp). + items: + type: string + type: array + referralPattern: + description: | + The pattern that will be used to generate referrals. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. + maxLength: 100 + minLength: 3 + type: string required: - - advocateProfileIntegrationId + - advocateProfileIntegrationIds - campaignId - - code - - created - - id - - usageCounter - usageLimit type: object AttributeQuery: @@ -6930,21 +7377,21 @@ components: example: recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 properties: id: description: Unique ID for this entity. @@ -7017,8 +7464,8 @@ components: type: integer reservation: description: This value controls what reservations mean to a coupon. If - set to true the coupon reservation is used to mark it as a favourite, - if set to false the coupon reservation is used as a requirement of usage. + set to true the coupon reservation is used to mark it as a favorite, if + set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. title: Reservation Status type: boolean @@ -7034,58 +7481,184 @@ components: - usageLimit - value type: object - CampaignAnalytics: + InventoryCoupon: description: "" example: - date: 2000-01-23T04:56:07.000+00:00 - couponRolledbackRedemptions: 1 - totalCouponRolledbackRedemptions: 1 - campaignRefundedDiscounts: 9.301444243932576 - totalDeductedLoyaltyPoints: 9.018348186070783 - couponRedemptions: 7 - totalCampaignDiscountCosts: 7.061401241503109 - referralRedemptions: 6 - totalCampaignRevenue: 1.4658129805029452 - campaignRevenue: 6.027456183070403 - campaignDiscountCosts: 2.3021358869347655 - totalReferralRedemptions: 7 - couponsCreated: 1 - addedLoyaltyPoints: 9.369310271410669 - campaignRefund: 5.962133916683182 - campaignFreeItems: 2 - totalAddedLoyaltyPoints: 6.683562403749608 - totalCampaignFreeItems: 4 - totalCampaignRefundedDiscounts: 3.616076749251911 - totalCampaignRefund: 5.637376656633329 - totalCouponsCreated: 4 - deductedLoyaltyPoints: 8.762042012749001 - totalCouponRedemptions: 1 - referralsCreated: 5 - totalReferralsCreated: 9 + recipientIntegrationId: recipientIntegrationId + created: 2000-01-23T04:56:07.000+00:00 + campaignId: 6 + usageLimit: 146581 + referralId: 9 + profileRedemptionCount: 2 + usageCounter: 5 + batchId: batchId + discountCounter: 2.3021358869347655 + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 3 + reservation: true + attributes: '{}' + id: 0 + state: state + value: value + discountLimit: 596212.7954549266 + startDate: 2000-01-23T04:56:07.000+00:00 + discountRemainder: 7.061401241503109 properties: - date: + id: + description: Unique ID for this entity. + type: integer + created: + description: The exact moment this entity was created. format: date-time type: string - campaignRevenue: - description: Amount of revenue in this campaign (for coupon or discount - sessions). - type: number - totalCampaignRevenue: - description: Amount of revenue in this campaign since it began (for coupon - or discount sessions). - type: number - campaignRefund: - description: Amount of refunds in this campaign (for coupon or discount - sessions). - type: number - totalCampaignRefund: - description: Amount of refunds in this campaign since it began (for coupon - or discount sessions). - type: number - campaignDiscountCosts: - description: Amount of cost caused by discounts given in the campaign. - type: number - totalCampaignDiscountCosts: + campaignId: + description: The ID of the campaign that owns this entity. + title: Campaign ID + type: integer + value: + description: The actual coupon code. + minLength: 4 + title: Coupon Code + type: string + usageLimit: + description: | + The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + maximum: 999999 + minimum: 0 + type: integer + discountLimit: + description: | + The amount of discounts that can be given with this coupon code. + maximum: 999999 + minimum: 0 + type: number + startDate: + description: Timestamp at which point the coupon becomes valid. + format: date-time + type: string + expiryDate: + description: Expiry date of the coupon. Coupon never expires if this is + omitted, zero, or negative. + format: date-time + type: string + usageCounter: + description: The number of times this coupon has been successfully used. + title: Number of coupon usages + type: integer + discountCounter: + description: The amount of discounts given on rules redeeming this coupon. + Only usable if a coupon discount budget was set for this coupon. + title: Discounts Given + type: number + discountRemainder: + description: The remaining discount this coupon can give. + title: Coupon Discount Remainder + type: number + attributes: + description: Arbitrary properties associated with this item + properties: {} + title: Attributes of coupon + type: object + referralId: + description: The integration ID of the referring customer (if any) for whom + this coupon was created as an effect. + title: Advocate ID + type: integer + recipientIntegrationId: + description: The Integration ID of the customer that is allowed to redeem + this coupon. + title: Recipient ID + type: string + importId: + description: The ID of the Import which created this coupon. + title: Import ID + type: integer + reservation: + description: This value controls what reservations mean to a coupon. If + set to true the coupon reservation is used to mark it as a favorite, if + set to false the coupon reservation is used as a requirement of usage. + This value defaults to true if not specified. + title: Reservation Status + type: boolean + batchId: + description: The id of the batch the coupon belongs to. + title: Batch ID + type: string + profileRedemptionCount: + description: The number of times the coupon was redeemed by the profile. + title: Number of coupon usages + type: integer + state: + description: | + Can be either active, used, expired, or pending. + active: reserved coupons that are neither pending nor used nor expired, and have a non-exhausted limit counter. + used: coupons that are not pending, and have reached their redemption limit or were redeemed by the profile before expiration. + expired: all non-pending, non-active, non-used coupons that were not redeemed by the profile. + pending: coupons that have a start date in the future. + title: State of the coupon + type: string + required: + - campaignId + - created + - id + - profileRedemptionCount + - state + - usageCounter + - usageLimit + - value + type: object + CampaignAnalytics: + description: "" + example: + date: 2000-01-23T04:56:07.000+00:00 + couponRolledbackRedemptions: 1 + totalCouponRolledbackRedemptions: 1 + campaignRefundedDiscounts: 9.301444243932576 + totalDeductedLoyaltyPoints: 9.018348186070783 + couponRedemptions: 7 + totalCampaignDiscountCosts: 7.061401241503109 + referralRedemptions: 6 + totalCampaignRevenue: 1.4658129805029452 + campaignRevenue: 6.027456183070403 + campaignDiscountCosts: 2.3021358869347655 + totalReferralRedemptions: 7 + couponsCreated: 1 + addedLoyaltyPoints: 9.369310271410669 + campaignRefund: 5.962133916683182 + campaignFreeItems: 2 + totalAddedLoyaltyPoints: 6.683562403749608 + totalCampaignFreeItems: 4 + totalCampaignRefundedDiscounts: 3.616076749251911 + totalCampaignRefund: 5.637376656633329 + totalCouponsCreated: 4 + deductedLoyaltyPoints: 8.762042012749001 + totalCouponRedemptions: 1 + referralsCreated: 5 + totalReferralsCreated: 9 + properties: + date: + format: date-time + type: string + campaignRevenue: + description: Amount of revenue in this campaign (for coupon or discount + sessions). + type: number + totalCampaignRevenue: + description: Amount of revenue in this campaign since it began (for coupon + or discount sessions). + type: number + campaignRefund: + description: Amount of refunds in this campaign (for coupon or discount + sessions). + type: number + totalCampaignRefund: + description: Amount of refunds in this campaign since it began (for coupon + or discount sessions). + type: number + campaignDiscountCosts: + description: Amount of cost caused by discounts given in the campaign. + type: number + totalCampaignDiscountCosts: description: Amount of cost caused by discounts given in the campaign since it began. type: number @@ -7542,6 +8115,17 @@ components: accountID: 5 defaultValidity: defaultValidity defaultPending: defaultPending + tiers: + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 allowSubledger: true name: name description: description @@ -7585,6 +8169,11 @@ components: allowSubledger: description: Indicates if this program supports subledgers inside the program type: boolean + tiers: + description: The tiers in this loyalty program + items: + $ref: '#/components/schemas/LoyaltyTier' + type: array required: - accountID - allowSubledger @@ -7596,6 +8185,76 @@ components: - subscribedApplications - title type: object + NewLoyaltyTier: + description: A new loyalty tier + properties: + name: + description: The name of the tier + type: string + minPoints: + description: The minimum amount of points required to be eligible for the + tier + exclusiveMaximum: true + maximum: 1E+8 + minimum: 0 + type: number + required: + - minPoints + - name + type: object + LoyaltyTier: + description: "" + example: + created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 + properties: + id: + description: Unique ID for this entity. + type: integer + created: + description: The exact moment this entity was created. + format: date-time + type: string + programID: + description: The ID of the loyalty program that owns this entity. + type: integer + name: + description: The name of the tier + type: string + minPoints: + description: The minimum amount of points required to be eligible for the + tier + exclusiveMaximum: true + maximum: 1E+8 + minimum: 0 + type: number + required: + - created + - id + - minPoints + - name + - programID + type: object + UpdateLoyaltyTier: + description: "" + properties: + name: + description: The name of the tier + type: string + minPoints: + description: The minimum amount of points required to be eligible for the + tier + exclusiveMaximum: true + maximum: 1E+8 + minimum: 0 + type: number + required: + - minPoints + - name + type: object NewLoyaltyProgram: description: A new loyalty program properties: @@ -8428,58 +9087,68 @@ components: coupons: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 6 + usageLimit: 146581 + referralId: 9 + profileRedemptionCount: 2 + usageCounter: 5 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 + state: state value: value - discountLimit: 896956.9828618114 + discountLimit: 596212.7954549266 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.061401241503109 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 6 + usageLimit: 146581 + referralId: 9 + profileRedemptionCount: 2 + usageCounter: 5 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 2.3021358869347655 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 + state: state value: value - discountLimit: 896956.9828618114 + discountLimit: 596212.7954549266 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.061401241503109 referrals: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - code: code - friendProfileIntegrationId: friendProfileIntegrationId + - code: code created: 2000-01-23T04:56:07.000+00:00 - campaignId: 7 - usageLimit: 0 - id: 3 - usageCounter: 0 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId - startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - code: code + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 friendProfileIntegrationId: friendProfileIntegrationId - created: 2000-01-23T04:56:07.000+00:00 - campaignId: 7 - usageLimit: 0 + attributes: '{}' id: 3 - usageCounter: 0 + startDate: 2000-01-23T04:56:07.000+00:00 + - code: code + created: 2000-01-23T04:56:07.000+00:00 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 + friendProfileIntegrationId: friendProfileIntegrationId + attributes: '{}' + id: 3 startDate: 2000-01-23T04:56:07.000+00:00 profile: accountId: 1 @@ -8518,6 +9187,25 @@ components: name: name id: 2 title: title + giveaways: + - code: code + importId: 0 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2000-01-23T04:56:07.000+00:00 + poolId: 8 + attributes: '{}' + id: 9 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 + - code: code + importId: 0 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2000-01-23T04:56:07.000+00:00 + poolId: 8 + attributes: '{}' + id: 9 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 properties: profile: $ref: '#/components/schemas/CustomerProfile' @@ -8529,7 +9217,11 @@ components: type: array coupons: items: - $ref: '#/components/schemas/Coupon' + $ref: '#/components/schemas/InventoryCoupon' + type: array + giveaways: + items: + $ref: '#/components/schemas/Giveaway' type: array type: object NewCustomerSession: @@ -9360,21 +10052,21 @@ components: coupon: recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 session: coupon: coupon created: 2000-01-23T04:56:07.000+00:00 @@ -9519,79 +10211,83 @@ 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: 4 - ruleIndex: 3 - campaignId: 8 + - rulesetId: 0 + ruleIndex: 2 + campaignId: 3 ruleName: ruleName - triggeredByCoupon: 0 + triggeredByCoupon: 1 effectType: effectType props: '{}' - - rulesetId: 4 - ruleIndex: 3 - campaignId: 8 + - rulesetId: 0 + ruleIndex: 2 + campaignId: 3 ruleName: ruleName - triggeredByCoupon: 0 + triggeredByCoupon: 1 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: 7 - usageLimit: 0 - id: 3 - usageCounter: 0 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 + friendProfileIntegrationId: friendProfileIntegrationId + attributes: '{}' + id: 3 startDate: 2000-01-23T04:56:07.000+00:00 triggeredCampaigns: - - createdLoyaltyPointsEffectCount: 5 - discountCount: 9.132027271330688 + - createdLoyaltyPointsEffectCount: 6 + discountCount: 0.8774076871421566 description: description features: - coupons - coupons - coupons - createdLoyaltyPointsCount: 7.933506881737151 + createdLoyaltyPointsCount: 4.86315908102884 couponSettings: couponPattern: couponPattern validCharacters: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 3 + id: 4 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - activeRulesetId: 6 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 0 - couponRedemptionCount: 4 - userId: 0 - couponCreationCount: 9 + referralCreationCount: 7 + couponRedemptionCount: 7 + userId: 6 + couponCreationCount: 0 campaignGroups: - - 1 - - 1 + - 4 + - 4 tags: - tags - tags - tags - tags - tags - redeemedLoyaltyPointsEffectCount: 6 - discountEffectCount: 0 + awardedGiveawaysCount: 5 + redeemedLoyaltyPointsEffectCount: 4 + discountEffectCount: 9 createdBy: createdBy - redeemedLoyaltyPointsCount: 4.86315908102884 + redeemedLoyaltyPointsCount: 8.251625748923757 name: name referralSettings: couponPattern: couponPattern @@ -9601,56 +10297,57 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 4 - referralRedemptionCount: 7 + applicationId: 0 + referralRedemptionCount: 9 updated: 2000-01-23T04:56:07.000+00:00 - - createdLoyaltyPointsEffectCount: 5 - discountCount: 9.132027271330688 + - createdLoyaltyPointsEffectCount: 6 + discountCount: 0.8774076871421566 description: description features: - coupons - coupons - coupons - createdLoyaltyPointsCount: 7.933506881737151 + createdLoyaltyPointsCount: 4.86315908102884 couponSettings: couponPattern: couponPattern validCharacters: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 3 + id: 4 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - activeRulesetId: 6 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 0 - couponRedemptionCount: 4 - userId: 0 - couponCreationCount: 9 + referralCreationCount: 7 + couponRedemptionCount: 7 + userId: 6 + couponCreationCount: 0 campaignGroups: - - 1 - - 1 + - 4 + - 4 tags: - tags - tags - tags - tags - tags - redeemedLoyaltyPointsEffectCount: 6 - discountEffectCount: 0 + awardedGiveawaysCount: 5 + redeemedLoyaltyPointsEffectCount: 4 + discountEffectCount: 9 createdBy: createdBy - redeemedLoyaltyPointsCount: 4.86315908102884 + redeemedLoyaltyPointsCount: 8.251625748923757 name: name referralSettings: couponPattern: couponPattern @@ -9660,44 +10357,44 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 4 - referralRedemptionCount: 7 + applicationId: 0 + referralRedemptionCount: 9 updated: 2000-01-23T04:56:07.000+00:00 coupons: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 customerProfile: accountId: 1 closedSessions: 1 @@ -9782,6 +10479,25 @@ components: name: name id: 2 title: title + awardedGiveaways: + - code: code + importId: 0 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2000-01-23T04:56:07.000+00:00 + poolId: 8 + attributes: '{}' + id: 9 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 + - code: code + importId: 0 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2000-01-23T04:56:07.000+00:00 + poolId: 8 + attributes: '{}' + id: 9 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 event: effects: - '{}' @@ -9829,83 +10545,89 @@ components: createdCoupons: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 ruleFailureReasons: - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue createdReferrals: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - code: code - friendProfileIntegrationId: friendProfileIntegrationId + - code: code created: 2000-01-23T04:56:07.000+00:00 - campaignId: 7 - usageLimit: 0 - id: 3 - usageCounter: 0 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId - startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - code: code + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 friendProfileIntegrationId: friendProfileIntegrationId - created: 2000-01-23T04:56:07.000+00:00 - campaignId: 7 - usageLimit: 0 + attributes: '{}' id: 3 - usageCounter: 0 + startDate: 2000-01-23T04:56:07.000+00:00 + - code: code + created: 2000-01-23T04:56:07.000+00:00 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 + friendProfileIntegrationId: friendProfileIntegrationId + attributes: '{}' + id: 3 startDate: 2000-01-23T04:56:07.000+00:00 properties: customerSession: @@ -9942,6 +10664,10 @@ components: items: $ref: '#/components/schemas/Referral' type: array + awardedGiveaways: + items: + $ref: '#/components/schemas/Giveaway' + type: array required: - createdCoupons - createdReferrals @@ -10027,6 +10753,39 @@ components: - lastActivity - totalSales type: object + ApplicationReferee: + description: "" + properties: + applicationId: + description: The ID of the application that owns this entity. + type: integer + sessionId: + description: Integration ID of the session in which the customer redeemed + the referral + type: string + advocateIntegrationId: + description: Integration ID of the Advocate's Profile + title: Advocate's Profile ID + type: string + friendIntegrationId: + description: Integration ID of the Friend's Profile + title: Friend's Profile ID + type: string + code: + description: Advocate's referral code. + type: string + created: + description: Timestamp of the moment the customer redeemed the referral + format: date-time + type: string + required: + - advocateIntegrationId + - applicationId + - code + - created + - friendIntegrationId + - sessionId + type: object ApplicationSession: description: "" example: @@ -10148,27 +10907,27 @@ components: applicationId: 1 type: type ruleFailureReasons: - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue @@ -10648,6 +11407,32 @@ components: items: $ref: '#/components/schemas/TemplateDef' type: array + giveawaysPools: + description: The giveaways pools that the application is subscribed to. + items: + $ref: '#/components/schemas/GiveawaysPool' + type: array + loyaltyPrograms: + description: The loyalty programs that the application is subscribed to. + items: + $ref: '#/components/schemas/LoyaltyProgram' + type: array + attributes: + description: The attributes that the application is subscribed to. + items: + $ref: '#/components/schemas/Attribute' + type: array + additionalCosts: + description: The additional costs that the application is subscribed to. + items: + $ref: '#/components/schemas/AccountAdditionalCost' + type: array + audiences: + description: The audiences contained in the account which the application + belongs to. + items: + $ref: '#/components/schemas/Audience' + type: array variables: type: string required: @@ -10901,6 +11686,8 @@ components: - CartItem - Coupon - Event + - Giveaway + - Referral type: string eventType: type: string @@ -11004,6 +11791,8 @@ components: - CartItem - Coupon - Event + - Giveaway + - Referral type: string eventType: type: string @@ -11555,6 +12344,8 @@ components: - Coupon - Effect - CustomerSession + - LoyaltyLedger + - LoyaltyLedgerLog type: string filter: description: Map of keys and values that were used to filter the exported @@ -11571,6 +12362,13 @@ components: type: object Import: description: "" + example: + accountId: 6 + amount: 0 + created: 2000-01-23T04:56:07.000+00:00 + id: 0 + userId: 1 + entity: entity properties: id: description: Unique ID for this entity. @@ -11671,21 +12469,31 @@ components: Role: description: "" example: - accountID: 1 + accountId: 1 + created: 2000-01-23T04:56:07.000+00:00 campaignGroupID: 5 members: - 5 - 5 name: name + modified: 2000-01-23T04:56:07.000+00:00 description: description id: 6 acl: '{}' properties: id: - description: The ID of the role corresponding to the DB row + description: Unique ID for this entity. type: integer - accountID: - description: The ID of the Talon.One account that owns this role. + 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 campaignGroupID: description: The ID of the Campaign Group this role was created for. @@ -11706,8 +12514,12 @@ components: properties: {} type: object required: - - accountID + - accountId + - acl + - created - id + - modified + - name type: object NewRole: description: "" @@ -11722,7 +12534,7 @@ components: description: Role Policy this should be a stringified blob of json type: string users: - description: An array of userIDs + description: An array of user identifiers items: type: integer type: array @@ -11743,7 +12555,7 @@ components: description: Role Policy this should be a stringified blob of json type: string users: - description: an array of user identifiers + description: An array of user identifiers items: type: integer type: array @@ -12269,11 +13081,11 @@ components: Effect: description: "" example: - rulesetId: 4 - ruleIndex: 3 - campaignId: 8 + rulesetId: 0 + ruleIndex: 2 + campaignId: 3 ruleName: ruleName - triggeredByCoupon: 0 + triggeredByCoupon: 1 effectType: effectType props: '{}' properties: @@ -12764,6 +13576,54 @@ components: - description - itemsIndices type: object + AwardGiveawayEffectProps: + description: The properties specific to the "awardGiveaway" effect. This effect + contains information on the giveaway item, and which profile it was awarded + to. + properties: + poolId: + description: The ID of the giveaways pool the code was taken from. + type: integer + poolName: + description: The name of the giveaways pool the code was taken from. + type: string + recipientIntegrationId: + description: The integration ID of the profile that was awarded the giveaway. + type: string + giveawayId: + description: The internal ID for the giveaway that was awarded. + type: integer + code: + description: The giveaway code that was awarded. + type: string + required: + - code + - giveawayId + - poolId + - poolName + - recipientIntegrationId + type: object + WillAwardGiveawayEffectProps: + description: The properties specific to the "awardGiveaway" effect when the + session is not closed yet. This effect replaces "awardGiveaway" only when + updating a session with any state other than "closed". This is to ensure no + giveaway codes are leaked when they are still not guaranteed to be awarded. + properties: + poolId: + description: The ID of the giveaways pool the code will be taken from. + type: integer + poolName: + description: The name of the giveaways pool the code will be taken from. + type: string + recipientIntegrationId: + description: The integration ID of the profile that will be awarded the + giveaway. + type: string + required: + - poolId + - poolName + - recipientIntegrationId + type: object ErrorEffectProps: description: Whenever an error occurred during evaluation, we return an error effect. This should never happen for rules created in the rule builder. @@ -12774,6 +13634,21 @@ components: required: - message type: object + CustomEffectProps: + description: Effect containing custom payload. + properties: + type: + description: The type of the custom effect. + type: string + payload: + description: The JSON payload of the custom effect. + properties: {} + type: object + x-arbitraryJSON: true + required: + - payload + - type + type: object IntegrationRequest: description: The body of a V2 integration API request (customer session update). Next to the customer session details, this contains an optional listing of @@ -12827,7 +13702,7 @@ components: $ref: '#/components/schemas/NewCustomerSessionV2' responseContent: description: | - Optional list of requested information to be present on the response related to the customer session update. Currently supported: "customerSession", "customerProfile", "coupons", "triggeredCampaigns", "referral", "loyalty", "event" and "ruleFailureReasons". + Optional list of requested information to be present on the response related to the customer session update. Currently supported: "customerSession", "customerProfile", "coupons", "triggeredCampaigns", "referral", "loyalty", "event", "awardedGiveaways" and "ruleFailureReasons". items: enum: - customerSession @@ -12837,6 +13712,7 @@ components: - referral - loyalty - event + - awardedGiveaways - ruleFailureReasons type: string type: array @@ -12866,13 +13742,14 @@ components: $ref: '#/components/schemas/ProfileAudiencesChanges' responseContent: description: | - Optional list of requested information to be present on the response related to the customer profile update. Currently supported: "customerProfile", "triggeredCampaigns", "loyalty", "event" and "ruleFailureReasons". + Optional list of requested information to be present on the response related to the customer profile update. Currently supported: "customerProfile", "triggeredCampaigns", "loyalty", "event", "awardedGiveaways", "ruleFailureReasons". items: enum: - customerProfile - triggeredCampaigns - loyalty - event + - awardedGiveaways - ruleFailureReasons type: string type: array @@ -12953,79 +13830,83 @@ components: example: integrationStates: - effects: - - rulesetId: 4 - ruleIndex: 3 - campaignId: 8 + - rulesetId: 0 + ruleIndex: 2 + campaignId: 3 ruleName: ruleName - triggeredByCoupon: 0 + triggeredByCoupon: 1 effectType: effectType props: '{}' - - rulesetId: 4 - ruleIndex: 3 - campaignId: 8 + - rulesetId: 0 + ruleIndex: 2 + campaignId: 3 ruleName: ruleName - triggeredByCoupon: 0 + triggeredByCoupon: 1 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: 7 - usageLimit: 0 - id: 3 - usageCounter: 0 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 + friendProfileIntegrationId: friendProfileIntegrationId + attributes: '{}' + id: 3 startDate: 2000-01-23T04:56:07.000+00:00 triggeredCampaigns: - - createdLoyaltyPointsEffectCount: 5 - discountCount: 9.132027271330688 + - createdLoyaltyPointsEffectCount: 6 + discountCount: 0.8774076871421566 description: description features: - coupons - coupons - coupons - createdLoyaltyPointsCount: 7.933506881737151 + createdLoyaltyPointsCount: 4.86315908102884 couponSettings: couponPattern: couponPattern validCharacters: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 3 + id: 4 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - activeRulesetId: 6 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 0 - couponRedemptionCount: 4 - userId: 0 - couponCreationCount: 9 + referralCreationCount: 7 + couponRedemptionCount: 7 + userId: 6 + couponCreationCount: 0 campaignGroups: - - 1 - - 1 + - 4 + - 4 tags: - tags - tags - tags - tags - tags - redeemedLoyaltyPointsEffectCount: 6 - discountEffectCount: 0 + awardedGiveawaysCount: 5 + redeemedLoyaltyPointsEffectCount: 4 + discountEffectCount: 9 createdBy: createdBy - redeemedLoyaltyPointsCount: 4.86315908102884 + redeemedLoyaltyPointsCount: 8.251625748923757 name: name referralSettings: couponPattern: couponPattern @@ -13035,56 +13916,57 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 4 - referralRedemptionCount: 7 + applicationId: 0 + referralRedemptionCount: 9 updated: 2000-01-23T04:56:07.000+00:00 - - createdLoyaltyPointsEffectCount: 5 - discountCount: 9.132027271330688 + - createdLoyaltyPointsEffectCount: 6 + discountCount: 0.8774076871421566 description: description features: - coupons - coupons - coupons - createdLoyaltyPointsCount: 7.933506881737151 + createdLoyaltyPointsCount: 4.86315908102884 couponSettings: couponPattern: couponPattern validCharacters: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 3 + id: 4 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - activeRulesetId: 6 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 0 - couponRedemptionCount: 4 - userId: 0 - couponCreationCount: 9 + referralCreationCount: 7 + couponRedemptionCount: 7 + userId: 6 + couponCreationCount: 0 campaignGroups: - - 1 - - 1 + - 4 + - 4 tags: - tags - tags - tags - tags - tags - redeemedLoyaltyPointsEffectCount: 6 - discountEffectCount: 0 + awardedGiveawaysCount: 5 + redeemedLoyaltyPointsEffectCount: 4 + discountEffectCount: 9 createdBy: createdBy - redeemedLoyaltyPointsCount: 4.86315908102884 + redeemedLoyaltyPointsCount: 8.251625748923757 name: name referralSettings: couponPattern: couponPattern @@ -13094,44 +13976,44 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 4 - referralRedemptionCount: 7 + applicationId: 0 + referralRedemptionCount: 9 updated: 2000-01-23T04:56:07.000+00:00 coupons: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 customerProfile: accountId: 1 closedSessions: 1 @@ -13216,6 +14098,25 @@ components: name: name id: 2 title: title + awardedGiveaways: + - code: code + importId: 0 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2000-01-23T04:56:07.000+00:00 + poolId: 8 + attributes: '{}' + id: 9 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 + - code: code + importId: 0 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2000-01-23T04:56:07.000+00:00 + poolId: 8 + attributes: '{}' + id: 9 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 event: effects: - '{}' @@ -13263,158 +14164,168 @@ components: createdCoupons: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 ruleFailureReasons: - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue createdReferrals: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - code: code - friendProfileIntegrationId: friendProfileIntegrationId + - code: code created: 2000-01-23T04:56:07.000+00:00 - campaignId: 7 - usageLimit: 0 - id: 3 - usageCounter: 0 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId - startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - code: code + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 friendProfileIntegrationId: friendProfileIntegrationId - created: 2000-01-23T04:56:07.000+00:00 - campaignId: 7 - usageLimit: 0 + attributes: '{}' id: 3 - usageCounter: 0 + startDate: 2000-01-23T04:56:07.000+00:00 + - code: code + created: 2000-01-23T04:56:07.000+00:00 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 + friendProfileIntegrationId: friendProfileIntegrationId + attributes: '{}' + id: 3 startDate: 2000-01-23T04:56:07.000+00:00 - effects: - - rulesetId: 4 - ruleIndex: 3 - campaignId: 8 + - rulesetId: 0 + ruleIndex: 2 + campaignId: 3 ruleName: ruleName - triggeredByCoupon: 0 + triggeredByCoupon: 1 effectType: effectType props: '{}' - - rulesetId: 4 - ruleIndex: 3 - campaignId: 8 + - rulesetId: 0 + ruleIndex: 2 + campaignId: 3 ruleName: ruleName - triggeredByCoupon: 0 + triggeredByCoupon: 1 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: 7 - usageLimit: 0 - id: 3 - usageCounter: 0 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 + friendProfileIntegrationId: friendProfileIntegrationId + attributes: '{}' + id: 3 startDate: 2000-01-23T04:56:07.000+00:00 triggeredCampaigns: - - createdLoyaltyPointsEffectCount: 5 - discountCount: 9.132027271330688 + - createdLoyaltyPointsEffectCount: 6 + discountCount: 0.8774076871421566 description: description features: - coupons - coupons - coupons - createdLoyaltyPointsCount: 7.933506881737151 + createdLoyaltyPointsCount: 4.86315908102884 couponSettings: couponPattern: couponPattern validCharacters: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 3 + id: 4 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - activeRulesetId: 6 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 0 - couponRedemptionCount: 4 - userId: 0 - couponCreationCount: 9 + referralCreationCount: 7 + couponRedemptionCount: 7 + userId: 6 + couponCreationCount: 0 campaignGroups: - - 1 - - 1 + - 4 + - 4 tags: - tags - tags - tags - tags - tags - redeemedLoyaltyPointsEffectCount: 6 - discountEffectCount: 0 + awardedGiveawaysCount: 5 + redeemedLoyaltyPointsEffectCount: 4 + discountEffectCount: 9 createdBy: createdBy - redeemedLoyaltyPointsCount: 4.86315908102884 + redeemedLoyaltyPointsCount: 8.251625748923757 name: name referralSettings: couponPattern: couponPattern @@ -13424,56 +14335,57 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 4 - referralRedemptionCount: 7 + applicationId: 0 + referralRedemptionCount: 9 updated: 2000-01-23T04:56:07.000+00:00 - - createdLoyaltyPointsEffectCount: 5 - discountCount: 9.132027271330688 + - createdLoyaltyPointsEffectCount: 6 + discountCount: 0.8774076871421566 description: description features: - coupons - coupons - coupons - createdLoyaltyPointsCount: 7.933506881737151 + createdLoyaltyPointsCount: 4.86315908102884 couponSettings: couponPattern: couponPattern validCharacters: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 3 + id: 4 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - activeRulesetId: 6 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 0 - couponRedemptionCount: 4 - userId: 0 - couponCreationCount: 9 + referralCreationCount: 7 + couponRedemptionCount: 7 + userId: 6 + couponCreationCount: 0 campaignGroups: - - 1 - - 1 + - 4 + - 4 tags: - tags - tags - tags - tags - tags - redeemedLoyaltyPointsEffectCount: 6 - discountEffectCount: 0 + awardedGiveawaysCount: 5 + redeemedLoyaltyPointsEffectCount: 4 + discountEffectCount: 9 createdBy: createdBy - redeemedLoyaltyPointsCount: 4.86315908102884 + redeemedLoyaltyPointsCount: 8.251625748923757 name: name referralSettings: couponPattern: couponPattern @@ -13483,44 +14395,44 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 4 - referralRedemptionCount: 7 + applicationId: 0 + referralRedemptionCount: 9 updated: 2000-01-23T04:56:07.000+00:00 coupons: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 customerProfile: accountId: 1 closedSessions: 1 @@ -13605,6 +14517,25 @@ components: name: name id: 2 title: title + awardedGiveaways: + - code: code + importId: 0 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2000-01-23T04:56:07.000+00:00 + poolId: 8 + attributes: '{}' + id: 9 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 + - code: code + importId: 0 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2000-01-23T04:56:07.000+00:00 + poolId: 8 + attributes: '{}' + id: 9 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 event: effects: - '{}' @@ -13652,83 +14583,89 @@ components: createdCoupons: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 ruleFailureReasons: - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue createdReferrals: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - code: code - friendProfileIntegrationId: friendProfileIntegrationId + - code: code created: 2000-01-23T04:56:07.000+00:00 - campaignId: 7 - usageLimit: 0 - id: 3 - usageCounter: 0 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId - startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - code: code + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 friendProfileIntegrationId: friendProfileIntegrationId - created: 2000-01-23T04:56:07.000+00:00 - campaignId: 7 - usageLimit: 0 + attributes: '{}' id: 3 - usageCounter: 0 + startDate: 2000-01-23T04:56:07.000+00:00 + - code: code + created: 2000-01-23T04:56:07.000+00:00 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 + friendProfileIntegrationId: friendProfileIntegrationId + attributes: '{}' + id: 3 startDate: 2000-01-23T04:56:07.000+00:00 properties: integrationStates: @@ -13834,69 +14771,380 @@ components: required: - newLatestFeedTimestamp type: object - RuleFailureReason: - description: Details about why a rule failed - example: - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 - ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 - details: details - couponID: 8 - referralValue: referralValue - campaignName: campaignName - couponValue: couponValue + AccountCampaignStats: + additionalProperties: + $ref: '#/components/schemas/ApplicationCampaignStats' + type: object + ApplicationCampaignStats: + description: Provides statistics regarding an application's campaigns + properties: + draft: + description: Number of draft campaigns + type: integer + disabled: + description: Number of disabled campaigns + type: integer + scheduled: + description: Number of scheduled campaigns + type: integer + running: + description: Number of running campaigns + type: integer + expired: + description: Number of expired campaigns + type: integer + archived: + description: Number of archived campaigns + type: integer + required: + - archived + - disabled + - draft + - expired + - running + - scheduled + type: object + RuleFailureReason: + description: Details about why a rule failed + example: + rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 + ruleName: ruleName + conditionIndex: 1 + effectIndex: 3 + details: details + couponID: 4 + referralValue: referralValue + campaignName: campaignName + couponValue: couponValue + properties: + campaignID: + description: The ID of the campaign that contains the rule that failed + type: integer + campaignName: + description: The name of the campaign that contains the rule that failed + type: string + rulesetID: + description: The ID of the ruleset that contains the rule that failed + type: integer + couponID: + description: The ID of the coupon that was being evaluated at the time of + the rule failure + type: integer + couponValue: + description: The value of the coupon that was being evaluated at the time + of the rule failure + type: string + referralID: + description: The ID of the referral that was being evaluated at the time + of the rule failure + type: integer + referralValue: + description: The value of the referral that was being evaluated at the time + of the rule failure + type: string + ruleIndex: + description: The index of the rule that failed within the ruleset + type: integer + ruleName: + description: The name of the rule that failed within the ruleset + type: string + conditionIndex: + description: The index of the condition that failed + type: integer + effectIndex: + description: The index of the effect that failed + type: integer + details: + description: More details about the failure + type: string + required: + - campaignID + - campaignName + - ruleIndex + - ruleName + - rulesetID + type: object + Giveaway: + description: "" + example: + code: code + importId: 0 + endDate: 2000-01-23T04:56:07.000+00:00 + created: 2000-01-23T04:56:07.000+00:00 + poolId: 8 + attributes: '{}' + id: 9 + used: true + startDate: 2000-01-23T04:56:07.000+00:00 + properties: + id: + description: Unique ID for this entity. + type: integer + created: + description: The exact moment this entity was created. + format: date-time + type: string + code: + description: The code value of this giveaway. + type: string + poolId: + description: The ID of the pool to return giveaway codes from. + type: integer + startDate: + description: Timestamp at which point the giveaway becomes valid. + format: date-time + type: string + endDate: + description: Timestamp at which point the giveaway becomes invalid. + format: date-time + type: string + attributes: + description: Arbitrary properties associated with this giveaway. + properties: {} + type: object + used: + description: Flag indicating whether this giveaway code was given before. + type: boolean + importId: + description: The ID of the Import which created this giveaway. + type: integer + required: + - code + - created + - id + - poolId + type: object + NewGiveawaysPool: + properties: + name: + description: The name of this giveaways pool. + type: string + description: + description: The description of this giveaways pool. + type: string + subscribedApplicationsIds: + description: A list of the IDs of the applications that this giveaways pool + is enabled for + items: + type: integer + type: array + required: + - name + type: object + GiveawaysPool: + description: "" + properties: + id: + description: Unique ID for this entity. + type: integer + created: + description: The exact moment this entity was created. + format: date-time + type: string + accountId: + description: The ID of the account that owns this entity. + type: integer + name: + description: The name of this giveaways pool. + type: string + description: + description: The description of this giveaways pool. + type: string + subscribedApplicationsIds: + description: A list of the IDs of the applications that this giveaways pool + is enabled for + items: + type: integer + type: array + modified: + description: Timestamp of the most recent update to the giveaways pool. + format: date-time + type: string + createdBy: + description: ID of the user who created this giveaways pool. + type: integer + modifiedBy: + description: ID of the user who last updated this giveaways pool if available. + type: integer + required: + - accountId + - created + - createdBy + - id + - name + type: object + NewCustomEffect: + properties: + name: + description: The name of this effect. + type: string + title: + description: The title of this effect. + type: string + payload: + description: The JSON payload of this effect. + type: string + description: + description: The description of this effect. + type: string + enabled: + description: Determines if this effect is active. + type: boolean + subscribedApplicationsIds: + description: A list of the IDs of the applications that this effect is enabled + for + items: + type: integer + type: array + params: + description: Array of template argument definitions + items: + $ref: '#/components/schemas/TemplateArgDef' + type: array + required: + - enabled + - name + - payload + - title + type: object + UpdateCustomEffect: + description: "" + properties: + name: + description: The name of this effect. + type: string + title: + description: The title of this effect. + type: string + payload: + description: The JSON payload of this effect. + type: string + description: + description: The description of this effect. + type: string + enabled: + description: Determines if this effect is active. + type: boolean + subscribedApplicationsIds: + description: A list of the IDs of the applications that this effect is enabled + for + items: + type: integer + type: array + params: + description: Array of template argument definitions + items: + $ref: '#/components/schemas/TemplateArgDef' + type: array + required: + - enabled + - name + - payload + - title + type: object + CustomEffect: + description: "" properties: - campaignID: - description: The ID of the campaign that contains the rule that failed + id: + description: Unique ID for this entity. type: integer - campaignName: - description: The name of the campaign that contains the rule that failed + created: + description: The exact moment this entity was created. + format: date-time type: string - rulesetID: - description: The ID of the ruleset that contains the rule that failed - type: integer - couponID: - description: The ID of the coupon that was being evaluated at the time of - the rule failure + accountId: + description: The ID of the account that owns this entity. type: integer - couponValue: - description: The value of the coupon that was being evaluated at the time - of the rule failure + modified: + description: The exact moment this entity was last modified. + format: date-time type: string - referralID: - description: The ID of the referral that was being evaluated at the time - of the rule failure - type: integer - referralValue: - description: The value of the referral that was being evaluated at the time - of the rule failure + name: + description: The name of this effect. type: string - ruleIndex: - description: The index of the rule that failed within the ruleset - type: integer - ruleName: - description: The name of the rule that failed within the ruleset + title: + description: The title of this effect. type: string - conditionIndex: - description: The index of the condition that failed + payload: + description: The JSON payload of this effect. + type: string + description: + description: The description of this effect. + type: string + enabled: + description: Determines if this effect is active. + type: boolean + subscribedApplicationsIds: + description: A list of the IDs of the applications that this effect is enabled + for + items: + type: integer + type: array + params: + description: Array of template argument definitions + items: + $ref: '#/components/schemas/TemplateArgDef' + type: array + modifiedBy: + description: ID of the user who last updated this effect if available. type: integer - effectIndex: - description: The index of the effect that failed + createdBy: + description: ID of the user who created this effect. type: integer - details: - description: More details about the failure - type: string required: - - campaignID - - campaignName - - ruleIndex - - ruleName - - rulesetID + - accountId + - created + - createdBy + - enabled + - id + - modified + - name + - payload + - title type: object + inline_response_201: + example: + data: + - code: code + created: 2000-01-23T04:56:07.000+00:00 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId + advocateProfileIntegrationId: advocateProfileIntegrationId + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 + friendProfileIntegrationId: friendProfileIntegrationId + attributes: '{}' + id: 3 + startDate: 2000-01-23T04:56:07.000+00:00 + - code: code + created: 2000-01-23T04:56:07.000+00:00 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId + advocateProfileIntegrationId: advocateProfileIntegrationId + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 + friendProfileIntegrationId: friendProfileIntegrationId + attributes: '{}' + id: 3 + startDate: 2000-01-23T04:56:07.000+00:00 + totalResultSize: 0 + properties: + totalResultSize: + type: integer + data: + items: + $ref: '#/components/schemas/Referral' + type: array + required: + - data + - totalResultSize inline_response_200: example: data: @@ -13969,6 +15217,17 @@ components: - accountID: 5 defaultValidity: defaultValidity defaultPending: defaultPending + tiers: + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 allowSubledger: true name: name description: description @@ -13980,6 +15239,17 @@ components: - accountID: 5 defaultValidity: defaultValidity defaultPending: defaultPending + tiers: + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 allowSubledger: true name: name description: description @@ -13999,12 +15269,12 @@ components: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - enableFlattenedCartItems: true created: 2000-01-23T04:56:07.000+00:00 @@ -14027,6 +15297,17 @@ components: - accountID: 5 defaultValidity: defaultValidity defaultPending: defaultPending + tiers: + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 allowSubledger: true name: name description: description @@ -14038,6 +15319,17 @@ components: - accountID: 5 defaultValidity: defaultValidity defaultPending: defaultPending + tiers: + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 allowSubledger: true name: name description: description @@ -14057,12 +15349,12 @@ components: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action totalResultSize: 0 properties: @@ -14078,53 +15370,54 @@ components: inline_response_200_2: example: data: - - createdLoyaltyPointsEffectCount: 5 - discountCount: 9.132027271330688 + - createdLoyaltyPointsEffectCount: 6 + discountCount: 0.8774076871421566 description: description features: - coupons - coupons - coupons - createdLoyaltyPointsCount: 7.933506881737151 + createdLoyaltyPointsCount: 4.86315908102884 couponSettings: couponPattern: couponPattern validCharacters: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 3 + id: 4 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - activeRulesetId: 6 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 0 - couponRedemptionCount: 4 - userId: 0 - couponCreationCount: 9 + referralCreationCount: 7 + couponRedemptionCount: 7 + userId: 6 + couponCreationCount: 0 campaignGroups: - - 1 - - 1 + - 4 + - 4 tags: - tags - tags - tags - tags - tags - redeemedLoyaltyPointsEffectCount: 6 - discountEffectCount: 0 + awardedGiveawaysCount: 5 + redeemedLoyaltyPointsEffectCount: 4 + discountEffectCount: 9 createdBy: createdBy - redeemedLoyaltyPointsCount: 4.86315908102884 + redeemedLoyaltyPointsCount: 8.251625748923757 name: name referralSettings: couponPattern: couponPattern @@ -14134,56 +15427,57 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 4 - referralRedemptionCount: 7 + applicationId: 0 + referralRedemptionCount: 9 updated: 2000-01-23T04:56:07.000+00:00 - - createdLoyaltyPointsEffectCount: 5 - discountCount: 9.132027271330688 + - createdLoyaltyPointsEffectCount: 6 + discountCount: 0.8774076871421566 description: description features: - coupons - coupons - coupons - createdLoyaltyPointsCount: 7.933506881737151 + createdLoyaltyPointsCount: 4.86315908102884 couponSettings: couponPattern: couponPattern validCharacters: - validCharacters - validCharacters startTime: 2000-01-23T04:56:07.000+00:00 - id: 3 + id: 4 state: enabled limits: - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - entities: - Coupon - Coupon - limit: 0.42587731081743563 + limit: 0.10414449161182959 action: action - activeRulesetId: 6 + activeRulesetId: 4 updatedBy: updatedBy created: 2000-01-23T04:56:07.000+00:00 - referralCreationCount: 0 - couponRedemptionCount: 4 - userId: 0 - couponCreationCount: 9 + referralCreationCount: 7 + couponRedemptionCount: 7 + userId: 6 + couponCreationCount: 0 campaignGroups: - - 1 - - 1 + - 4 + - 4 tags: - tags - tags - tags - tags - tags - redeemedLoyaltyPointsEffectCount: 6 - discountEffectCount: 0 + awardedGiveawaysCount: 5 + redeemedLoyaltyPointsEffectCount: 4 + discountEffectCount: 9 createdBy: createdBy - redeemedLoyaltyPointsCount: 4.86315908102884 + redeemedLoyaltyPointsCount: 8.251625748923757 name: name referralSettings: couponPattern: couponPattern @@ -14193,8 +15487,8 @@ components: attributes: '{}' lastActivity: 2000-01-23T04:56:07.000+00:00 endTime: 2000-01-23T04:56:07.000+00:00 - applicationId: 4 - referralRedemptionCount: 7 + applicationId: 0 + referralRedemptionCount: 9 updated: 2000-01-23T04:56:07.000+00:00 totalResultSize: 0 properties: @@ -14340,38 +15634,38 @@ components: data: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 totalResultSize: 0 properties: totalResultSize: @@ -14388,38 +15682,38 @@ components: data: - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 - recipientIntegrationId: recipientIntegrationId created: 2000-01-23T04:56:07.000+00:00 - campaignId: 0 - usageLimit: 465239 - referralId: 7 - usageCounter: 7 + campaignId: 4 + usageLimit: 896956 + referralId: 5 + usageCounter: 3 batchId: batchId - discountCounter: 3.0205796992916243 + discountCounter: 3.0576100241049344 expiryDate: 2000-01-23T04:56:07.000+00:00 - importId: 5 + importId: 3 reservation: true attributes: '{}' - id: 6 + id: 0 value: value - discountLimit: 896956.9828618114 + discountLimit: 774034.4078389355 startDate: 2000-01-23T04:56:07.000+00:00 - discountRemainder: 3.0576100241049344 + discountRemainder: 7.04836565559697 hasMore: true properties: hasMore: @@ -14434,59 +15728,31 @@ components: inline_response_200_6: example: data: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - code: code - friendProfileIntegrationId: friendProfileIntegrationId + - code: code created: 2000-01-23T04:56:07.000+00:00 - campaignId: 7 - usageLimit: 0 - id: 3 - usageCounter: 0 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId - startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - code: code + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 friendProfileIntegrationId: friendProfileIntegrationId - created: 2000-01-23T04:56:07.000+00:00 - campaignId: 7 - usageLimit: 0 + attributes: '{}' id: 3 - usageCounter: 0 - advocateProfileIntegrationId: advocateProfileIntegrationId startDate: 2000-01-23T04:56:07.000+00:00 - totalResultSize: 0 - properties: - totalResultSize: - type: integer - data: - items: - $ref: '#/components/schemas/Referral' - type: array - required: - - data - - totalResultSize - inline_response_200_7: - example: - data: - - expiryDate: 2000-01-23T04:56:07.000+00:00 - code: code - friendProfileIntegrationId: friendProfileIntegrationId + - code: code created: 2000-01-23T04:56:07.000+00:00 - campaignId: 7 - usageLimit: 0 - id: 3 - usageCounter: 0 + usageLimit: 714353 + campaignId: 0 + usageCounter: 6 + batchId: batchId advocateProfileIntegrationId: advocateProfileIntegrationId - startDate: 2000-01-23T04:56:07.000+00:00 - - expiryDate: 2000-01-23T04:56:07.000+00:00 - code: code + expiryDate: 2000-01-23T04:56:07.000+00:00 + importId: 7 friendProfileIntegrationId: friendProfileIntegrationId - created: 2000-01-23T04:56:07.000+00:00 - campaignId: 7 - usageLimit: 0 + attributes: '{}' id: 3 - usageCounter: 0 - advocateProfileIntegrationId: advocateProfileIntegrationId startDate: 2000-01-23T04:56:07.000+00:00 hasMore: true properties: @@ -14499,12 +15765,23 @@ components: required: - data - hasMore - inline_response_200_8: + inline_response_200_7: example: data: - accountID: 5 defaultValidity: defaultValidity defaultPending: defaultPending + tiers: + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 allowSubledger: true name: name description: description @@ -14516,6 +15793,17 @@ components: - accountID: 5 defaultValidity: defaultValidity defaultPending: defaultPending + tiers: + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 + - created: 2000-01-23T04:56:07.000+00:00 + name: name + minPoints: 3.616076749251911E7 + id: 7 + programID: 9 allowSubledger: true name: name description: description @@ -14535,7 +15823,7 @@ components: required: - data - totalResultSize - inline_response_200_9: + inline_response_200_8: example: data: - method: method @@ -14563,7 +15851,7 @@ components: required: - data - totalResultSize - inline_response_200_10: + inline_response_200_9: example: data: - method: method @@ -14591,7 +15879,7 @@ components: required: - data - hasMore - inline_response_200_11: + inline_response_200_10: example: data: - date: 2000-01-23T04:56:07.000+00:00 @@ -14655,7 +15943,7 @@ components: required: - data - totalResultSize - inline_response_200_12: + inline_response_200_11: example: data: - accountId: 1 @@ -14707,7 +15995,7 @@ components: type: array required: - data - inline_response_200_13: + inline_response_200_12: example: data: - accountId: 1 @@ -14757,7 +16045,7 @@ components: required: - data - hasMore - inline_response_200_14: + inline_response_200_13: example: data: - couponUseAttempts: 5 @@ -14797,7 +16085,7 @@ components: required: - data - totalResultSize - inline_response_200_15: + inline_response_200_14: example: data: - couponUseAttempts: 5 @@ -14837,7 +16125,7 @@ components: required: - data - hasMore - inline_response_200_16: + inline_response_200_15: example: data: - coupon: coupon @@ -14922,7 +16210,7 @@ components: type: array required: - data - inline_response_200_17: + inline_response_200_16: example: data: - effects: @@ -14936,27 +16224,27 @@ components: applicationId: 1 type: type ruleFailureReasons: - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue @@ -14971,27 +16259,27 @@ components: applicationId: 1 type: type ruleFailureReasons: - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue @@ -15006,7 +16294,7 @@ components: required: - data - totalResultSize - inline_response_200_18: + inline_response_200_17: example: data: - effects: @@ -15020,27 +16308,27 @@ components: applicationId: 1 type: type ruleFailureReasons: - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue @@ -15055,27 +16343,27 @@ components: applicationId: 1 type: type ruleFailureReasons: - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue - - rulesetID: 1 - ruleIndex: 4 - campaignID: 2 - referralID: 6 + - rulesetID: 6 + ruleIndex: 9 + campaignID: 8 + referralID: 8 ruleName: ruleName - conditionIndex: 8 - effectIndex: 9 + conditionIndex: 1 + effectIndex: 3 details: details - couponID: 8 + couponID: 4 referralValue: referralValue campaignName: campaignName couponValue: couponValue @@ -15090,7 +16378,7 @@ components: required: - data - hasMore - inline_response_200_19: + inline_response_200_18: example: data: - data @@ -15106,7 +16394,7 @@ components: required: - data - totalResultSize - inline_response_200_20: + inline_response_200_19: example: data: - accountId: 6 @@ -15121,8 +16409,11 @@ components: integration: mparticle integrationId: integrationId id: 1 + hasMore: true totalResultSize: 0 properties: + hasMore: + type: boolean totalResultSize: type: integer data: @@ -15131,7 +16422,7 @@ components: type: array required: - data - inline_response_200_21: + inline_response_200_20: example: data: - accountId: 1 @@ -15183,7 +16474,7 @@ components: required: - data - totalResultSize - inline_response_200_22: + inline_response_200_21: example: data: - accountId: 1 @@ -15215,7 +16506,7 @@ components: required: - data - totalResultSize - inline_response_200_23: + inline_response_200_22: example: data: - headers: @@ -15275,7 +16566,7 @@ components: required: - data - totalResultSize - inline_response_200_24: + inline_response_200_23: example: data: - webhookId: 6 @@ -15299,7 +16590,7 @@ components: required: - data - totalResultSize - inline_response_200_25: + inline_response_200_24: example: data: - requestTime: 2000-01-23T04:56:07.000+00:00 @@ -15333,7 +16624,7 @@ components: required: - data - totalResultSize - inline_response_200_26: + inline_response_200_25: example: data: - schema: '{}' @@ -15375,7 +16666,7 @@ components: required: - data - totalResultSize - inline_response_200_27: + inline_response_200_26: example: data: - created: 2000-01-23T04:56:07.000+00:00 @@ -15419,7 +16710,7 @@ components: required: - data - totalResultSize - inline_response_200_28: + inline_response_200_27: example: data: - new: '{}' @@ -15449,7 +16740,7 @@ components: type: array required: - data - inline_response_200_29: + inline_response_200_28: example: data: - filter: '{}' @@ -15475,24 +16766,28 @@ components: required: - data - totalResultSize - inline_response_200_30: + inline_response_200_29: example: data: - - accountID: 1 + - accountId: 1 + created: 2000-01-23T04:56:07.000+00:00 campaignGroupID: 5 members: - 5 - 5 name: name + modified: 2000-01-23T04:56:07.000+00:00 description: description id: 6 acl: '{}' - - accountID: 1 + - accountId: 1 + created: 2000-01-23T04:56:07.000+00:00 campaignGroupID: 5 members: - 5 - 5 name: name + modified: 2000-01-23T04:56:07.000+00:00 description: description id: 6 acl: '{}' diff --git a/api_integration.go b/api_integration.go index 79a3b129..3ac6f041 100644 --- a/api_integration.go +++ b/api_integration.go @@ -321,6 +321,162 @@ func (r apiCreateReferralRequest) Execute() (Referral, *_nethttp.Response, error return localVarReturnValue, localVarHTTPResponse, nil } +type apiCreateReferralsForMultipleAdvocatesRequest struct { + ctx _context.Context + apiService *IntegrationApiService + body *NewReferralsForMultipleAdvocates + silent *string +} + +func (r apiCreateReferralsForMultipleAdvocatesRequest) Body(body NewReferralsForMultipleAdvocates) apiCreateReferralsForMultipleAdvocatesRequest { + r.body = &body + return r +} + +func (r apiCreateReferralsForMultipleAdvocatesRequest) Silent(silent string) apiCreateReferralsForMultipleAdvocatesRequest { + r.silent = &silent + return r +} + +/* +CreateReferralsForMultipleAdvocates Create referral codes for multiple advocates +Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return apiCreateReferralsForMultipleAdvocatesRequest +*/ +func (a *IntegrationApiService) CreateReferralsForMultipleAdvocates(ctx _context.Context) apiCreateReferralsForMultipleAdvocatesRequest { + return apiCreateReferralsForMultipleAdvocatesRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + @return InlineResponse201 +*/ +func (r apiCreateReferralsForMultipleAdvocatesRequest) Execute() (InlineResponse201, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue InlineResponse201 + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.CreateReferralsForMultipleAdvocates") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/referrals_for_multiple_advocates" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + if r.silent != nil { + localVarQueryParams.Add("silent", parameterToString(*r.silent, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Content-Signature"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Content-Signature"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 201 { + var v InlineResponse201 + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + 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 apiDeleteCouponReservationRequest struct { ctx _context.Context apiService *IntegrationApiService @@ -579,6 +735,7 @@ type apiGetCustomerInventoryRequest struct { referrals *bool coupons *bool loyalty *bool + giveaways *bool } func (r apiGetCustomerInventoryRequest) Profile(profile bool) apiGetCustomerInventoryRequest { @@ -601,6 +758,11 @@ func (r apiGetCustomerInventoryRequest) Loyalty(loyalty bool) apiGetCustomerInve return r } +func (r apiGetCustomerInventoryRequest) Giveaways(giveaways bool) apiGetCustomerInventoryRequest { + r.giveaways = &giveaways + 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. @@ -654,6 +816,9 @@ func (r apiGetCustomerInventoryRequest) Execute() (CustomerInventory, *_nethttp. if r.loyalty != nil { localVarQueryParams.Add("loyalty", parameterToString(*r.loyalty, "")) } + if r.giveaways != nil { + localVarQueryParams.Add("giveaways", parameterToString(*r.giveaways, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} diff --git a/api_management.go b/api_management.go index 895f8cf0..8436a106 100644 --- a/api_management.go +++ b/api_management.go @@ -3065,16 +3065,16 @@ func (a *ManagementApiService) GetAccessLogs(ctx _context.Context, applicationId /* Execute executes the request - @return InlineResponse2009 + @return InlineResponse2008 */ -func (r apiGetAccessLogsRequest) Execute() (InlineResponse2009, *_nethttp.Response, error) { +func (r apiGetAccessLogsRequest) Execute() (InlineResponse2008, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2009 + localVarReturnValue InlineResponse2008 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccessLogs") @@ -3170,7 +3170,7 @@ func (r apiGetAccessLogsRequest) Execute() (InlineResponse2009, *_nethttp.Respon error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2009 + var v InlineResponse2008 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -3263,16 +3263,16 @@ func (a *ManagementApiService) GetAccessLogsWithoutTotalCount(ctx _context.Conte /* Execute executes the request - @return InlineResponse20010 + @return InlineResponse2009 */ -func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse20010, *_nethttp.Response, error) { +func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse2009, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20010 + localVarReturnValue InlineResponse2009 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAccessLogsWithoutTotalCount") @@ -3368,7 +3368,7 @@ func (r apiGetAccessLogsWithoutTotalCountRequest) Execute() (InlineResponse20010 error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20010 + var v InlineResponse2009 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -3802,16 +3802,16 @@ func (a *ManagementApiService) GetAdditionalCosts(ctx _context.Context) apiGetAd /* Execute executes the request - @return InlineResponse20022 + @return InlineResponse20021 */ -func (r apiGetAdditionalCostsRequest) Execute() (InlineResponse20022, *_nethttp.Response, error) { +func (r apiGetAdditionalCostsRequest) Execute() (InlineResponse20021, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20022 + localVarReturnValue InlineResponse20021 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAdditionalCosts") @@ -3887,7 +3887,7 @@ func (r apiGetAdditionalCostsRequest) Execute() (InlineResponse20022, *_nethttp. error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20022 + var v InlineResponse20021 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -3979,16 +3979,16 @@ func (a *ManagementApiService) GetAllAccessLogs(ctx _context.Context) apiGetAllA /* Execute executes the request - @return InlineResponse2009 + @return InlineResponse2008 */ -func (r apiGetAllAccessLogsRequest) Execute() (InlineResponse2009, *_nethttp.Response, error) { +func (r apiGetAllAccessLogsRequest) Execute() (InlineResponse2008, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2009 + localVarReturnValue InlineResponse2008 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAllAccessLogs") @@ -4083,7 +4083,7 @@ func (r apiGetAllAccessLogsRequest) Execute() (InlineResponse2009, *_nethttp.Res error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2009 + var v InlineResponse2008 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4125,16 +4125,16 @@ func (a *ManagementApiService) GetAllRoles(ctx _context.Context) apiGetAllRolesR /* Execute executes the request - @return InlineResponse20030 + @return InlineResponse20029 */ -func (r apiGetAllRolesRequest) Execute() (InlineResponse20030, *_nethttp.Response, error) { +func (r apiGetAllRolesRequest) Execute() (InlineResponse20029, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20030 + localVarReturnValue InlineResponse20029 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAllRoles") @@ -4201,7 +4201,7 @@ func (r apiGetAllRolesRequest) Execute() (InlineResponse20030, *_nethttp.Respons error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20030 + var v InlineResponse20029 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4641,16 +4641,16 @@ func (a *ManagementApiService) GetApplicationCustomers(ctx _context.Context, app /* Execute executes the request - @return InlineResponse20012 + @return InlineResponse20011 */ -func (r apiGetApplicationCustomersRequest) Execute() (InlineResponse20012, *_nethttp.Response, error) { +func (r apiGetApplicationCustomersRequest) Execute() (InlineResponse20011, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20012 + localVarReturnValue InlineResponse20011 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomers") @@ -4730,7 +4730,7 @@ func (r apiGetApplicationCustomersRequest) Execute() (InlineResponse20012, *_net error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20012 + var v InlineResponse20011 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4784,16 +4784,16 @@ func (a *ManagementApiService) GetApplicationCustomersByAttributes(ctx _context. /* Execute executes the request - @return InlineResponse20013 + @return InlineResponse20012 */ -func (r apiGetApplicationCustomersByAttributesRequest) Execute() (InlineResponse20013, *_nethttp.Response, error) { +func (r apiGetApplicationCustomersByAttributesRequest) Execute() (InlineResponse20012, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20013 + localVarReturnValue InlineResponse20012 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationCustomersByAttributes") @@ -4866,7 +4866,7 @@ func (r apiGetApplicationCustomersByAttributesRequest) Execute() (InlineResponse error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20013 + var v InlineResponse20012 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -4933,16 +4933,16 @@ func (a *ManagementApiService) GetApplicationEventTypes(ctx _context.Context, ap /* Execute executes the request - @return InlineResponse20019 + @return InlineResponse20018 */ -func (r apiGetApplicationEventTypesRequest) Execute() (InlineResponse20019, *_nethttp.Response, error) { +func (r apiGetApplicationEventTypesRequest) Execute() (InlineResponse20018, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20019 + localVarReturnValue InlineResponse20018 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationEventTypes") @@ -5019,7 +5019,7 @@ func (r apiGetApplicationEventTypesRequest) Execute() (InlineResponse20019, *_ne error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20019 + var v InlineResponse20018 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -5150,16 +5150,16 @@ func (a *ManagementApiService) GetApplicationEvents(ctx _context.Context, applic /* Execute executes the request - @return InlineResponse20017 + @return InlineResponse20016 */ -func (r apiGetApplicationEventsRequest) Execute() (InlineResponse20017, *_nethttp.Response, error) { +func (r apiGetApplicationEventsRequest) Execute() (InlineResponse20016, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20017 + localVarReturnValue InlineResponse20016 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationEvents") @@ -5269,7 +5269,7 @@ func (r apiGetApplicationEventsRequest) Execute() (InlineResponse20017, *_nethtt error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20017 + var v InlineResponse20016 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -5400,16 +5400,16 @@ func (a *ManagementApiService) GetApplicationEventsWithoutTotalCount(ctx _contex /* Execute executes the request - @return InlineResponse20018 + @return InlineResponse20017 */ -func (r apiGetApplicationEventsWithoutTotalCountRequest) Execute() (InlineResponse20018, *_nethttp.Response, error) { +func (r apiGetApplicationEventsWithoutTotalCountRequest) Execute() (InlineResponse20017, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20018 + localVarReturnValue InlineResponse20017 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationEventsWithoutTotalCount") @@ -5519,7 +5519,7 @@ func (r apiGetApplicationEventsWithoutTotalCountRequest) Execute() (InlineRespon error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20018 + var v InlineResponse20017 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -5750,16 +5750,16 @@ func (a *ManagementApiService) GetApplicationSessions(ctx _context.Context, appl /* Execute executes the request - @return InlineResponse20016 + @return InlineResponse20015 */ -func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20016, *_nethttp.Response, error) { +func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20015, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20016 + localVarReturnValue InlineResponse20015 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetApplicationSessions") @@ -5857,7 +5857,7 @@ func (r apiGetApplicationSessionsRequest) Execute() (InlineResponse20016, *_neth error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20016 + var v InlineResponse20015 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6156,6 +6156,7 @@ type apiGetAttributesRequest struct { pageSize *int32 skip *int32 sort *string + entity *string } func (r apiGetAttributesRequest) PageSize(pageSize int32) apiGetAttributesRequest { @@ -6173,6 +6174,11 @@ func (r apiGetAttributesRequest) Sort(sort string) apiGetAttributesRequest { return r } +func (r apiGetAttributesRequest) Entity(entity string) apiGetAttributesRequest { + r.entity = &entity + return r +} + /* GetAttributes List custom attributes Returns all the defined custom attributes for the account. @@ -6189,16 +6195,16 @@ func (a *ManagementApiService) GetAttributes(ctx _context.Context) apiGetAttribu /* Execute executes the request - @return InlineResponse20021 + @return InlineResponse20020 */ -func (r apiGetAttributesRequest) Execute() (InlineResponse20021, *_nethttp.Response, error) { +func (r apiGetAttributesRequest) Execute() (InlineResponse20020, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20021 + localVarReturnValue InlineResponse20020 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAttributes") @@ -6221,6 +6227,9 @@ func (r apiGetAttributesRequest) Execute() (InlineResponse20021, *_nethttp.Respo if r.sort != nil { localVarQueryParams.Add("sort", parameterToString(*r.sort, "")) } + if r.entity != nil { + localVarQueryParams.Add("entity", parameterToString(*r.entity, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -6274,7 +6283,7 @@ func (r apiGetAttributesRequest) Execute() (InlineResponse20021, *_nethttp.Respo error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20021 + var v InlineResponse20020 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6342,16 +6351,16 @@ func (a *ManagementApiService) GetAudiences(ctx _context.Context) apiGetAudience /* Execute executes the request - @return InlineResponse20020 + @return InlineResponse20019 */ -func (r apiGetAudiencesRequest) Execute() (InlineResponse20020, *_nethttp.Response, error) { +func (r apiGetAudiencesRequest) Execute() (InlineResponse20019, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20020 + localVarReturnValue InlineResponse20019 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetAudiences") @@ -6430,7 +6439,7 @@ func (r apiGetAudiencesRequest) Execute() (InlineResponse20020, *_nethttp.Respon error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20020 + var v InlineResponse20019 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -6622,16 +6631,16 @@ func (a *ManagementApiService) GetCampaignAnalytics(ctx _context.Context, applic /* Execute executes the request - @return InlineResponse20011 + @return InlineResponse20010 */ -func (r apiGetCampaignAnalyticsRequest) Execute() (InlineResponse20011, *_nethttp.Response, error) { +func (r apiGetCampaignAnalyticsRequest) Execute() (InlineResponse20010, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20011 + localVarReturnValue InlineResponse20010 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCampaignAnalytics") @@ -6713,7 +6722,7 @@ func (r apiGetCampaignAnalyticsRequest) Execute() (InlineResponse20011, *_nethtt error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20011 + var v InlineResponse20010 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -7191,16 +7200,16 @@ func (a *ManagementApiService) GetChanges(ctx _context.Context) apiGetChangesReq /* Execute executes the request - @return InlineResponse20028 + @return InlineResponse20027 */ -func (r apiGetChangesRequest) Execute() (InlineResponse20028, *_nethttp.Response, error) { +func (r apiGetChangesRequest) Execute() (InlineResponse20027, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20028 + localVarReturnValue InlineResponse20027 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetChanges") @@ -7297,7 +7306,7 @@ func (r apiGetChangesRequest) Execute() (InlineResponse20028, *_nethttp.Response error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20028 + var v InlineResponse20027 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8571,16 +8580,16 @@ func (a *ManagementApiService) GetCustomerActivityReports(ctx _context.Context, /* Execute executes the request - @return InlineResponse20014 + @return InlineResponse20013 */ -func (r apiGetCustomerActivityReportsRequest) Execute() (InlineResponse20014, *_nethttp.Response, error) { +func (r apiGetCustomerActivityReportsRequest) Execute() (InlineResponse20013, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20014 + localVarReturnValue InlineResponse20013 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerActivityReports") @@ -8679,7 +8688,7 @@ func (r apiGetCustomerActivityReportsRequest) Execute() (InlineResponse20014, *_ error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20014 + var v InlineResponse20013 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -8779,16 +8788,16 @@ func (a *ManagementApiService) GetCustomerActivityReportsWithoutTotalCount(ctx _ /* Execute executes the request - @return InlineResponse20015 + @return InlineResponse20014 */ -func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Execute() (InlineResponse20015, *_nethttp.Response, error) { +func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Execute() (InlineResponse20014, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20015 + localVarReturnValue InlineResponse20014 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerActivityReportsWithoutTotalCount") @@ -8887,7 +8896,7 @@ func (r apiGetCustomerActivityReportsWithoutTotalCountRequest) Execute() (Inline error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20015 + var v InlineResponse20014 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9217,16 +9226,16 @@ func (a *ManagementApiService) GetCustomerProfiles(ctx _context.Context) apiGetC /* Execute executes the request - @return InlineResponse20013 + @return InlineResponse20012 */ -func (r apiGetCustomerProfilesRequest) Execute() (InlineResponse20013, *_nethttp.Response, error) { +func (r apiGetCustomerProfilesRequest) Execute() (InlineResponse20012, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20013 + localVarReturnValue InlineResponse20012 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomerProfiles") @@ -9299,7 +9308,7 @@ func (r apiGetCustomerProfilesRequest) Execute() (InlineResponse20013, *_nethttp error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20013 + var v InlineResponse20012 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9365,16 +9374,16 @@ func (a *ManagementApiService) GetCustomersByAttributes(ctx _context.Context) ap /* Execute executes the request - @return InlineResponse20013 + @return InlineResponse20012 */ -func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20013, *_nethttp.Response, error) { +func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20012, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20013 + localVarReturnValue InlineResponse20012 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetCustomersByAttributes") @@ -9453,7 +9462,7 @@ func (r apiGetCustomersByAttributesRequest) Execute() (InlineResponse20013, *_ne error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20013 + var v InlineResponse20012 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9533,16 +9542,16 @@ func (a *ManagementApiService) GetEventTypes(ctx _context.Context) apiGetEventTy /* Execute executes the request - @return InlineResponse20026 + @return InlineResponse20025 */ -func (r apiGetEventTypesRequest) Execute() (InlineResponse20026, *_nethttp.Response, error) { +func (r apiGetEventTypesRequest) Execute() (InlineResponse20025, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20026 + localVarReturnValue InlineResponse20025 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetEventTypes") @@ -9627,7 +9636,7 @@ func (r apiGetEventTypesRequest) Execute() (InlineResponse20026, *_nethttp.Respo error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20026 + var v InlineResponse20025 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9701,16 +9710,16 @@ func (a *ManagementApiService) GetExports(ctx _context.Context) apiGetExportsReq /* Execute executes the request - @return InlineResponse20029 + @return InlineResponse20028 */ -func (r apiGetExportsRequest) Execute() (InlineResponse20029, *_nethttp.Response, error) { +func (r apiGetExportsRequest) Execute() (InlineResponse20028, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20029 + localVarReturnValue InlineResponse20028 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetExports") @@ -9792,7 +9801,7 @@ func (r apiGetExportsRequest) Execute() (InlineResponse20029, *_nethttp.Response error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20029 + var v InlineResponse20028 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -9945,7 +9954,7 @@ func (r apiGetLoyaltyPointsRequest) Execute() (LoyaltyLedger, *_nethttp.Response type apiGetLoyaltyProgramRequest struct { ctx _context.Context apiService *ManagementApiService - programID string + programID int32 } /* @@ -9954,7 +9963,7 @@ GetLoyaltyProgram Get a loyalty program * @param programID @return apiGetLoyaltyProgramRequest */ -func (a *ManagementApiService) GetLoyaltyProgram(ctx _context.Context, programID string) apiGetLoyaltyProgramRequest { +func (a *ManagementApiService) GetLoyaltyProgram(ctx _context.Context, programID int32) apiGetLoyaltyProgramRequest { return apiGetLoyaltyProgramRequest{ apiService: a, ctx: ctx, @@ -10083,16 +10092,16 @@ func (a *ManagementApiService) GetLoyaltyPrograms(ctx _context.Context) apiGetLo /* Execute executes the request - @return InlineResponse2008 + @return InlineResponse2007 */ -func (r apiGetLoyaltyProgramsRequest) Execute() (InlineResponse2008, *_nethttp.Response, error) { +func (r apiGetLoyaltyProgramsRequest) Execute() (InlineResponse2007, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2008 + localVarReturnValue InlineResponse2007 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetLoyaltyPrograms") @@ -10159,7 +10168,7 @@ func (r apiGetLoyaltyProgramsRequest) Execute() (InlineResponse2008, *_nethttp.R error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2008 + var v InlineResponse2007 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10383,16 +10392,16 @@ func (a *ManagementApiService) GetReferrals(ctx _context.Context, applicationId /* Execute executes the request - @return InlineResponse2006 + @return InlineResponse201 */ -func (r apiGetReferralsRequest) Execute() (InlineResponse2006, *_nethttp.Response, error) { +func (r apiGetReferralsRequest) Execute() (InlineResponse201, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2006 + localVarReturnValue InlineResponse201 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetReferrals") @@ -10488,7 +10497,7 @@ func (r apiGetReferralsRequest) Execute() (InlineResponse2006, *_nethttp.Respons error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2006 + var v InlineResponse201 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -10590,16 +10599,16 @@ func (a *ManagementApiService) GetReferralsWithoutTotalCount(ctx _context.Contex /* Execute executes the request - @return InlineResponse2007 + @return InlineResponse2006 */ -func (r apiGetReferralsWithoutTotalCountRequest) Execute() (InlineResponse2007, *_nethttp.Response, error) { +func (r apiGetReferralsWithoutTotalCountRequest) Execute() (InlineResponse2006, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2007 + localVarReturnValue InlineResponse2006 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetReferralsWithoutTotalCount") @@ -10695,7 +10704,7 @@ func (r apiGetReferralsWithoutTotalCountRequest) Execute() (InlineResponse2007, error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2007 + var v InlineResponse2006 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -11286,16 +11295,16 @@ func (a *ManagementApiService) GetUsers(ctx _context.Context) apiGetUsersRequest /* Execute executes the request - @return InlineResponse20027 + @return InlineResponse20026 */ -func (r apiGetUsersRequest) Execute() (InlineResponse20027, *_nethttp.Response, error) { +func (r apiGetUsersRequest) Execute() (InlineResponse20026, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20027 + localVarReturnValue InlineResponse20026 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetUsers") @@ -11371,7 +11380,7 @@ func (r apiGetUsersRequest) Execute() (InlineResponse20027, *_nethttp.Response, error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20027 + var v InlineResponse20026 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -11591,16 +11600,16 @@ func (a *ManagementApiService) GetWebhookActivationLogs(ctx _context.Context) ap /* Execute executes the request - @return InlineResponse20024 + @return InlineResponse20023 */ -func (r apiGetWebhookActivationLogsRequest) Execute() (InlineResponse20024, *_nethttp.Response, error) { +func (r apiGetWebhookActivationLogsRequest) Execute() (InlineResponse20023, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20024 + localVarReturnValue InlineResponse20023 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhookActivationLogs") @@ -11694,7 +11703,7 @@ func (r apiGetWebhookActivationLogsRequest) Execute() (InlineResponse20024, *_ne error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20024 + var v InlineResponse20023 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -11796,16 +11805,16 @@ func (a *ManagementApiService) GetWebhookLogs(ctx _context.Context) apiGetWebhoo /* Execute executes the request - @return InlineResponse20025 + @return InlineResponse20024 */ -func (r apiGetWebhookLogsRequest) Execute() (InlineResponse20025, *_nethttp.Response, error) { +func (r apiGetWebhookLogsRequest) Execute() (InlineResponse20024, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20025 + localVarReturnValue InlineResponse20024 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhookLogs") @@ -11902,7 +11911,7 @@ func (r apiGetWebhookLogsRequest) Execute() (InlineResponse20025, *_nethttp.Resp error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20025 + var v InlineResponse20024 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -11968,16 +11977,16 @@ func (a *ManagementApiService) GetWebhooks(ctx _context.Context) apiGetWebhooksR /* Execute executes the request - @return InlineResponse20023 + @return InlineResponse20022 */ -func (r apiGetWebhooksRequest) Execute() (InlineResponse20023, *_nethttp.Response, error) { +func (r apiGetWebhooksRequest) Execute() (InlineResponse20022, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse20023 + localVarReturnValue InlineResponse20022 ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.GetWebhooks") @@ -12056,7 +12065,7 @@ func (r apiGetWebhooksRequest) Execute() (InlineResponse20023, *_nethttp.Respons error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse20023 + var v InlineResponse20022 err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -12079,67 +12088,65 @@ func (r apiGetWebhooksRequest) Execute() (InlineResponse20023, *_nethttp.Respons return localVarReturnValue, localVarHTTPResponse, nil } -type apiRemoveLoyaltyPointsRequest struct { +type apiImportCouponsRequest struct { ctx _context.Context apiService *ManagementApiService - programID string - integrationID string - body *LoyaltyPoints + applicationId int32 + campaignId int32 + upFile *string } -func (r apiRemoveLoyaltyPointsRequest) Body(body LoyaltyPoints) apiRemoveLoyaltyPointsRequest { - r.body = &body +func (r apiImportCouponsRequest) UpFile(upFile string) apiImportCouponsRequest { + r.upFile = &upFile return r } /* -RemoveLoyaltyPoints Deduct points in a certain loyalty program for the specified customer +ImportCoupons Import coupons via CSV file +Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - * @param programID - * @param integrationID -@return apiRemoveLoyaltyPointsRequest + * @param applicationId + * @param campaignId +@return apiImportCouponsRequest */ -func (a *ManagementApiService) RemoveLoyaltyPoints(ctx _context.Context, programID string, integrationID string) apiRemoveLoyaltyPointsRequest { - return apiRemoveLoyaltyPointsRequest{ +func (a *ManagementApiService) ImportCoupons(ctx _context.Context, applicationId int32, campaignId int32) apiImportCouponsRequest { + return apiImportCouponsRequest{ apiService: a, ctx: ctx, - programID: programID, - integrationID: integrationID, + applicationId: applicationId, + campaignId: campaignId, } } /* Execute executes the request - + @return Import */ -func (r apiRemoveLoyaltyPointsRequest) Execute() (*_nethttp.Response, error) { +func (r apiImportCouponsRequest) Execute() (Import, *_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPut + localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte + localVarReturnValue Import ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.RemoveLoyaltyPoints") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportCoupons") if err != nil { - return nil, GenericOpenAPIError{error: err.Error()} + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points" - localVarPath = strings.Replace(localVarPath, "{"+"programID"+"}", _neturl.QueryEscape(parameterToString(r.programID, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"integrationID"+"}", _neturl.QueryEscape(parameterToString(r.integrationID, "")), -1) + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.body == nil { - return nil, reportError("body is required and must be specified") - } - // to determine the Content-Type header - localVarHTTPContentTypes := []string{"application/json"} + localVarHTTPContentTypes := []string{"multipart/form-data"} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -12148,15 +12155,16 @@ func (r apiRemoveLoyaltyPointsRequest) Execute() (*_nethttp.Response, error) { } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } - // body params - localVarPostBody = r.body + if r.upFile != nil { + localVarFormParams.Add("upFile", parameterToString(*r.upFile, "")) + } if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -12173,18 +12181,18 @@ func (r apiRemoveLoyaltyPointsRequest) Execute() (*_nethttp.Response, error) { } req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) if err != nil { - return nil, err + return localVarReturnValue, nil, err } localVarHTTPResponse, err := r.apiService.client.callAPI(req) if err != nil || localVarHTTPResponse == nil { - return localVarHTTPResponse, err + return localVarReturnValue, localVarHTTPResponse, err } localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) localVarHTTPResponse.Body.Close() if err != nil { - return localVarHTTPResponse, err + return localVarReturnValue, localVarHTTPResponse, err } if localVarHTTPResponse.StatusCode >= 300 { @@ -12192,53 +12200,615 @@ func (r apiRemoveLoyaltyPointsRequest) Execute() (*_nethttp.Response, error) { body: localVarBody, error: localVarHTTPResponse.Status, } - return localVarHTTPResponse, newErr + if localVarHTTPResponse.StatusCode == 200 { + var v Import + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr } - return localVarHTTPResponse, nil + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil } -type apiResetPasswordRequest struct { +type apiImportLoyaltyPointsRequest struct { ctx _context.Context apiService *ManagementApiService - body *NewPassword + programID int32 + upFile *string } -func (r apiResetPasswordRequest) Body(body NewPassword) apiResetPasswordRequest { - r.body = &body +func (r apiImportLoyaltyPointsRequest) UpFile(upFile string) apiImportLoyaltyPointsRequest { + r.upFile = &upFile return r } /* -ResetPassword Reset password -Consumes the supplied password reset token and updates the password for -the associated account. - +ImportLoyaltyPoints Import loyalty points via CSV file +Upload a CSV file containing the loyalty points that should be created. The file should be sent as multipart data. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). -@return apiResetPasswordRequest + * @param programID +@return apiImportLoyaltyPointsRequest */ -func (a *ManagementApiService) ResetPassword(ctx _context.Context) apiResetPasswordRequest { - return apiResetPasswordRequest{ +func (a *ManagementApiService) ImportLoyaltyPoints(ctx _context.Context, programID int32) apiImportLoyaltyPointsRequest { + return apiImportLoyaltyPointsRequest{ apiService: a, ctx: ctx, + programID: programID, } } /* Execute executes the request - @return NewPassword + @return Import */ -func (r apiResetPasswordRequest) Execute() (NewPassword, *_nethttp.Response, error) { +func (r apiImportLoyaltyPointsRequest) Execute() (Import, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue NewPassword + localVarReturnValue Import ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ResetPassword") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportLoyaltyPoints") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{programID}/import_points" + localVarPath = strings.Replace(localVarPath, "{"+"programID"+"}", _neturl.QueryEscape(parameterToString(r.programID, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"multipart/form-data"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.upFile != nil { + localVarFormParams.Add("upFile", parameterToString(*r.upFile, "")) + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v Import + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + 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 apiImportPoolGiveawaysRequest struct { + ctx _context.Context + apiService *ManagementApiService + poolId int32 + upFile *string +} + +func (r apiImportPoolGiveawaysRequest) UpFile(upFile string) apiImportPoolGiveawaysRequest { + r.upFile = &upFile + return r +} + +/* +ImportPoolGiveaways Import giveaways codes into a giveaways pool +Upload a CSV file containing the giveaways codes that should be created. Send the file as multipart data. + +The CSV file can contain the following columns: +- `code` (required): the code of your giveaway, for instance, a gift card redemption code. +- `startdate`: the start date in RFC3339 of the code redemption period. +- `enddate`: the last date in RFC3339 of the code redemption period. +- `attributes`: A json object describing _custom_ giveaways attribute names and their values. Double the double-quotes in the object. + For example, if you created a custom attribute called `provider`, set it with `"{""provider"": ""myPartnerCompany""}"`. + +The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. +You can use the timezone of your choice. It is converted to UTC internally by Talon.One. + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param poolId +@return apiImportPoolGiveawaysRequest +*/ +func (a *ManagementApiService) ImportPoolGiveaways(ctx _context.Context, poolId int32) apiImportPoolGiveawaysRequest { + return apiImportPoolGiveawaysRequest{ + apiService: a, + ctx: ctx, + poolId: poolId, + } +} + +/* +Execute executes the request + @return Import +*/ +func (r apiImportPoolGiveawaysRequest) Execute() (Import, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Import + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportPoolGiveaways") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/giveaways/pools/{poolId}/import" + localVarPath = strings.Replace(localVarPath, "{"+"poolId"+"}", _neturl.QueryEscape(parameterToString(r.poolId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"multipart/form-data"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.upFile != nil { + localVarFormParams.Add("upFile", parameterToString(*r.upFile, "")) + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v Import + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + 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 apiImportReferralsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + upFile *string +} + +func (r apiImportReferralsRequest) UpFile(upFile string) apiImportReferralsRequest { + r.upFile = &upFile + return r +} + +/* +ImportReferrals Import referrals via CSV file +Upload a CSV file containing the referrals that should be created. +The file should be sent as multipart data. + +The CSV file can contain the following colums: + +- `code` (required): the referral code. +- `advocateprofileintegrationid` (required): The profile ID of the advocate. +- `startdate`: the start date in RFC3339 of the code redemption period. +- `expirydate`: the end date in RFC3339 of the code redemption period. +- `limitval`: The maximum amount of redemptions of this code. Unlimited (0) when blank. +- `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. + For example, if you created a custom attribute called `category`, set it with `"{""category"": ""10_off""}"`. + +You can use the timezone of your choice. It is converted to UTC internally by Talon.One. + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param applicationId + * @param campaignId +@return apiImportReferralsRequest +*/ +func (a *ManagementApiService) ImportReferrals(ctx _context.Context, applicationId int32, campaignId int32) apiImportReferralsRequest { + return apiImportReferralsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + } +} + +/* +Execute executes the request + @return Import +*/ +func (r apiImportReferralsRequest) Execute() (Import, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Import + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportReferrals") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"multipart/form-data"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.upFile != nil { + localVarFormParams.Add("upFile", parameterToString(*r.upFile, "")) + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v Import + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + 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 apiRemoveLoyaltyPointsRequest struct { + ctx _context.Context + apiService *ManagementApiService + programID string + integrationID string + body *LoyaltyPoints +} + +func (r apiRemoveLoyaltyPointsRequest) Body(body LoyaltyPoints) apiRemoveLoyaltyPointsRequest { + r.body = &body + return r +} + +/* +RemoveLoyaltyPoints Deduct points in a certain loyalty program for the specified customer + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param programID + * @param integrationID +@return apiRemoveLoyaltyPointsRequest +*/ +func (a *ManagementApiService) RemoveLoyaltyPoints(ctx _context.Context, programID string, integrationID string) apiRemoveLoyaltyPointsRequest { + return apiRemoveLoyaltyPointsRequest{ + apiService: a, + ctx: ctx, + programID: programID, + integrationID: integrationID, + } +} + +/* +Execute executes the request + +*/ +func (r apiRemoveLoyaltyPointsRequest) Execute() (*_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPut + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.RemoveLoyaltyPoints") + if err != nil { + return nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points" + localVarPath = strings.Replace(localVarPath, "{"+"programID"+"}", _neturl.QueryEscape(parameterToString(r.programID, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"integrationID"+"}", _neturl.QueryEscape(parameterToString(r.integrationID, "")), -1) + + 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 apiResetPasswordRequest struct { + ctx _context.Context + apiService *ManagementApiService + body *NewPassword +} + +func (r apiResetPasswordRequest) Body(body NewPassword) apiResetPasswordRequest { + r.body = &body + return r +} + +/* +ResetPassword Reset password +Consumes the supplied password reset token and updates the password for +the associated account. + + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return apiResetPasswordRequest +*/ +func (a *ManagementApiService) ResetPassword(ctx _context.Context) apiResetPasswordRequest { + return apiResetPasswordRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + @return NewPassword +*/ +func (r apiResetPasswordRequest) Execute() (NewPassword, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue NewPassword + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ResetPassword") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } @@ -14006,6 +14576,148 @@ func (r apiUpdateCouponBatchRequest) Execute() (*_nethttp.Response, error) { return localVarHTTPResponse, nil } +type apiUpdateReferralRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + referralId string + body *UpdateReferral +} + +func (r apiUpdateReferralRequest) Body(body UpdateReferral) apiUpdateReferralRequest { + r.body = &body + return r +} + +/* +UpdateReferral Update one Referral + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param applicationId + * @param campaignId + * @param referralId The ID of the referral code to delete +@return apiUpdateReferralRequest +*/ +func (a *ManagementApiService) UpdateReferral(ctx _context.Context, applicationId int32, campaignId int32, referralId string) apiUpdateReferralRequest { + return apiUpdateReferralRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + referralId: referralId, + } +} + +/* +Execute executes the request + @return Referral +*/ +func (r apiUpdateReferralRequest) Execute() (Referral, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPut + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Referral + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.UpdateReferral") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId}" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"referralId"+"}", _neturl.QueryEscape(parameterToString(r.referralId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v Referral + 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 apiUpdateRulesetRequest struct { ctx _context.Context apiService *ManagementApiService diff --git a/configuration.go b/configuration.go index 80e20ae5..ed7616d9 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.3.0/go", + UserAgent: "OpenAPI-Generator/2.4.0/go", Debug: false, Servers: ServerConfigurations{ { diff --git a/docs/ApplicationCampaignStats.md b/docs/ApplicationCampaignStats.md new file mode 100644 index 00000000..818b9b18 --- /dev/null +++ b/docs/ApplicationCampaignStats.md @@ -0,0 +1,169 @@ +# ApplicationCampaignStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Draft** | Pointer to **int32** | Number of draft campaigns | +**Disabled** | Pointer to **int32** | Number of disabled campaigns | +**Scheduled** | Pointer to **int32** | Number of scheduled campaigns | +**Running** | Pointer to **int32** | Number of running campaigns | +**Expired** | Pointer to **int32** | Number of expired campaigns | +**Archived** | Pointer to **int32** | Number of archived campaigns | + +## Methods + +### GetDraft + +`func (o *ApplicationCampaignStats) GetDraft() int32` + +GetDraft returns the Draft field if non-nil, zero value otherwise. + +### GetDraftOk + +`func (o *ApplicationCampaignStats) GetDraftOk() (int32, bool)` + +GetDraftOk returns a tuple with the Draft field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDraft + +`func (o *ApplicationCampaignStats) HasDraft() bool` + +HasDraft returns a boolean if a field has been set. + +### SetDraft + +`func (o *ApplicationCampaignStats) SetDraft(v int32)` + +SetDraft gets a reference to the given int32 and assigns it to the Draft field. + +### GetDisabled + +`func (o *ApplicationCampaignStats) GetDisabled() int32` + +GetDisabled returns the Disabled field if non-nil, zero value otherwise. + +### GetDisabledOk + +`func (o *ApplicationCampaignStats) GetDisabledOk() (int32, bool)` + +GetDisabledOk returns a tuple with the Disabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDisabled + +`func (o *ApplicationCampaignStats) HasDisabled() bool` + +HasDisabled returns a boolean if a field has been set. + +### SetDisabled + +`func (o *ApplicationCampaignStats) SetDisabled(v int32)` + +SetDisabled gets a reference to the given int32 and assigns it to the Disabled field. + +### GetScheduled + +`func (o *ApplicationCampaignStats) GetScheduled() int32` + +GetScheduled returns the Scheduled field if non-nil, zero value otherwise. + +### GetScheduledOk + +`func (o *ApplicationCampaignStats) GetScheduledOk() (int32, bool)` + +GetScheduledOk returns a tuple with the Scheduled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasScheduled + +`func (o *ApplicationCampaignStats) HasScheduled() bool` + +HasScheduled returns a boolean if a field has been set. + +### SetScheduled + +`func (o *ApplicationCampaignStats) SetScheduled(v int32)` + +SetScheduled gets a reference to the given int32 and assigns it to the Scheduled field. + +### GetRunning + +`func (o *ApplicationCampaignStats) GetRunning() int32` + +GetRunning returns the Running field if non-nil, zero value otherwise. + +### GetRunningOk + +`func (o *ApplicationCampaignStats) GetRunningOk() (int32, bool)` + +GetRunningOk returns a tuple with the Running field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRunning + +`func (o *ApplicationCampaignStats) HasRunning() bool` + +HasRunning returns a boolean if a field has been set. + +### SetRunning + +`func (o *ApplicationCampaignStats) SetRunning(v int32)` + +SetRunning gets a reference to the given int32 and assigns it to the Running field. + +### GetExpired + +`func (o *ApplicationCampaignStats) GetExpired() int32` + +GetExpired returns the Expired field if non-nil, zero value otherwise. + +### GetExpiredOk + +`func (o *ApplicationCampaignStats) GetExpiredOk() (int32, bool)` + +GetExpiredOk returns a tuple with the Expired field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpired + +`func (o *ApplicationCampaignStats) HasExpired() bool` + +HasExpired returns a boolean if a field has been set. + +### SetExpired + +`func (o *ApplicationCampaignStats) SetExpired(v int32)` + +SetExpired gets a reference to the given int32 and assigns it to the Expired field. + +### GetArchived + +`func (o *ApplicationCampaignStats) GetArchived() int32` + +GetArchived returns the Archived field if non-nil, zero value otherwise. + +### GetArchivedOk + +`func (o *ApplicationCampaignStats) GetArchivedOk() (int32, bool)` + +GetArchivedOk returns a tuple with the Archived field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasArchived + +`func (o *ApplicationCampaignStats) HasArchived() bool` + +HasArchived returns a boolean if a field has been set. + +### SetArchived + +`func (o *ApplicationCampaignStats) SetArchived(v int32)` + +SetArchived gets a reference to the given int32 and assigns it to the Archived field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ApplicationReferee.md b/docs/ApplicationReferee.md new file mode 100644 index 00000000..15394477 --- /dev/null +++ b/docs/ApplicationReferee.md @@ -0,0 +1,169 @@ +# ApplicationReferee + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | +**SessionId** | Pointer to **string** | Integration ID of the session in which the customer redeemed the referral | +**AdvocateIntegrationId** | Pointer to **string** | Integration ID of the Advocate's Profile | +**FriendIntegrationId** | Pointer to **string** | Integration ID of the Friend's Profile | +**Code** | Pointer to **string** | Advocate's referral code. | +**Created** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the moment the customer redeemed the referral | + +## Methods + +### GetApplicationId + +`func (o *ApplicationReferee) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *ApplicationReferee) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *ApplicationReferee) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *ApplicationReferee) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + +### GetSessionId + +`func (o *ApplicationReferee) GetSessionId() string` + +GetSessionId returns the SessionId field if non-nil, zero value otherwise. + +### GetSessionIdOk + +`func (o *ApplicationReferee) GetSessionIdOk() (string, bool)` + +GetSessionIdOk returns a tuple with the SessionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSessionId + +`func (o *ApplicationReferee) HasSessionId() bool` + +HasSessionId returns a boolean if a field has been set. + +### SetSessionId + +`func (o *ApplicationReferee) SetSessionId(v string)` + +SetSessionId gets a reference to the given string and assigns it to the SessionId field. + +### GetAdvocateIntegrationId + +`func (o *ApplicationReferee) GetAdvocateIntegrationId() string` + +GetAdvocateIntegrationId returns the AdvocateIntegrationId field if non-nil, zero value otherwise. + +### GetAdvocateIntegrationIdOk + +`func (o *ApplicationReferee) GetAdvocateIntegrationIdOk() (string, bool)` + +GetAdvocateIntegrationIdOk returns a tuple with the AdvocateIntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAdvocateIntegrationId + +`func (o *ApplicationReferee) HasAdvocateIntegrationId() bool` + +HasAdvocateIntegrationId returns a boolean if a field has been set. + +### SetAdvocateIntegrationId + +`func (o *ApplicationReferee) SetAdvocateIntegrationId(v string)` + +SetAdvocateIntegrationId gets a reference to the given string and assigns it to the AdvocateIntegrationId field. + +### GetFriendIntegrationId + +`func (o *ApplicationReferee) GetFriendIntegrationId() string` + +GetFriendIntegrationId returns the FriendIntegrationId field if non-nil, zero value otherwise. + +### GetFriendIntegrationIdOk + +`func (o *ApplicationReferee) GetFriendIntegrationIdOk() (string, bool)` + +GetFriendIntegrationIdOk returns a tuple with the FriendIntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasFriendIntegrationId + +`func (o *ApplicationReferee) HasFriendIntegrationId() bool` + +HasFriendIntegrationId returns a boolean if a field has been set. + +### SetFriendIntegrationId + +`func (o *ApplicationReferee) SetFriendIntegrationId(v string)` + +SetFriendIntegrationId gets a reference to the given string and assigns it to the FriendIntegrationId field. + +### GetCode + +`func (o *ApplicationReferee) GetCode() string` + +GetCode returns the Code field if non-nil, zero value otherwise. + +### GetCodeOk + +`func (o *ApplicationReferee) GetCodeOk() (string, bool)` + +GetCodeOk returns a tuple with the Code field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCode + +`func (o *ApplicationReferee) HasCode() bool` + +HasCode returns a boolean if a field has been set. + +### SetCode + +`func (o *ApplicationReferee) SetCode(v string)` + +SetCode gets a reference to the given string and assigns it to the Code field. + +### GetCreated + +`func (o *ApplicationReferee) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ApplicationReferee) 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 *ApplicationReferee) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *ApplicationReferee) 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/AwardGiveawayEffectProps.md b/docs/AwardGiveawayEffectProps.md new file mode 100644 index 00000000..d94f2d85 --- /dev/null +++ b/docs/AwardGiveawayEffectProps.md @@ -0,0 +1,143 @@ +# AwardGiveawayEffectProps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PoolId** | Pointer to **int32** | The ID of the giveaways pool the code was taken from. | +**PoolName** | Pointer to **string** | The name of the giveaways pool the code was taken from. | +**RecipientIntegrationId** | Pointer to **string** | The integration ID of the profile that was awarded the giveaway. | +**GiveawayId** | Pointer to **int32** | The internal ID for the giveaway that was awarded. | +**Code** | Pointer to **string** | The giveaway code that was awarded. | + +## Methods + +### GetPoolId + +`func (o *AwardGiveawayEffectProps) GetPoolId() int32` + +GetPoolId returns the PoolId field if non-nil, zero value otherwise. + +### GetPoolIdOk + +`func (o *AwardGiveawayEffectProps) GetPoolIdOk() (int32, bool)` + +GetPoolIdOk returns a tuple with the PoolId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPoolId + +`func (o *AwardGiveawayEffectProps) HasPoolId() bool` + +HasPoolId returns a boolean if a field has been set. + +### SetPoolId + +`func (o *AwardGiveawayEffectProps) SetPoolId(v int32)` + +SetPoolId gets a reference to the given int32 and assigns it to the PoolId field. + +### GetPoolName + +`func (o *AwardGiveawayEffectProps) GetPoolName() string` + +GetPoolName returns the PoolName field if non-nil, zero value otherwise. + +### GetPoolNameOk + +`func (o *AwardGiveawayEffectProps) GetPoolNameOk() (string, bool)` + +GetPoolNameOk returns a tuple with the PoolName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPoolName + +`func (o *AwardGiveawayEffectProps) HasPoolName() bool` + +HasPoolName returns a boolean if a field has been set. + +### SetPoolName + +`func (o *AwardGiveawayEffectProps) SetPoolName(v string)` + +SetPoolName gets a reference to the given string and assigns it to the PoolName field. + +### GetRecipientIntegrationId + +`func (o *AwardGiveawayEffectProps) GetRecipientIntegrationId() string` + +GetRecipientIntegrationId returns the RecipientIntegrationId field if non-nil, zero value otherwise. + +### GetRecipientIntegrationIdOk + +`func (o *AwardGiveawayEffectProps) GetRecipientIntegrationIdOk() (string, bool)` + +GetRecipientIntegrationIdOk returns a tuple with the RecipientIntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRecipientIntegrationId + +`func (o *AwardGiveawayEffectProps) HasRecipientIntegrationId() bool` + +HasRecipientIntegrationId returns a boolean if a field has been set. + +### SetRecipientIntegrationId + +`func (o *AwardGiveawayEffectProps) SetRecipientIntegrationId(v string)` + +SetRecipientIntegrationId gets a reference to the given string and assigns it to the RecipientIntegrationId field. + +### GetGiveawayId + +`func (o *AwardGiveawayEffectProps) GetGiveawayId() int32` + +GetGiveawayId returns the GiveawayId field if non-nil, zero value otherwise. + +### GetGiveawayIdOk + +`func (o *AwardGiveawayEffectProps) GetGiveawayIdOk() (int32, bool)` + +GetGiveawayIdOk returns a tuple with the GiveawayId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasGiveawayId + +`func (o *AwardGiveawayEffectProps) HasGiveawayId() bool` + +HasGiveawayId returns a boolean if a field has been set. + +### SetGiveawayId + +`func (o *AwardGiveawayEffectProps) SetGiveawayId(v int32)` + +SetGiveawayId gets a reference to the given int32 and assigns it to the GiveawayId field. + +### GetCode + +`func (o *AwardGiveawayEffectProps) GetCode() string` + +GetCode returns the Code field if non-nil, zero value otherwise. + +### GetCodeOk + +`func (o *AwardGiveawayEffectProps) GetCodeOk() (string, bool)` + +GetCodeOk returns a tuple with the Code field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCode + +`func (o *AwardGiveawayEffectProps) HasCode() bool` + +HasCode returns a boolean if a field has been set. + +### SetCode + +`func (o *AwardGiveawayEffectProps) SetCode(v string)` + +SetCode gets a reference to the given string and assigns it to the Code field. + + +[[Back to Model list]](../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 e36a7d10..bc560f0b 100644 --- a/docs/Campaign.md +++ b/docs/Campaign.md @@ -27,6 +27,7 @@ Name | Type | Description | Notes **DiscountEffectCount** | Pointer to **int32** | Total number of times discounts were redeemed in this campaign. | [optional] **CouponCreationCount** | Pointer to **int32** | Total number of coupons created by rules in this campaign. | [optional] **ReferralCreationCount** | Pointer to **int32** | Total number of referrals created by rules in this campaign. | [optional] +**AwardedGiveawaysCount** | Pointer to **int32** | Total number of giveaways awarded by rules in this campaign. | [optional] **CreatedLoyaltyPointsCount** | Pointer to **float32** | Total number of loyalty points created by rules in this campaign. | [optional] **CreatedLoyaltyPointsEffectCount** | Pointer to **int32** | Total number of loyalty point creation effects triggered by rules in this campaign. | [optional] **RedeemedLoyaltyPointsCount** | Pointer to **float32** | Total number of loyalty points redeemed by rules in this campaign. | [optional] @@ -613,6 +614,31 @@ HasReferralCreationCount returns a boolean if a field has been set. SetReferralCreationCount gets a reference to the given int32 and assigns it to the ReferralCreationCount field. +### GetAwardedGiveawaysCount + +`func (o *Campaign) GetAwardedGiveawaysCount() int32` + +GetAwardedGiveawaysCount returns the AwardedGiveawaysCount field if non-nil, zero value otherwise. + +### GetAwardedGiveawaysCountOk + +`func (o *Campaign) GetAwardedGiveawaysCountOk() (int32, bool)` + +GetAwardedGiveawaysCountOk returns a tuple with the AwardedGiveawaysCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAwardedGiveawaysCount + +`func (o *Campaign) HasAwardedGiveawaysCount() bool` + +HasAwardedGiveawaysCount returns a boolean if a field has been set. + +### SetAwardedGiveawaysCount + +`func (o *Campaign) SetAwardedGiveawaysCount(v int32)` + +SetAwardedGiveawaysCount gets a reference to the given int32 and assigns it to the AwardedGiveawaysCount field. + ### GetCreatedLoyaltyPointsCount `func (o *Campaign) GetCreatedLoyaltyPointsCount() float32` diff --git a/docs/Coupon.md b/docs/Coupon.md index 9e3409d2..7e6e8c1b 100644 --- a/docs/Coupon.md +++ b/docs/Coupon.md @@ -19,7 +19,7 @@ Name | Type | Description | Notes **ReferralId** | Pointer to **int32** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional] **RecipientIntegrationId** | Pointer to **string** | The Integration ID of the customer that is allowed to redeem this coupon. | [optional] **ImportId** | Pointer to **int32** | The ID of the Import which created this coupon. | [optional] -**Reservation** | Pointer to **bool** | This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favourite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. | [optional] +**Reservation** | Pointer to **bool** | This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favorite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. | [optional] **BatchId** | Pointer to **string** | The id of the batch the coupon belongs to. | [optional] ## Methods diff --git a/docs/CustomEffect.md b/docs/CustomEffect.md new file mode 100644 index 00000000..8e82cd80 --- /dev/null +++ b/docs/CustomEffect.md @@ -0,0 +1,351 @@ +# CustomEffect + +## 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. | +**AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | +**Modified** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was last modified. | +**Name** | Pointer to **string** | The name of this effect. | +**Title** | Pointer to **string** | The title of this effect. | +**Payload** | Pointer to **string** | The JSON payload of this effect. | +**Description** | Pointer to **string** | The description of this effect. | [optional] +**Enabled** | Pointer to **bool** | Determines if this effect is active. | +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this effect is enabled for | [optional] +**Params** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | Array of template argument definitions | [optional] +**ModifiedBy** | Pointer to **int32** | ID of the user who last updated this effect if available. | [optional] +**CreatedBy** | Pointer to **int32** | ID of the user who created this effect. | + +## Methods + +### GetId + +`func (o *CustomEffect) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CustomEffect) 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 *CustomEffect) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *CustomEffect) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *CustomEffect) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CustomEffect) 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 *CustomEffect) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *CustomEffect) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetAccountId + +`func (o *CustomEffect) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *CustomEffect) 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 *CustomEffect) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *CustomEffect) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetModified + +`func (o *CustomEffect) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *CustomEffect) 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 *CustomEffect) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *CustomEffect) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + +### GetName + +`func (o *CustomEffect) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CustomEffect) 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 *CustomEffect) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *CustomEffect) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetTitle + +`func (o *CustomEffect) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *CustomEffect) 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 *CustomEffect) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitle + +`func (o *CustomEffect) SetTitle(v string)` + +SetTitle gets a reference to the given string and assigns it to the Title field. + +### GetPayload + +`func (o *CustomEffect) GetPayload() string` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *CustomEffect) GetPayloadOk() (string, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPayload + +`func (o *CustomEffect) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + +### SetPayload + +`func (o *CustomEffect) SetPayload(v string)` + +SetPayload gets a reference to the given string and assigns it to the Payload field. + +### GetDescription + +`func (o *CustomEffect) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *CustomEffect) 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 *CustomEffect) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *CustomEffect) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetEnabled + +`func (o *CustomEffect) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *CustomEffect) GetEnabledOk() (bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnabled + +`func (o *CustomEffect) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### SetEnabled + +`func (o *CustomEffect) SetEnabled(v bool)` + +SetEnabled gets a reference to the given bool and assigns it to the Enabled field. + +### GetSubscribedApplicationsIds + +`func (o *CustomEffect) GetSubscribedApplicationsIds() []int32` + +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. + +### GetSubscribedApplicationsIdsOk + +`func (o *CustomEffect) 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 *CustomEffect) HasSubscribedApplicationsIds() bool` + +HasSubscribedApplicationsIds returns a boolean if a field has been set. + +### SetSubscribedApplicationsIds + +`func (o *CustomEffect) SetSubscribedApplicationsIds(v []int32)` + +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. + +### GetParams + +`func (o *CustomEffect) GetParams() []TemplateArgDef` + +GetParams returns the Params field if non-nil, zero value otherwise. + +### GetParamsOk + +`func (o *CustomEffect) GetParamsOk() ([]TemplateArgDef, bool)` + +GetParamsOk returns a tuple with the Params field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasParams + +`func (o *CustomEffect) HasParams() bool` + +HasParams returns a boolean if a field has been set. + +### SetParams + +`func (o *CustomEffect) SetParams(v []TemplateArgDef)` + +SetParams gets a reference to the given []TemplateArgDef and assigns it to the Params field. + +### GetModifiedBy + +`func (o *CustomEffect) GetModifiedBy() int32` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *CustomEffect) GetModifiedByOk() (int32, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModifiedBy + +`func (o *CustomEffect) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### SetModifiedBy + +`func (o *CustomEffect) SetModifiedBy(v int32)` + +SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. + +### GetCreatedBy + +`func (o *CustomEffect) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *CustomEffect) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *CustomEffect) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *CustomEffect) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CustomEffectProps.md b/docs/CustomEffectProps.md new file mode 100644 index 00000000..bd16d7fc --- /dev/null +++ b/docs/CustomEffectProps.md @@ -0,0 +1,65 @@ +# CustomEffectProps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | The type of the custom effect. | +**Payload** | Pointer to [**map[string]interface{}**](.md) | The JSON payload of the custom effect. | + +## Methods + +### GetType + +`func (o *CustomEffectProps) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CustomEffectProps) 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 *CustomEffectProps) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *CustomEffectProps) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetPayload + +`func (o *CustomEffectProps) GetPayload() map[string]interface{}` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *CustomEffectProps) GetPayloadOk() (map[string]interface{}, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPayload + +`func (o *CustomEffectProps) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + +### SetPayload + +`func (o *CustomEffectProps) SetPayload(v map[string]interface{})` + +SetPayload gets a reference to the given map[string]interface{} and assigns it to the Payload field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CustomerInventory.md b/docs/CustomerInventory.md index 26b80e4d..03b8d4ad 100644 --- a/docs/CustomerInventory.md +++ b/docs/CustomerInventory.md @@ -7,7 +7,8 @@ Name | Type | Description | Notes **Profile** | Pointer to [**CustomerProfile**](CustomerProfile.md) | | [optional] **Loyalty** | Pointer to [**Loyalty**](Loyalty.md) | | [optional] **Referrals** | Pointer to [**[]Referral**](Referral.md) | | [optional] -**Coupons** | Pointer to [**[]Coupon**](Coupon.md) | | [optional] +**Coupons** | Pointer to [**[]InventoryCoupon**](InventoryCoupon.md) | | [optional] +**Giveaways** | Pointer to [**[]Giveaway**](Giveaway.md) | | [optional] ## Methods @@ -88,13 +89,13 @@ SetReferrals gets a reference to the given []Referral and assigns it to the Refe ### GetCoupons -`func (o *CustomerInventory) GetCoupons() []Coupon` +`func (o *CustomerInventory) GetCoupons() []InventoryCoupon` GetCoupons returns the Coupons field if non-nil, zero value otherwise. ### GetCouponsOk -`func (o *CustomerInventory) GetCouponsOk() ([]Coupon, bool)` +`func (o *CustomerInventory) GetCouponsOk() ([]InventoryCoupon, bool)` GetCouponsOk returns a tuple with the Coupons field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -107,9 +108,34 @@ HasCoupons returns a boolean if a field has been set. ### SetCoupons -`func (o *CustomerInventory) SetCoupons(v []Coupon)` +`func (o *CustomerInventory) SetCoupons(v []InventoryCoupon)` -SetCoupons gets a reference to the given []Coupon and assigns it to the Coupons field. +SetCoupons gets a reference to the given []InventoryCoupon and assigns it to the Coupons field. + +### GetGiveaways + +`func (o *CustomerInventory) GetGiveaways() []Giveaway` + +GetGiveaways returns the Giveaways field if non-nil, zero value otherwise. + +### GetGiveawaysOk + +`func (o *CustomerInventory) GetGiveawaysOk() ([]Giveaway, bool)` + +GetGiveawaysOk returns a tuple with the Giveaways field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasGiveaways + +`func (o *CustomerInventory) HasGiveaways() bool` + +HasGiveaways returns a boolean if a field has been set. + +### SetGiveaways + +`func (o *CustomerInventory) SetGiveaways(v []Giveaway)` + +SetGiveaways gets a reference to the given []Giveaway and assigns it to the Giveaways field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/CustomerProfileIntegrationRequestV2.md b/docs/CustomerProfileIntegrationRequestV2.md index 200d1e3b..8951f332 100644 --- a/docs/CustomerProfileIntegrationRequestV2.md +++ b/docs/CustomerProfileIntegrationRequestV2.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] **AudiencesChanges** | Pointer to [**ProfileAudiencesChanges**](ProfileAudiencesChanges.md) | | [optional] -**ResponseContent** | Pointer to **[]string** | Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\", \"event\" and \"ruleFailureReasons\". | [optional] +**ResponseContent** | Pointer to **[]string** | Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\", \"event\", \"awardedGiveaways\", \"ruleFailureReasons\". | [optional] ## Methods diff --git a/docs/Environment.md b/docs/Environment.md index 449a8523..b2e736eb 100644 --- a/docs/Environment.md +++ b/docs/Environment.md @@ -10,6 +10,11 @@ Name | Type | Description | Notes **Slots** | Pointer to [**[]SlotDef**](SlotDef.md) | The slots defined for this application. | **Functions** | Pointer to [**[]FunctionDef**](FunctionDef.md) | The functions defined for this application. | **Templates** | Pointer to [**[]TemplateDef**](TemplateDef.md) | The templates defined for this application. | +**GiveawaysPools** | Pointer to [**[]GiveawaysPool**](GiveawaysPool.md) | The giveaways pools that the application is subscribed to. | [optional] +**LoyaltyPrograms** | Pointer to [**[]LoyaltyProgram**](LoyaltyProgram.md) | The loyalty programs that the application is subscribed to. | [optional] +**Attributes** | Pointer to [**[]Attribute**](Attribute.md) | The attributes that the application is subscribed to. | [optional] +**AdditionalCosts** | Pointer to [**[]AccountAdditionalCost**](AccountAdditionalCost.md) | The additional costs that the application is subscribed to. | [optional] +**Audiences** | Pointer to [**[]Audience**](Audience.md) | The audiences contained in the account which the application belongs to. | [optional] **Variables** | Pointer to **string** | | ## Methods @@ -164,6 +169,131 @@ HasTemplates returns a boolean if a field has been set. SetTemplates gets a reference to the given []TemplateDef and assigns it to the Templates field. +### GetGiveawaysPools + +`func (o *Environment) GetGiveawaysPools() []GiveawaysPool` + +GetGiveawaysPools returns the GiveawaysPools field if non-nil, zero value otherwise. + +### GetGiveawaysPoolsOk + +`func (o *Environment) GetGiveawaysPoolsOk() ([]GiveawaysPool, bool)` + +GetGiveawaysPoolsOk returns a tuple with the GiveawaysPools field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasGiveawaysPools + +`func (o *Environment) HasGiveawaysPools() bool` + +HasGiveawaysPools returns a boolean if a field has been set. + +### SetGiveawaysPools + +`func (o *Environment) SetGiveawaysPools(v []GiveawaysPool)` + +SetGiveawaysPools gets a reference to the given []GiveawaysPool and assigns it to the GiveawaysPools field. + +### GetLoyaltyPrograms + +`func (o *Environment) GetLoyaltyPrograms() []LoyaltyProgram` + +GetLoyaltyPrograms returns the LoyaltyPrograms field if non-nil, zero value otherwise. + +### GetLoyaltyProgramsOk + +`func (o *Environment) GetLoyaltyProgramsOk() ([]LoyaltyProgram, bool)` + +GetLoyaltyProgramsOk returns a tuple with the LoyaltyPrograms field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLoyaltyPrograms + +`func (o *Environment) HasLoyaltyPrograms() bool` + +HasLoyaltyPrograms returns a boolean if a field has been set. + +### SetLoyaltyPrograms + +`func (o *Environment) SetLoyaltyPrograms(v []LoyaltyProgram)` + +SetLoyaltyPrograms gets a reference to the given []LoyaltyProgram and assigns it to the LoyaltyPrograms field. + +### GetAttributes + +`func (o *Environment) GetAttributes() []Attribute` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Environment) GetAttributesOk() ([]Attribute, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *Environment) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *Environment) SetAttributes(v []Attribute)` + +SetAttributes gets a reference to the given []Attribute and assigns it to the Attributes field. + +### GetAdditionalCosts + +`func (o *Environment) GetAdditionalCosts() []AccountAdditionalCost` + +GetAdditionalCosts returns the AdditionalCosts field if non-nil, zero value otherwise. + +### GetAdditionalCostsOk + +`func (o *Environment) GetAdditionalCostsOk() ([]AccountAdditionalCost, bool)` + +GetAdditionalCostsOk returns a tuple with the AdditionalCosts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAdditionalCosts + +`func (o *Environment) HasAdditionalCosts() bool` + +HasAdditionalCosts returns a boolean if a field has been set. + +### SetAdditionalCosts + +`func (o *Environment) SetAdditionalCosts(v []AccountAdditionalCost)` + +SetAdditionalCosts gets a reference to the given []AccountAdditionalCost and assigns it to the AdditionalCosts field. + +### GetAudiences + +`func (o *Environment) GetAudiences() []Audience` + +GetAudiences returns the Audiences field if non-nil, zero value otherwise. + +### GetAudiencesOk + +`func (o *Environment) GetAudiencesOk() ([]Audience, bool)` + +GetAudiencesOk returns a tuple with the Audiences field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAudiences + +`func (o *Environment) HasAudiences() bool` + +HasAudiences returns a boolean if a field has been set. + +### SetAudiences + +`func (o *Environment) SetAudiences(v []Audience)` + +SetAudiences gets a reference to the given []Audience and assigns it to the Audiences field. + ### GetVariables `func (o *Environment) GetVariables() string` diff --git a/docs/Giveaway.md b/docs/Giveaway.md new file mode 100644 index 00000000..9d49ee00 --- /dev/null +++ b/docs/Giveaway.md @@ -0,0 +1,247 @@ +# Giveaway + +## 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. | +**Code** | Pointer to **string** | The code value of this giveaway. | +**PoolId** | Pointer to **int32** | The ID of the pool to return giveaway codes from. | +**StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the giveaway becomes valid. | [optional] +**EndDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the giveaway becomes invalid. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this giveaway. | [optional] +**Used** | Pointer to **bool** | Flag indicating whether this giveaway code was given before. | [optional] +**ImportId** | Pointer to **int32** | The ID of the Import which created this giveaway. | [optional] + +## Methods + +### GetId + +`func (o *Giveaway) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Giveaway) 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 *Giveaway) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *Giveaway) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *Giveaway) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Giveaway) 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 *Giveaway) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *Giveaway) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetCode + +`func (o *Giveaway) GetCode() string` + +GetCode returns the Code field if non-nil, zero value otherwise. + +### GetCodeOk + +`func (o *Giveaway) GetCodeOk() (string, bool)` + +GetCodeOk returns a tuple with the Code field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCode + +`func (o *Giveaway) HasCode() bool` + +HasCode returns a boolean if a field has been set. + +### SetCode + +`func (o *Giveaway) SetCode(v string)` + +SetCode gets a reference to the given string and assigns it to the Code field. + +### GetPoolId + +`func (o *Giveaway) GetPoolId() int32` + +GetPoolId returns the PoolId field if non-nil, zero value otherwise. + +### GetPoolIdOk + +`func (o *Giveaway) GetPoolIdOk() (int32, bool)` + +GetPoolIdOk returns a tuple with the PoolId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPoolId + +`func (o *Giveaway) HasPoolId() bool` + +HasPoolId returns a boolean if a field has been set. + +### SetPoolId + +`func (o *Giveaway) SetPoolId(v int32)` + +SetPoolId gets a reference to the given int32 and assigns it to the PoolId field. + +### GetStartDate + +`func (o *Giveaway) GetStartDate() time.Time` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *Giveaway) 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 *Giveaway) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *Giveaway) SetStartDate(v time.Time)` + +SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. + +### GetEndDate + +`func (o *Giveaway) GetEndDate() time.Time` + +GetEndDate returns the EndDate field if non-nil, zero value otherwise. + +### GetEndDateOk + +`func (o *Giveaway) GetEndDateOk() (time.Time, bool)` + +GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEndDate + +`func (o *Giveaway) HasEndDate() bool` + +HasEndDate returns a boolean if a field has been set. + +### SetEndDate + +`func (o *Giveaway) SetEndDate(v time.Time)` + +SetEndDate gets a reference to the given time.Time and assigns it to the EndDate field. + +### GetAttributes + +`func (o *Giveaway) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *Giveaway) 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 *Giveaway) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *Giveaway) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + +### GetUsed + +`func (o *Giveaway) GetUsed() bool` + +GetUsed returns the Used field if non-nil, zero value otherwise. + +### GetUsedOk + +`func (o *Giveaway) GetUsedOk() (bool, bool)` + +GetUsedOk returns a tuple with the Used field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUsed + +`func (o *Giveaway) HasUsed() bool` + +HasUsed returns a boolean if a field has been set. + +### SetUsed + +`func (o *Giveaway) SetUsed(v bool)` + +SetUsed gets a reference to the given bool and assigns it to the Used field. + +### GetImportId + +`func (o *Giveaway) GetImportId() int32` + +GetImportId returns the ImportId field if non-nil, zero value otherwise. + +### GetImportIdOk + +`func (o *Giveaway) GetImportIdOk() (int32, bool)` + +GetImportIdOk returns a tuple with the ImportId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasImportId + +`func (o *Giveaway) HasImportId() bool` + +HasImportId returns a boolean if a field has been set. + +### SetImportId + +`func (o *Giveaway) SetImportId(v int32)` + +SetImportId gets a reference to the given int32 and assigns it to the ImportId field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GiveawaysPool.md b/docs/GiveawaysPool.md new file mode 100644 index 00000000..2664a99f --- /dev/null +++ b/docs/GiveawaysPool.md @@ -0,0 +1,247 @@ +# GiveawaysPool + +## 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. | +**AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | +**Name** | Pointer to **string** | The name of this giveaways pool. | +**Description** | Pointer to **string** | The description of this giveaways pool. | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this giveaways pool is enabled for | [optional] +**Modified** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent update to the giveaways pool. | [optional] +**CreatedBy** | Pointer to **int32** | ID of the user who created this giveaways pool. | +**ModifiedBy** | Pointer to **int32** | ID of the user who last updated this giveaways pool if available. | [optional] + +## Methods + +### GetId + +`func (o *GiveawaysPool) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GiveawaysPool) 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 *GiveawaysPool) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *GiveawaysPool) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *GiveawaysPool) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *GiveawaysPool) 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 *GiveawaysPool) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *GiveawaysPool) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetAccountId + +`func (o *GiveawaysPool) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *GiveawaysPool) 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 *GiveawaysPool) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *GiveawaysPool) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetName + +`func (o *GiveawaysPool) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GiveawaysPool) 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 *GiveawaysPool) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *GiveawaysPool) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *GiveawaysPool) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *GiveawaysPool) 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 *GiveawaysPool) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *GiveawaysPool) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetSubscribedApplicationsIds + +`func (o *GiveawaysPool) GetSubscribedApplicationsIds() []int32` + +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. + +### GetSubscribedApplicationsIdsOk + +`func (o *GiveawaysPool) 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 *GiveawaysPool) HasSubscribedApplicationsIds() bool` + +HasSubscribedApplicationsIds returns a boolean if a field has been set. + +### SetSubscribedApplicationsIds + +`func (o *GiveawaysPool) SetSubscribedApplicationsIds(v []int32)` + +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. + +### GetModified + +`func (o *GiveawaysPool) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *GiveawaysPool) 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 *GiveawaysPool) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *GiveawaysPool) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + +### GetCreatedBy + +`func (o *GiveawaysPool) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *GiveawaysPool) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *GiveawaysPool) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *GiveawaysPool) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetModifiedBy + +`func (o *GiveawaysPool) GetModifiedBy() int32` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *GiveawaysPool) GetModifiedByOk() (int32, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModifiedBy + +`func (o *GiveawaysPool) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### SetModifiedBy + +`func (o *GiveawaysPool) SetModifiedBy(v int32)` + +SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ImportEntity.md b/docs/ImportEntity.md new file mode 100644 index 00000000..3f364869 --- /dev/null +++ b/docs/ImportEntity.md @@ -0,0 +1,39 @@ +# ImportEntity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ImportId** | Pointer to **int32** | The ID of the Import which created this referral. | [optional] + +## Methods + +### GetImportId + +`func (o *ImportEntity) GetImportId() int32` + +GetImportId returns the ImportId field if non-nil, zero value otherwise. + +### GetImportIdOk + +`func (o *ImportEntity) GetImportIdOk() (int32, bool)` + +GetImportIdOk returns a tuple with the ImportId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasImportId + +`func (o *ImportEntity) HasImportId() bool` + +HasImportId returns a boolean if a field has been set. + +### SetImportId + +`func (o *ImportEntity) SetImportId(v int32)` + +SetImportId gets a reference to the given int32 and assigns it to the ImportId field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse20010.md b/docs/InlineResponse20010.md index bc12877f..d7b0f2bc 100644 --- a/docs/InlineResponse20010.md +++ b/docs/InlineResponse20010.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]AccessLogEntry**](AccessLogEntry.md) | | +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]CampaignAnalytics**](CampaignAnalytics.md) | | ## Methods -### GetHasMore +### GetTotalResultSize -`func (o *InlineResponse20010) GetHasMore() bool` +`func (o *InlineResponse20010) GetTotalResultSize() int32` -GetHasMore returns the HasMore field if non-nil, zero value otherwise. +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. -### GetHasMoreOk +### GetTotalResultSizeOk -`func (o *InlineResponse20010) GetHasMoreOk() (bool, bool)` +`func (o *InlineResponse20010) GetTotalResultSizeOk() (int32, bool)` -GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasHasMore +### HasTotalResultSize -`func (o *InlineResponse20010) HasHasMore() bool` +`func (o *InlineResponse20010) HasTotalResultSize() bool` -HasHasMore returns a boolean if a field has been set. +HasTotalResultSize returns a boolean if a field has been set. -### SetHasMore +### SetTotalResultSize -`func (o *InlineResponse20010) SetHasMore(v bool)` +`func (o *InlineResponse20010) SetTotalResultSize(v int32)` -SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. ### GetData -`func (o *InlineResponse20010) GetData() []AccessLogEntry` +`func (o *InlineResponse20010) GetData() []CampaignAnalytics` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20010) GetDataOk() ([]AccessLogEntry, bool)` +`func (o *InlineResponse20010) GetDataOk() ([]CampaignAnalytics, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20010) SetData(v []AccessLogEntry)` +`func (o *InlineResponse20010) SetData(v []CampaignAnalytics)` -SetData gets a reference to the given []AccessLogEntry and assigns it to the Data field. +SetData gets a reference to the given []CampaignAnalytics and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20011.md b/docs/InlineResponse20011.md index 6c0d443e..c0888238 100644 --- a/docs/InlineResponse20011.md +++ b/docs/InlineResponse20011.md @@ -4,8 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]CampaignAnalytics**](CampaignAnalytics.md) | | +**TotalResultSize** | Pointer to **int32** | | [optional] +**HasMore** | Pointer to **bool** | | [optional] +**Data** | Pointer to [**[]ApplicationCustomer**](ApplicationCustomer.md) | | ## Methods @@ -34,15 +35,40 @@ 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 *InlineResponse20011) GetHasMore() bool` + +GetHasMore returns the HasMore field if non-nil, zero value otherwise. + +### GetHasMoreOk + +`func (o *InlineResponse20011) 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 *InlineResponse20011) HasHasMore() bool` + +HasHasMore returns a boolean if a field has been set. + +### SetHasMore + +`func (o *InlineResponse20011) SetHasMore(v bool)` + +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. + ### GetData -`func (o *InlineResponse20011) GetData() []CampaignAnalytics` +`func (o *InlineResponse20011) GetData() []ApplicationCustomer` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20011) GetDataOk() ([]CampaignAnalytics, bool)` +`func (o *InlineResponse20011) GetDataOk() ([]ApplicationCustomer, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +81,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20011) SetData(v []CampaignAnalytics)` +`func (o *InlineResponse20011) SetData(v []ApplicationCustomer)` -SetData gets a reference to the given []CampaignAnalytics and assigns it to the Data field. +SetData gets a reference to the given []ApplicationCustomer and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20012.md b/docs/InlineResponse20012.md index 78f24f53..45056849 100644 --- a/docs/InlineResponse20012.md +++ b/docs/InlineResponse20012.md @@ -4,37 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | [optional] -**HasMore** | Pointer to **bool** | | [optional] +**HasMore** | Pointer to **bool** | | **Data** | Pointer to [**[]ApplicationCustomer**](ApplicationCustomer.md) | | ## Methods -### GetTotalResultSize - -`func (o *InlineResponse20012) GetTotalResultSize() int32` - -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. - -### GetTotalResultSizeOk - -`func (o *InlineResponse20012) GetTotalResultSizeOk() (int32, bool)` - -GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTotalResultSize - -`func (o *InlineResponse20012) HasTotalResultSize() bool` - -HasTotalResultSize returns a boolean if a field has been set. - -### SetTotalResultSize - -`func (o *InlineResponse20012) SetTotalResultSize(v int32)` - -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. - ### GetHasMore `func (o *InlineResponse20012) GetHasMore() bool` diff --git a/docs/InlineResponse20013.md b/docs/InlineResponse20013.md index e7349b4f..1bdbd009 100644 --- a/docs/InlineResponse20013.md +++ b/docs/InlineResponse20013.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]ApplicationCustomer**](ApplicationCustomer.md) | | +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]CustomerActivityReport**](CustomerActivityReport.md) | | ## Methods -### GetHasMore +### GetTotalResultSize -`func (o *InlineResponse20013) GetHasMore() bool` +`func (o *InlineResponse20013) GetTotalResultSize() int32` -GetHasMore returns the HasMore field if non-nil, zero value otherwise. +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. -### GetHasMoreOk +### GetTotalResultSizeOk -`func (o *InlineResponse20013) GetHasMoreOk() (bool, bool)` +`func (o *InlineResponse20013) GetTotalResultSizeOk() (int32, bool)` -GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasHasMore +### HasTotalResultSize -`func (o *InlineResponse20013) HasHasMore() bool` +`func (o *InlineResponse20013) HasTotalResultSize() bool` -HasHasMore returns a boolean if a field has been set. +HasTotalResultSize returns a boolean if a field has been set. -### SetHasMore +### SetTotalResultSize -`func (o *InlineResponse20013) SetHasMore(v bool)` +`func (o *InlineResponse20013) SetTotalResultSize(v int32)` -SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. ### GetData -`func (o *InlineResponse20013) GetData() []ApplicationCustomer` +`func (o *InlineResponse20013) GetData() []CustomerActivityReport` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20013) GetDataOk() ([]ApplicationCustomer, bool)` +`func (o *InlineResponse20013) GetDataOk() ([]CustomerActivityReport, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20013) SetData(v []ApplicationCustomer)` +`func (o *InlineResponse20013) SetData(v []CustomerActivityReport)` -SetData gets a reference to the given []ApplicationCustomer and assigns it to the Data field. +SetData gets a reference to the given []CustomerActivityReport and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20014.md b/docs/InlineResponse20014.md index 92a4c9a5..884915a4 100644 --- a/docs/InlineResponse20014.md +++ b/docs/InlineResponse20014.md @@ -4,35 +4,35 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | +**HasMore** | Pointer to **bool** | | **Data** | Pointer to [**[]CustomerActivityReport**](CustomerActivityReport.md) | | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse20014) GetTotalResultSize() int32` +`func (o *InlineResponse20014) GetHasMore() bool` -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. +GetHasMore returns the HasMore field if non-nil, zero value otherwise. -### GetTotalResultSizeOk +### GetHasMoreOk -`func (o *InlineResponse20014) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse20014) GetHasMoreOk() (bool, bool)` -GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasTotalResultSize +### HasHasMore -`func (o *InlineResponse20014) HasTotalResultSize() bool` +`func (o *InlineResponse20014) HasHasMore() bool` -HasTotalResultSize returns a boolean if a field has been set. +HasHasMore returns a boolean if a field has been set. -### SetTotalResultSize +### SetHasMore -`func (o *InlineResponse20014) SetTotalResultSize(v int32)` +`func (o *InlineResponse20014) SetHasMore(v bool)` -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. ### GetData diff --git a/docs/InlineResponse20015.md b/docs/InlineResponse20015.md index 46efb9b5..c55565d4 100644 --- a/docs/InlineResponse20015.md +++ b/docs/InlineResponse20015.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]CustomerActivityReport**](CustomerActivityReport.md) | | +**HasMore** | Pointer to **bool** | | [optional] +**Data** | Pointer to [**[]ApplicationSession**](ApplicationSession.md) | | ## Methods @@ -36,13 +36,13 @@ SetHasMore gets a reference to the given bool and assigns it to the HasMore fiel ### GetData -`func (o *InlineResponse20015) GetData() []CustomerActivityReport` +`func (o *InlineResponse20015) GetData() []ApplicationSession` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20015) GetDataOk() ([]CustomerActivityReport, bool)` +`func (o *InlineResponse20015) GetDataOk() ([]ApplicationSession, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20015) SetData(v []CustomerActivityReport)` +`func (o *InlineResponse20015) SetData(v []ApplicationSession)` -SetData gets a reference to the given []CustomerActivityReport and assigns it to the Data field. +SetData gets a reference to the given []ApplicationSession and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20016.md b/docs/InlineResponse20016.md index 351936f1..f19346b0 100644 --- a/docs/InlineResponse20016.md +++ b/docs/InlineResponse20016.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | [optional] -**Data** | Pointer to [**[]ApplicationSession**](ApplicationSession.md) | | +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]ApplicationEvent**](ApplicationEvent.md) | | ## Methods -### GetHasMore +### GetTotalResultSize -`func (o *InlineResponse20016) GetHasMore() bool` +`func (o *InlineResponse20016) GetTotalResultSize() int32` -GetHasMore returns the HasMore field if non-nil, zero value otherwise. +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. -### GetHasMoreOk +### GetTotalResultSizeOk -`func (o *InlineResponse20016) GetHasMoreOk() (bool, bool)` +`func (o *InlineResponse20016) GetTotalResultSizeOk() (int32, bool)` -GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasHasMore +### HasTotalResultSize -`func (o *InlineResponse20016) HasHasMore() bool` +`func (o *InlineResponse20016) HasTotalResultSize() bool` -HasHasMore returns a boolean if a field has been set. +HasTotalResultSize returns a boolean if a field has been set. -### SetHasMore +### SetTotalResultSize -`func (o *InlineResponse20016) SetHasMore(v bool)` +`func (o *InlineResponse20016) SetTotalResultSize(v int32)` -SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. ### GetData -`func (o *InlineResponse20016) GetData() []ApplicationSession` +`func (o *InlineResponse20016) GetData() []ApplicationEvent` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20016) GetDataOk() ([]ApplicationSession, bool)` +`func (o *InlineResponse20016) GetDataOk() ([]ApplicationEvent, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20016) SetData(v []ApplicationSession)` +`func (o *InlineResponse20016) SetData(v []ApplicationEvent)` -SetData gets a reference to the given []ApplicationSession and assigns it to the Data field. +SetData gets a reference to the given []ApplicationEvent and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20017.md b/docs/InlineResponse20017.md index cf2f4108..f549ad3c 100644 --- a/docs/InlineResponse20017.md +++ b/docs/InlineResponse20017.md @@ -4,35 +4,35 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | +**HasMore** | Pointer to **bool** | | **Data** | Pointer to [**[]ApplicationEvent**](ApplicationEvent.md) | | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse20017) GetTotalResultSize() int32` +`func (o *InlineResponse20017) GetHasMore() bool` -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. +GetHasMore returns the HasMore field if non-nil, zero value otherwise. -### GetTotalResultSizeOk +### GetHasMoreOk -`func (o *InlineResponse20017) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse20017) GetHasMoreOk() (bool, bool)` -GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasTotalResultSize +### HasHasMore -`func (o *InlineResponse20017) HasTotalResultSize() bool` +`func (o *InlineResponse20017) HasHasMore() bool` -HasTotalResultSize returns a boolean if a field has been set. +HasHasMore returns a boolean if a field has been set. -### SetTotalResultSize +### SetHasMore -`func (o *InlineResponse20017) SetTotalResultSize(v int32)` +`func (o *InlineResponse20017) SetHasMore(v bool)` -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. ### GetData diff --git a/docs/InlineResponse20018.md b/docs/InlineResponse20018.md index 8b22d2ac..4a1ba50e 100644 --- a/docs/InlineResponse20018.md +++ b/docs/InlineResponse20018.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]ApplicationEvent**](ApplicationEvent.md) | | +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to **[]string** | | ## Methods -### GetHasMore +### GetTotalResultSize -`func (o *InlineResponse20018) GetHasMore() bool` +`func (o *InlineResponse20018) GetTotalResultSize() int32` -GetHasMore returns the HasMore field if non-nil, zero value otherwise. +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. -### GetHasMoreOk +### GetTotalResultSizeOk -`func (o *InlineResponse20018) GetHasMoreOk() (bool, bool)` +`func (o *InlineResponse20018) GetTotalResultSizeOk() (int32, bool)` -GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasHasMore +### HasTotalResultSize -`func (o *InlineResponse20018) HasHasMore() bool` +`func (o *InlineResponse20018) HasTotalResultSize() bool` -HasHasMore returns a boolean if a field has been set. +HasTotalResultSize returns a boolean if a field has been set. -### SetHasMore +### SetTotalResultSize -`func (o *InlineResponse20018) SetHasMore(v bool)` +`func (o *InlineResponse20018) SetTotalResultSize(v int32)` -SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. ### GetData -`func (o *InlineResponse20018) GetData() []ApplicationEvent` +`func (o *InlineResponse20018) GetData() []string` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20018) GetDataOk() ([]ApplicationEvent, bool)` +`func (o *InlineResponse20018) GetDataOk() ([]string, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20018) SetData(v []ApplicationEvent)` +`func (o *InlineResponse20018) SetData(v []string)` -SetData gets a reference to the given []ApplicationEvent and assigns it to the Data field. +SetData gets a reference to the given []string and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20019.md b/docs/InlineResponse20019.md index 82faa1c5..f1d6125a 100644 --- a/docs/InlineResponse20019.md +++ b/docs/InlineResponse20019.md @@ -4,11 +4,37 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to **[]string** | | +**HasMore** | Pointer to **bool** | | [optional] +**TotalResultSize** | Pointer to **int32** | | [optional] +**Data** | Pointer to [**[]Audience**](Audience.md) | | ## Methods +### GetHasMore + +`func (o *InlineResponse20019) GetHasMore() bool` + +GetHasMore returns the HasMore field if non-nil, zero value otherwise. + +### GetHasMoreOk + +`func (o *InlineResponse20019) 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 *InlineResponse20019) HasHasMore() bool` + +HasHasMore returns a boolean if a field has been set. + +### SetHasMore + +`func (o *InlineResponse20019) SetHasMore(v bool)` + +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. + ### GetTotalResultSize `func (o *InlineResponse20019) GetTotalResultSize() int32` @@ -36,13 +62,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20019) GetData() []string` +`func (o *InlineResponse20019) GetData() []Audience` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20019) GetDataOk() ([]string, bool)` +`func (o *InlineResponse20019) GetDataOk() ([]Audience, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +81,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20019) SetData(v []string)` +`func (o *InlineResponse20019) SetData(v []Audience)` -SetData gets a reference to the given []string and assigns it to the Data field. +SetData gets a reference to the given []Audience and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20020.md b/docs/InlineResponse20020.md index b65a134c..47408c04 100644 --- a/docs/InlineResponse20020.md +++ b/docs/InlineResponse20020.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | [optional] -**Data** | Pointer to [**[]Audience**](Audience.md) | | +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]Attribute**](Attribute.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20020) GetData() []Audience` +`func (o *InlineResponse20020) GetData() []Attribute` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20020) GetDataOk() ([]Audience, bool)` +`func (o *InlineResponse20020) GetDataOk() ([]Attribute, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20020) SetData(v []Audience)` +`func (o *InlineResponse20020) SetData(v []Attribute)` -SetData gets a reference to the given []Audience and assigns it to the Data field. +SetData gets a reference to the given []Attribute and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20021.md b/docs/InlineResponse20021.md index 99f02893..df277b47 100644 --- a/docs/InlineResponse20021.md +++ b/docs/InlineResponse20021.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Attribute**](Attribute.md) | | +**Data** | Pointer to [**[]AccountAdditionalCost**](AccountAdditionalCost.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20021) GetData() []Attribute` +`func (o *InlineResponse20021) GetData() []AccountAdditionalCost` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20021) GetDataOk() ([]Attribute, bool)` +`func (o *InlineResponse20021) GetDataOk() ([]AccountAdditionalCost, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20021) SetData(v []Attribute)` +`func (o *InlineResponse20021) SetData(v []AccountAdditionalCost)` -SetData gets a reference to the given []Attribute and assigns it to the Data field. +SetData gets a reference to the given []AccountAdditionalCost and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20022.md b/docs/InlineResponse20022.md index 4a7c2c19..a60e707f 100644 --- a/docs/InlineResponse20022.md +++ b/docs/InlineResponse20022.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]AccountAdditionalCost**](AccountAdditionalCost.md) | | +**Data** | Pointer to [**[]Webhook**](Webhook.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20022) GetData() []AccountAdditionalCost` +`func (o *InlineResponse20022) GetData() []Webhook` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20022) GetDataOk() ([]AccountAdditionalCost, bool)` +`func (o *InlineResponse20022) GetDataOk() ([]Webhook, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20022) SetData(v []AccountAdditionalCost)` +`func (o *InlineResponse20022) SetData(v []Webhook)` -SetData gets a reference to the given []AccountAdditionalCost and assigns it to the Data field. +SetData gets a reference to the given []Webhook and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20023.md b/docs/InlineResponse20023.md index 80403a45..93954623 100644 --- a/docs/InlineResponse20023.md +++ b/docs/InlineResponse20023.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Webhook**](Webhook.md) | | +**Data** | Pointer to [**[]WebhookActivationLogEntry**](WebhookActivationLogEntry.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20023) GetData() []Webhook` +`func (o *InlineResponse20023) GetData() []WebhookActivationLogEntry` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20023) GetDataOk() ([]Webhook, bool)` +`func (o *InlineResponse20023) GetDataOk() ([]WebhookActivationLogEntry, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20023) SetData(v []Webhook)` +`func (o *InlineResponse20023) SetData(v []WebhookActivationLogEntry)` -SetData gets a reference to the given []Webhook and assigns it to the Data field. +SetData gets a reference to the given []WebhookActivationLogEntry and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20024.md b/docs/InlineResponse20024.md index e184c8e8..c1cf6107 100644 --- a/docs/InlineResponse20024.md +++ b/docs/InlineResponse20024.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]WebhookActivationLogEntry**](WebhookActivationLogEntry.md) | | +**Data** | Pointer to [**[]WebhookLogEntry**](WebhookLogEntry.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20024) GetData() []WebhookActivationLogEntry` +`func (o *InlineResponse20024) GetData() []WebhookLogEntry` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20024) GetDataOk() ([]WebhookActivationLogEntry, bool)` +`func (o *InlineResponse20024) GetDataOk() ([]WebhookLogEntry, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20024) SetData(v []WebhookActivationLogEntry)` +`func (o *InlineResponse20024) SetData(v []WebhookLogEntry)` -SetData gets a reference to the given []WebhookActivationLogEntry and assigns it to the Data field. +SetData gets a reference to the given []WebhookLogEntry and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20025.md b/docs/InlineResponse20025.md index 60298cd6..f3f0b1dc 100644 --- a/docs/InlineResponse20025.md +++ b/docs/InlineResponse20025.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]WebhookLogEntry**](WebhookLogEntry.md) | | +**Data** | Pointer to [**[]EventType**](EventType.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20025) GetData() []WebhookLogEntry` +`func (o *InlineResponse20025) GetData() []EventType` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20025) GetDataOk() ([]WebhookLogEntry, bool)` +`func (o *InlineResponse20025) GetDataOk() ([]EventType, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20025) SetData(v []WebhookLogEntry)` +`func (o *InlineResponse20025) SetData(v []EventType)` -SetData gets a reference to the given []WebhookLogEntry and assigns it to the Data field. +SetData gets a reference to the given []EventType and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20026.md b/docs/InlineResponse20026.md index 0b654f82..032fe6fd 100644 --- a/docs/InlineResponse20026.md +++ b/docs/InlineResponse20026.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]EventType**](EventType.md) | | +**Data** | Pointer to [**[]User**](User.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20026) GetData() []EventType` +`func (o *InlineResponse20026) GetData() []User` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20026) GetDataOk() ([]EventType, bool)` +`func (o *InlineResponse20026) GetDataOk() ([]User, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20026) SetData(v []EventType)` +`func (o *InlineResponse20026) SetData(v []User)` -SetData gets a reference to the given []EventType and assigns it to the Data field. +SetData gets a reference to the given []User and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20027.md b/docs/InlineResponse20027.md index 18ad0187..005a3088 100644 --- a/docs/InlineResponse20027.md +++ b/docs/InlineResponse20027.md @@ -4,8 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]User**](User.md) | | +**TotalResultSize** | Pointer to **int32** | | [optional] +**HasMore** | Pointer to **bool** | | [optional] +**Data** | Pointer to [**[]Change**](Change.md) | | ## Methods @@ -34,15 +35,40 @@ HasTotalResultSize returns a boolean if a field has been set. SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +### GetHasMore + +`func (o *InlineResponse20027) GetHasMore() bool` + +GetHasMore returns the HasMore field if non-nil, zero value otherwise. + +### GetHasMoreOk + +`func (o *InlineResponse20027) GetHasMoreOk() (bool, bool)` + +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasHasMore + +`func (o *InlineResponse20027) HasHasMore() bool` + +HasHasMore returns a boolean if a field has been set. + +### SetHasMore + +`func (o *InlineResponse20027) SetHasMore(v bool)` + +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. + ### GetData -`func (o *InlineResponse20027) GetData() []User` +`func (o *InlineResponse20027) GetData() []Change` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20027) GetDataOk() ([]User, bool)` +`func (o *InlineResponse20027) GetDataOk() ([]Change, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +81,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20027) SetData(v []User)` +`func (o *InlineResponse20027) SetData(v []Change)` -SetData gets a reference to the given []User and assigns it to the Data field. +SetData gets a reference to the given []Change and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20028.md b/docs/InlineResponse20028.md index bcfd7951..71451a94 100644 --- a/docs/InlineResponse20028.md +++ b/docs/InlineResponse20028.md @@ -4,9 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | [optional] -**HasMore** | Pointer to **bool** | | [optional] -**Data** | Pointer to [**[]Change**](Change.md) | | +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]Export**](Export.md) | | ## Methods @@ -35,40 +34,15 @@ HasTotalResultSize returns a boolean if a field has been set. SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. -### GetHasMore - -`func (o *InlineResponse20028) GetHasMore() bool` - -GetHasMore returns the HasMore field if non-nil, zero value otherwise. - -### GetHasMoreOk - -`func (o *InlineResponse20028) 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 *InlineResponse20028) HasHasMore() bool` - -HasHasMore returns a boolean if a field has been set. - -### SetHasMore - -`func (o *InlineResponse20028) SetHasMore(v bool)` - -SetHasMore gets a reference to the given bool and assigns it to the HasMore field. - ### GetData -`func (o *InlineResponse20028) GetData() []Change` +`func (o *InlineResponse20028) GetData() []Export` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20028) GetDataOk() ([]Change, bool)` +`func (o *InlineResponse20028) GetDataOk() ([]Export, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -81,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20028) SetData(v []Change)` +`func (o *InlineResponse20028) SetData(v []Export)` -SetData gets a reference to the given []Change and assigns it to the Data field. +SetData gets a reference to the given []Export and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse20029.md b/docs/InlineResponse20029.md index 7e447d1d..16a6dc54 100644 --- a/docs/InlineResponse20029.md +++ b/docs/InlineResponse20029.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Export**](Export.md) | | +**Data** | Pointer to [**[]Role**](Role.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse20029) GetData() []Export` +`func (o *InlineResponse20029) GetData() []Role` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20029) GetDataOk() ([]Export, bool)` +`func (o *InlineResponse20029) GetDataOk() ([]Role, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20029) SetData(v []Export)` +`func (o *InlineResponse20029) SetData(v []Role)` -SetData gets a reference to the given []Export and assigns it to the Data field. +SetData gets a reference to the given []Role and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2006.md b/docs/InlineResponse2006.md index aa39e83f..60a69081 100644 --- a/docs/InlineResponse2006.md +++ b/docs/InlineResponse2006.md @@ -4,35 +4,35 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | +**HasMore** | Pointer to **bool** | | **Data** | Pointer to [**[]Referral**](Referral.md) | | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse2006) GetTotalResultSize() int32` +`func (o *InlineResponse2006) GetHasMore() bool` -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. +GetHasMore returns the HasMore field if non-nil, zero value otherwise. -### GetTotalResultSizeOk +### GetHasMoreOk -`func (o *InlineResponse2006) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse2006) GetHasMoreOk() (bool, bool)` -GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasTotalResultSize +### HasHasMore -`func (o *InlineResponse2006) HasTotalResultSize() bool` +`func (o *InlineResponse2006) HasHasMore() bool` -HasTotalResultSize returns a boolean if a field has been set. +HasHasMore returns a boolean if a field has been set. -### SetTotalResultSize +### SetHasMore -`func (o *InlineResponse2006) SetTotalResultSize(v int32)` +`func (o *InlineResponse2006) SetHasMore(v bool)` -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. ### GetData diff --git a/docs/InlineResponse2007.md b/docs/InlineResponse2007.md index 8a0488d6..137291c2 100644 --- a/docs/InlineResponse2007.md +++ b/docs/InlineResponse2007.md @@ -4,45 +4,45 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HasMore** | Pointer to **bool** | | -**Data** | Pointer to [**[]Referral**](Referral.md) | | +**TotalResultSize** | Pointer to **int32** | | +**Data** | Pointer to [**[]LoyaltyProgram**](LoyaltyProgram.md) | | ## Methods -### GetHasMore +### GetTotalResultSize -`func (o *InlineResponse2007) GetHasMore() bool` +`func (o *InlineResponse2007) GetTotalResultSize() int32` -GetHasMore returns the HasMore field if non-nil, zero value otherwise. +GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. -### GetHasMoreOk +### GetTotalResultSizeOk -`func (o *InlineResponse2007) GetHasMoreOk() (bool, bool)` +`func (o *InlineResponse2007) GetTotalResultSizeOk() (int32, bool)` -GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise +GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasHasMore +### HasTotalResultSize -`func (o *InlineResponse2007) HasHasMore() bool` +`func (o *InlineResponse2007) HasTotalResultSize() bool` -HasHasMore returns a boolean if a field has been set. +HasTotalResultSize returns a boolean if a field has been set. -### SetHasMore +### SetTotalResultSize -`func (o *InlineResponse2007) SetHasMore(v bool)` +`func (o *InlineResponse2007) SetTotalResultSize(v int32)` -SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. ### GetData -`func (o *InlineResponse2007) GetData() []Referral` +`func (o *InlineResponse2007) GetData() []LoyaltyProgram` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2007) GetDataOk() ([]Referral, bool)` +`func (o *InlineResponse2007) GetDataOk() ([]LoyaltyProgram, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse2007) SetData(v []Referral)` +`func (o *InlineResponse2007) SetData(v []LoyaltyProgram)` -SetData gets a reference to the given []Referral and assigns it to the Data field. +SetData gets a reference to the given []LoyaltyProgram and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2008.md b/docs/InlineResponse2008.md index 0be04d9e..e38fc124 100644 --- a/docs/InlineResponse2008.md +++ b/docs/InlineResponse2008.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]LoyaltyProgram**](LoyaltyProgram.md) | | +**Data** | Pointer to [**[]AccessLogEntry**](AccessLogEntry.md) | | ## Methods @@ -36,13 +36,13 @@ SetTotalResultSize gets a reference to the given int32 and assigns it to the Tot ### GetData -`func (o *InlineResponse2008) GetData() []LoyaltyProgram` +`func (o *InlineResponse2008) GetData() []AccessLogEntry` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse2008) GetDataOk() ([]LoyaltyProgram, bool)` +`func (o *InlineResponse2008) GetDataOk() ([]AccessLogEntry, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -55,9 +55,9 @@ HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse2008) SetData(v []LoyaltyProgram)` +`func (o *InlineResponse2008) SetData(v []AccessLogEntry)` -SetData gets a reference to the given []LoyaltyProgram and assigns it to the Data field. +SetData gets a reference to the given []AccessLogEntry and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2009.md b/docs/InlineResponse2009.md index fd057b6e..b23bc120 100644 --- a/docs/InlineResponse2009.md +++ b/docs/InlineResponse2009.md @@ -4,35 +4,35 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TotalResultSize** | Pointer to **int32** | | +**HasMore** | Pointer to **bool** | | **Data** | Pointer to [**[]AccessLogEntry**](AccessLogEntry.md) | | ## Methods -### GetTotalResultSize +### GetHasMore -`func (o *InlineResponse2009) GetTotalResultSize() int32` +`func (o *InlineResponse2009) GetHasMore() bool` -GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. +GetHasMore returns the HasMore field if non-nil, zero value otherwise. -### GetTotalResultSizeOk +### GetHasMoreOk -`func (o *InlineResponse2009) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse2009) GetHasMoreOk() (bool, bool)` -GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise +GetHasMoreOk returns a tuple with the HasMore field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasTotalResultSize +### HasHasMore -`func (o *InlineResponse2009) HasTotalResultSize() bool` +`func (o *InlineResponse2009) HasHasMore() bool` -HasTotalResultSize returns a boolean if a field has been set. +HasHasMore returns a boolean if a field has been set. -### SetTotalResultSize +### SetHasMore -`func (o *InlineResponse2009) SetTotalResultSize(v int32)` +`func (o *InlineResponse2009) SetHasMore(v bool)` -SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +SetHasMore gets a reference to the given bool and assigns it to the HasMore field. ### GetData diff --git a/docs/InlineResponse20030.md b/docs/InlineResponse201.md similarity index 65% rename from docs/InlineResponse20030.md rename to docs/InlineResponse201.md index edcb7488..5f60d104 100644 --- a/docs/InlineResponse20030.md +++ b/docs/InlineResponse201.md @@ -1,63 +1,63 @@ -# InlineResponse20030 +# InlineResponse201 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TotalResultSize** | Pointer to **int32** | | -**Data** | Pointer to [**[]Role**](Role.md) | | +**Data** | Pointer to [**[]Referral**](Referral.md) | | ## Methods ### GetTotalResultSize -`func (o *InlineResponse20030) GetTotalResultSize() int32` +`func (o *InlineResponse201) GetTotalResultSize() int32` GetTotalResultSize returns the TotalResultSize field if non-nil, zero value otherwise. ### GetTotalResultSizeOk -`func (o *InlineResponse20030) GetTotalResultSizeOk() (int32, bool)` +`func (o *InlineResponse201) GetTotalResultSizeOk() (int32, bool)` GetTotalResultSizeOk returns a tuple with the TotalResultSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### HasTotalResultSize -`func (o *InlineResponse20030) HasTotalResultSize() bool` +`func (o *InlineResponse201) HasTotalResultSize() bool` HasTotalResultSize returns a boolean if a field has been set. ### SetTotalResultSize -`func (o *InlineResponse20030) SetTotalResultSize(v int32)` +`func (o *InlineResponse201) SetTotalResultSize(v int32)` SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. ### GetData -`func (o *InlineResponse20030) GetData() []Role` +`func (o *InlineResponse201) GetData() []Referral` GetData returns the Data field if non-nil, zero value otherwise. ### GetDataOk -`func (o *InlineResponse20030) GetDataOk() ([]Role, bool)` +`func (o *InlineResponse201) GetDataOk() ([]Referral, bool)` GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### HasData -`func (o *InlineResponse20030) HasData() bool` +`func (o *InlineResponse201) HasData() bool` HasData returns a boolean if a field has been set. ### SetData -`func (o *InlineResponse20030) SetData(v []Role)` +`func (o *InlineResponse201) SetData(v []Referral)` -SetData gets a reference to the given []Role and assigns it to the Data field. +SetData gets a reference to the given []Referral and assigns it to the Data field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/IntegrationApi.md b/docs/IntegrationApi.md index f72ef010..a2fdc908 100644 --- a/docs/IntegrationApi.md +++ b/docs/IntegrationApi.md @@ -6,6 +6,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**CreateCouponReservation**](IntegrationApi.md#CreateCouponReservation) | **Post** /v1/coupon_reservations/{couponValue} | Create a new coupon reservation [**CreateReferral**](IntegrationApi.md#CreateReferral) | **Post** /v1/referrals | Create a referral code for an advocate +[**CreateReferralsForMultipleAdvocates**](IntegrationApi.md#CreateReferralsForMultipleAdvocates) | **Post** /v1/referrals_for_multiple_advocates | Create referral codes for multiple advocates [**DeleteCouponReservation**](IntegrationApi.md#DeleteCouponReservation) | **Delete** /v1/coupon_reservations/{couponValue} | Delete coupon reservations [**DeleteCustomerData**](IntegrationApi.md#DeleteCustomerData) | **Delete** /v1/customer_data/{integrationId} | Delete the personal data of a customer [**GetCustomerInventory**](IntegrationApi.md#GetCustomerInventory) | **Get** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile @@ -103,6 +104,46 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## CreateReferralsForMultipleAdvocates + +> InlineResponse201 CreateReferralsForMultipleAdvocates(ctx).Body(body).Silent(silent).Execute() + +Create referral codes for multiple advocates + + + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateReferralsForMultipleAdvocatesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**NewReferralsForMultipleAdvocates**](NewReferralsForMultipleAdvocates.md) | | + **silent** | **string** | If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000). | + +### Return type + +[**InlineResponse201**](inline_response_201.md) + +### Authorization + +[api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## DeleteCouponReservation > DeleteCouponReservation(ctx, couponValue).Body(body).Execute() @@ -192,7 +233,7 @@ Name | Type | Description | Notes ## GetCustomerInventory -> CustomerInventory GetCustomerInventory(ctx, integrationId).Profile(profile).Referrals(referrals).Coupons(coupons).Loyalty(loyalty).Execute() +> CustomerInventory GetCustomerInventory(ctx, integrationId).Profile(profile).Referrals(referrals).Coupons(coupons).Loyalty(loyalty).Giveaways(giveaways).Execute() Get an inventory of all data associated with a specific customer profile @@ -218,6 +259,7 @@ Name | Type | Description | Notes **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 | + **giveaways** | **bool** | optional flag to decide if you would like giveaways information in the response | ### Return type @@ -300,7 +342,7 @@ Other parameters are passed through a pointer to a apiTrackEventRequest struct v Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**NewEvent**](NewEvent.md) | | - **dry** | **bool** | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | + **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. | ### Return type @@ -345,7 +387,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**NewCustomerProfile**](NewCustomerProfile.md) | | - **dry** | **bool** | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | + **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. | ### Return type @@ -430,7 +472,7 @@ Name | Type | Description | Notes **body** | [**CustomerProfileIntegrationRequestV2**](CustomerProfileIntegrationRequestV2.md) | | **runRuleEngine** | **bool** | Indicates whether to run the rule engine. | [default to false] - **dry** | **bool** | Indicates whether to persist the changes. Changes are persisted with `true`. Only used when `runRuleEngine` is set to `true`. | + **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. Only used when `runRuleEngine` is set to `true`. | ### Return type @@ -515,7 +557,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**NewCustomerSession**](NewCustomerSession.md) | | - **dry** | **bool** | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | + **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. | ### Return type @@ -560,7 +602,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**IntegrationRequest**](IntegrationRequest.md) | | - **dry** | **bool** | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | + **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. | ### Return type diff --git a/docs/IntegrationRequest.md b/docs/IntegrationRequest.md index 39719d60..ebef2caf 100644 --- a/docs/IntegrationRequest.md +++ b/docs/IntegrationRequest.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CustomerSession** | Pointer to [**NewCustomerSessionV2**](NewCustomerSessionV2.md) | | -**ResponseContent** | Pointer to **[]string** | Optional list of requested information to be present on the response related to the customer session update. Currently supported: \"customerSession\", \"customerProfile\", \"coupons\", \"triggeredCampaigns\", \"referral\", \"loyalty\", \"event\" and \"ruleFailureReasons\". | [optional] +**ResponseContent** | Pointer to **[]string** | Optional list of requested information to be present on the response related to the customer session update. Currently supported: \"customerSession\", \"customerProfile\", \"coupons\", \"triggeredCampaigns\", \"referral\", \"loyalty\", \"event\", \"awardedGiveaways\" and \"ruleFailureReasons\". | [optional] ## Methods diff --git a/docs/IntegrationStateV2.md b/docs/IntegrationStateV2.md index cd519214..1a120a4e 100644 --- a/docs/IntegrationStateV2.md +++ b/docs/IntegrationStateV2.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **RuleFailureReasons** | Pointer to [**[]RuleFailureReason**](RuleFailureReason.md) | | [optional] **CreatedCoupons** | Pointer to [**[]Coupon**](Coupon.md) | | **CreatedReferrals** | Pointer to [**[]Referral**](Referral.md) | | +**AwardedGiveaways** | Pointer to [**[]Giveaway**](Giveaway.md) | | [optional] ## Methods @@ -293,6 +294,31 @@ HasCreatedReferrals returns a boolean if a field has been set. SetCreatedReferrals gets a reference to the given []Referral and assigns it to the CreatedReferrals field. +### GetAwardedGiveaways + +`func (o *IntegrationStateV2) GetAwardedGiveaways() []Giveaway` + +GetAwardedGiveaways returns the AwardedGiveaways field if non-nil, zero value otherwise. + +### GetAwardedGiveawaysOk + +`func (o *IntegrationStateV2) GetAwardedGiveawaysOk() ([]Giveaway, bool)` + +GetAwardedGiveawaysOk returns a tuple with the AwardedGiveaways field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAwardedGiveaways + +`func (o *IntegrationStateV2) HasAwardedGiveaways() bool` + +HasAwardedGiveaways returns a boolean if a field has been set. + +### SetAwardedGiveaways + +`func (o *IntegrationStateV2) SetAwardedGiveaways(v []Giveaway)` + +SetAwardedGiveaways gets a reference to the given []Giveaway and assigns it to the AwardedGiveaways field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InventoryCoupon.md b/docs/InventoryCoupon.md new file mode 100644 index 00000000..384b64c7 --- /dev/null +++ b/docs/InventoryCoupon.md @@ -0,0 +1,507 @@ +# InventoryCoupon + +## 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. | +**CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | +**Value** | Pointer to **string** | The actual coupon code. | +**UsageLimit** | Pointer to **int32** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. | +**DiscountLimit** | Pointer to **float32** | The amount of discounts that can be given with this coupon code. | [optional] +**StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**UsageCounter** | Pointer to **int32** | The number of times this coupon has been successfully used. | +**DiscountCounter** | Pointer to **float32** | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional] +**DiscountRemainder** | Pointer to **float32** | The remaining discount this coupon can give. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] +**ReferralId** | Pointer to **int32** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional] +**RecipientIntegrationId** | Pointer to **string** | The Integration ID of the customer that is allowed to redeem this coupon. | [optional] +**ImportId** | Pointer to **int32** | The ID of the Import which created this coupon. | [optional] +**Reservation** | Pointer to **bool** | This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favorite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. | [optional] +**BatchId** | Pointer to **string** | The id of the batch the coupon belongs to. | [optional] +**ProfileRedemptionCount** | Pointer to **int32** | The number of times the coupon was redeemed by the profile. | +**State** | Pointer to **string** | Can be either active, used, expired, or pending. active: reserved coupons that are neither pending nor used nor expired, and have a non-exhausted limit counter. used: coupons that are not pending, and have reached their redemption limit or were redeemed by the profile before expiration. expired: all non-pending, non-active, non-used coupons that were not redeemed by the profile. pending: coupons that have a start date in the future. | + +## Methods + +### GetId + +`func (o *InventoryCoupon) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *InventoryCoupon) 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 *InventoryCoupon) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *InventoryCoupon) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *InventoryCoupon) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *InventoryCoupon) 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 *InventoryCoupon) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *InventoryCoupon) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetCampaignId + +`func (o *InventoryCoupon) GetCampaignId() int32` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *InventoryCoupon) GetCampaignIdOk() (int32, bool)` + +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignId + +`func (o *InventoryCoupon) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignId + +`func (o *InventoryCoupon) SetCampaignId(v int32)` + +SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. + +### GetValue + +`func (o *InventoryCoupon) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *InventoryCoupon) GetValueOk() (string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValue + +`func (o *InventoryCoupon) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValue + +`func (o *InventoryCoupon) SetValue(v string)` + +SetValue gets a reference to the given string and assigns it to the Value field. + +### GetUsageLimit + +`func (o *InventoryCoupon) GetUsageLimit() int32` + +GetUsageLimit returns the UsageLimit field if non-nil, zero value otherwise. + +### GetUsageLimitOk + +`func (o *InventoryCoupon) GetUsageLimitOk() (int32, bool)` + +GetUsageLimitOk returns a tuple with the UsageLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUsageLimit + +`func (o *InventoryCoupon) HasUsageLimit() bool` + +HasUsageLimit returns a boolean if a field has been set. + +### SetUsageLimit + +`func (o *InventoryCoupon) SetUsageLimit(v int32)` + +SetUsageLimit gets a reference to the given int32 and assigns it to the UsageLimit field. + +### GetDiscountLimit + +`func (o *InventoryCoupon) GetDiscountLimit() float32` + +GetDiscountLimit returns the DiscountLimit field if non-nil, zero value otherwise. + +### GetDiscountLimitOk + +`func (o *InventoryCoupon) GetDiscountLimitOk() (float32, bool)` + +GetDiscountLimitOk returns a tuple with the DiscountLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDiscountLimit + +`func (o *InventoryCoupon) HasDiscountLimit() bool` + +HasDiscountLimit returns a boolean if a field has been set. + +### SetDiscountLimit + +`func (o *InventoryCoupon) SetDiscountLimit(v float32)` + +SetDiscountLimit gets a reference to the given float32 and assigns it to the DiscountLimit field. + +### GetStartDate + +`func (o *InventoryCoupon) GetStartDate() time.Time` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *InventoryCoupon) 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 *InventoryCoupon) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *InventoryCoupon) SetStartDate(v time.Time)` + +SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. + +### GetExpiryDate + +`func (o *InventoryCoupon) GetExpiryDate() time.Time` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *InventoryCoupon) 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 *InventoryCoupon) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *InventoryCoupon) SetExpiryDate(v time.Time)` + +SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. + +### GetUsageCounter + +`func (o *InventoryCoupon) GetUsageCounter() int32` + +GetUsageCounter returns the UsageCounter field if non-nil, zero value otherwise. + +### GetUsageCounterOk + +`func (o *InventoryCoupon) GetUsageCounterOk() (int32, bool)` + +GetUsageCounterOk returns a tuple with the UsageCounter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUsageCounter + +`func (o *InventoryCoupon) HasUsageCounter() bool` + +HasUsageCounter returns a boolean if a field has been set. + +### SetUsageCounter + +`func (o *InventoryCoupon) SetUsageCounter(v int32)` + +SetUsageCounter gets a reference to the given int32 and assigns it to the UsageCounter field. + +### GetDiscountCounter + +`func (o *InventoryCoupon) GetDiscountCounter() float32` + +GetDiscountCounter returns the DiscountCounter field if non-nil, zero value otherwise. + +### GetDiscountCounterOk + +`func (o *InventoryCoupon) GetDiscountCounterOk() (float32, bool)` + +GetDiscountCounterOk returns a tuple with the DiscountCounter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDiscountCounter + +`func (o *InventoryCoupon) HasDiscountCounter() bool` + +HasDiscountCounter returns a boolean if a field has been set. + +### SetDiscountCounter + +`func (o *InventoryCoupon) SetDiscountCounter(v float32)` + +SetDiscountCounter gets a reference to the given float32 and assigns it to the DiscountCounter field. + +### GetDiscountRemainder + +`func (o *InventoryCoupon) GetDiscountRemainder() float32` + +GetDiscountRemainder returns the DiscountRemainder field if non-nil, zero value otherwise. + +### GetDiscountRemainderOk + +`func (o *InventoryCoupon) GetDiscountRemainderOk() (float32, bool)` + +GetDiscountRemainderOk returns a tuple with the DiscountRemainder field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDiscountRemainder + +`func (o *InventoryCoupon) HasDiscountRemainder() bool` + +HasDiscountRemainder returns a boolean if a field has been set. + +### SetDiscountRemainder + +`func (o *InventoryCoupon) SetDiscountRemainder(v float32)` + +SetDiscountRemainder gets a reference to the given float32 and assigns it to the DiscountRemainder field. + +### GetAttributes + +`func (o *InventoryCoupon) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *InventoryCoupon) 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 *InventoryCoupon) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *InventoryCoupon) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + +### GetReferralId + +`func (o *InventoryCoupon) GetReferralId() int32` + +GetReferralId returns the ReferralId field if non-nil, zero value otherwise. + +### GetReferralIdOk + +`func (o *InventoryCoupon) GetReferralIdOk() (int32, bool)` + +GetReferralIdOk returns a tuple with the ReferralId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReferralId + +`func (o *InventoryCoupon) HasReferralId() bool` + +HasReferralId returns a boolean if a field has been set. + +### SetReferralId + +`func (o *InventoryCoupon) SetReferralId(v int32)` + +SetReferralId gets a reference to the given int32 and assigns it to the ReferralId field. + +### GetRecipientIntegrationId + +`func (o *InventoryCoupon) GetRecipientIntegrationId() string` + +GetRecipientIntegrationId returns the RecipientIntegrationId field if non-nil, zero value otherwise. + +### GetRecipientIntegrationIdOk + +`func (o *InventoryCoupon) GetRecipientIntegrationIdOk() (string, bool)` + +GetRecipientIntegrationIdOk returns a tuple with the RecipientIntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRecipientIntegrationId + +`func (o *InventoryCoupon) HasRecipientIntegrationId() bool` + +HasRecipientIntegrationId returns a boolean if a field has been set. + +### SetRecipientIntegrationId + +`func (o *InventoryCoupon) SetRecipientIntegrationId(v string)` + +SetRecipientIntegrationId gets a reference to the given string and assigns it to the RecipientIntegrationId field. + +### GetImportId + +`func (o *InventoryCoupon) GetImportId() int32` + +GetImportId returns the ImportId field if non-nil, zero value otherwise. + +### GetImportIdOk + +`func (o *InventoryCoupon) GetImportIdOk() (int32, bool)` + +GetImportIdOk returns a tuple with the ImportId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasImportId + +`func (o *InventoryCoupon) HasImportId() bool` + +HasImportId returns a boolean if a field has been set. + +### SetImportId + +`func (o *InventoryCoupon) SetImportId(v int32)` + +SetImportId gets a reference to the given int32 and assigns it to the ImportId field. + +### GetReservation + +`func (o *InventoryCoupon) GetReservation() bool` + +GetReservation returns the Reservation field if non-nil, zero value otherwise. + +### GetReservationOk + +`func (o *InventoryCoupon) GetReservationOk() (bool, bool)` + +GetReservationOk returns a tuple with the Reservation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReservation + +`func (o *InventoryCoupon) HasReservation() bool` + +HasReservation returns a boolean if a field has been set. + +### SetReservation + +`func (o *InventoryCoupon) SetReservation(v bool)` + +SetReservation gets a reference to the given bool and assigns it to the Reservation field. + +### GetBatchId + +`func (o *InventoryCoupon) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *InventoryCoupon) GetBatchIdOk() (string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBatchId + +`func (o *InventoryCoupon) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### SetBatchId + +`func (o *InventoryCoupon) SetBatchId(v string)` + +SetBatchId gets a reference to the given string and assigns it to the BatchId field. + +### GetProfileRedemptionCount + +`func (o *InventoryCoupon) GetProfileRedemptionCount() int32` + +GetProfileRedemptionCount returns the ProfileRedemptionCount field if non-nil, zero value otherwise. + +### GetProfileRedemptionCountOk + +`func (o *InventoryCoupon) GetProfileRedemptionCountOk() (int32, bool)` + +GetProfileRedemptionCountOk returns a tuple with the ProfileRedemptionCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProfileRedemptionCount + +`func (o *InventoryCoupon) HasProfileRedemptionCount() bool` + +HasProfileRedemptionCount returns a boolean if a field has been set. + +### SetProfileRedemptionCount + +`func (o *InventoryCoupon) SetProfileRedemptionCount(v int32)` + +SetProfileRedemptionCount gets a reference to the given int32 and assigns it to the ProfileRedemptionCount field. + +### GetState + +`func (o *InventoryCoupon) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *InventoryCoupon) GetStateOk() (string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasState + +`func (o *InventoryCoupon) HasState() bool` + +HasState returns a boolean if a field has been set. + +### SetState + +`func (o *InventoryCoupon) SetState(v string)` + +SetState gets a reference to the given string and assigns it to the State field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoyaltyProgram.md b/docs/LoyaltyProgram.md index 0826c01d..65d718dc 100644 --- a/docs/LoyaltyProgram.md +++ b/docs/LoyaltyProgram.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **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 | +**Tiers** | Pointer to [**[]LoyaltyTier**](LoyaltyTier.md) | The tiers in this loyalty program | [optional] ## Methods @@ -241,6 +242,31 @@ HasAllowSubledger returns a boolean if a field has been set. SetAllowSubledger gets a reference to the given bool and assigns it to the AllowSubledger field. +### GetTiers + +`func (o *LoyaltyProgram) GetTiers() []LoyaltyTier` + +GetTiers returns the Tiers field if non-nil, zero value otherwise. + +### GetTiersOk + +`func (o *LoyaltyProgram) GetTiersOk() ([]LoyaltyTier, bool)` + +GetTiersOk returns a tuple with the Tiers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTiers + +`func (o *LoyaltyProgram) HasTiers() bool` + +HasTiers returns a boolean if a field has been set. + +### SetTiers + +`func (o *LoyaltyProgram) SetTiers(v []LoyaltyTier)` + +SetTiers gets a reference to the given []LoyaltyTier and assigns it to the Tiers field. + [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LoyaltyProgramEntity.md b/docs/LoyaltyProgramEntity.md new file mode 100644 index 00000000..24ff37fc --- /dev/null +++ b/docs/LoyaltyProgramEntity.md @@ -0,0 +1,39 @@ +# LoyaltyProgramEntity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProgramID** | Pointer to **int32** | The ID of the loyalty program that owns this entity. | + +## Methods + +### GetProgramID + +`func (o *LoyaltyProgramEntity) GetProgramID() int32` + +GetProgramID returns the ProgramID field if non-nil, zero value otherwise. + +### GetProgramIDOk + +`func (o *LoyaltyProgramEntity) GetProgramIDOk() (int32, bool)` + +GetProgramIDOk returns a tuple with the ProgramID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProgramID + +`func (o *LoyaltyProgramEntity) HasProgramID() bool` + +HasProgramID returns a boolean if a field has been set. + +### SetProgramID + +`func (o *LoyaltyProgramEntity) SetProgramID(v int32)` + +SetProgramID gets a reference to the given int32 and assigns it to the ProgramID field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LoyaltyTier.md b/docs/LoyaltyTier.md new file mode 100644 index 00000000..fb576ca3 --- /dev/null +++ b/docs/LoyaltyTier.md @@ -0,0 +1,143 @@ +# LoyaltyTier + +## 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. | +**ProgramID** | Pointer to **int32** | The ID of the loyalty program that owns this entity. | +**Name** | Pointer to **string** | The name of the tier | +**MinPoints** | Pointer to **float32** | The minimum amount of points required to be eligible for the tier | + +## Methods + +### GetId + +`func (o *LoyaltyTier) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LoyaltyTier) 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 *LoyaltyTier) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *LoyaltyTier) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *LoyaltyTier) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *LoyaltyTier) 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 *LoyaltyTier) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *LoyaltyTier) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetProgramID + +`func (o *LoyaltyTier) GetProgramID() int32` + +GetProgramID returns the ProgramID field if non-nil, zero value otherwise. + +### GetProgramIDOk + +`func (o *LoyaltyTier) GetProgramIDOk() (int32, bool)` + +GetProgramIDOk returns a tuple with the ProgramID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProgramID + +`func (o *LoyaltyTier) HasProgramID() bool` + +HasProgramID returns a boolean if a field has been set. + +### SetProgramID + +`func (o *LoyaltyTier) SetProgramID(v int32)` + +SetProgramID gets a reference to the given int32 and assigns it to the ProgramID field. + +### GetName + +`func (o *LoyaltyTier) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *LoyaltyTier) 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 *LoyaltyTier) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *LoyaltyTier) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetMinPoints + +`func (o *LoyaltyTier) GetMinPoints() float32` + +GetMinPoints returns the MinPoints field if non-nil, zero value otherwise. + +### GetMinPointsOk + +`func (o *LoyaltyTier) GetMinPointsOk() (float32, bool)` + +GetMinPointsOk returns a tuple with the MinPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasMinPoints + +`func (o *LoyaltyTier) HasMinPoints() bool` + +HasMinPoints returns a boolean if a field has been set. + +### SetMinPoints + +`func (o *LoyaltyTier) SetMinPoints(v float32)` + +SetMinPoints gets a reference to the given float32 and assigns it to the MinPoints field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ManagementApi.md b/docs/ManagementApi.md index 8cbcd2ac..4eb0a830 100644 --- a/docs/ManagementApi.md +++ b/docs/ManagementApi.md @@ -80,6 +80,10 @@ Method | HTTP request | Description [**GetWebhookActivationLogs**](ManagementApi.md#GetWebhookActivationLogs) | **Get** /v1/webhook_activation_logs | List Webhook activation Log Entries [**GetWebhookLogs**](ManagementApi.md#GetWebhookLogs) | **Get** /v1/webhook_logs | List Webhook Log Entries [**GetWebhooks**](ManagementApi.md#GetWebhooks) | **Get** /v1/webhooks | List Webhooks +[**ImportCoupons**](ManagementApi.md#ImportCoupons) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons via CSV file +[**ImportLoyaltyPoints**](ManagementApi.md#ImportLoyaltyPoints) | **Post** /v1/loyalty_programs/{programID}/import_points | Import loyalty points via CSV file +[**ImportPoolGiveaways**](ManagementApi.md#ImportPoolGiveaways) | **Post** /v1/giveaways/pools/{poolId}/import | Import giveaways codes into a giveaways pool +[**ImportReferrals**](ManagementApi.md#ImportReferrals) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals via CSV file [**RemoveLoyaltyPoints**](ManagementApi.md#RemoveLoyaltyPoints) | **Put** /v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points | Deduct points in a certain loyalty program for the specified customer [**ResetPassword**](ManagementApi.md#ResetPassword) | **Post** /v1/reset_password | Reset password [**SearchCouponsAdvanced**](ManagementApi.md#SearchCouponsAdvanced) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced | Get a list of the coupons that match the given attributes (with total count) @@ -91,6 +95,7 @@ Method | HTTP request | Description [**UpdateCampaign**](ManagementApi.md#UpdateCampaign) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign [**UpdateCoupon**](ManagementApi.md#UpdateCoupon) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon [**UpdateCouponBatch**](ManagementApi.md#UpdateCouponBatch) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update a Batch of Coupons +[**UpdateReferral**](ManagementApi.md#UpdateReferral) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Update one Referral [**UpdateRuleset**](ManagementApi.md#UpdateRuleset) | **Put** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Update a Ruleset @@ -332,7 +337,7 @@ Name | Type | Description | Notes **body** | [**NewCoupons**](NewCoupons.md) | | - **silent** | **string** | If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000). | + **silent** | **string** | If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000). | ### Return type @@ -379,7 +384,7 @@ Name | Type | Description | Notes **body** | [**NewCouponsForMultipleRecipients**](NewCouponsForMultipleRecipients.md) | | - **silent** | **string** | If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000). | + **silent** | **string** | If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000). | ### Return type @@ -1030,7 +1035,7 @@ Name | Type | Description | Notes ## GetAccessLogs -> InlineResponse2009 GetAccessLogs(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).Path(path).Method(method).Status(status).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse2008 GetAccessLogs(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).Path(path).Method(method).Status(status).PageSize(pageSize).Skip(skip).Sort(sort).Execute() Get access logs for application (with total count) @@ -1061,7 +1066,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2009**](inline_response_200_9.md) +[**InlineResponse2008**](inline_response_200_8.md) ### Authorization @@ -1079,7 +1084,7 @@ Name | Type | Description | Notes ## GetAccessLogsWithoutTotalCount -> InlineResponse20010 GetAccessLogsWithoutTotalCount(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).Path(path).Method(method).Status(status).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse2009 GetAccessLogsWithoutTotalCount(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).Path(path).Method(method).Status(status).PageSize(pageSize).Skip(skip).Sort(sort).Execute() Get access logs for application @@ -1110,7 +1115,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20010**](inline_response_200_10.md) +[**InlineResponse2009**](inline_response_200_9.md) ### Authorization @@ -1257,7 +1262,7 @@ Name | Type | Description | Notes ## GetAdditionalCosts -> InlineResponse20022 GetAdditionalCosts(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20021 GetAdditionalCosts(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() List additional costs @@ -1280,7 +1285,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20022**](inline_response_200_22.md) +[**InlineResponse20021**](inline_response_200_21.md) ### Authorization @@ -1298,7 +1303,7 @@ Name | Type | Description | Notes ## GetAllAccessLogs -> InlineResponse2009 GetAllAccessLogs(ctx).RangeStart(rangeStart).RangeEnd(rangeEnd).Path(path).Method(method).Status(status).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse2008 GetAllAccessLogs(ctx).RangeStart(rangeStart).RangeEnd(rangeEnd).Path(path).Method(method).Status(status).PageSize(pageSize).Skip(skip).Sort(sort).Execute() Get all access logs @@ -1326,7 +1331,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2009**](inline_response_200_9.md) +[**InlineResponse2008**](inline_response_200_8.md) ### Authorization @@ -1344,7 +1349,7 @@ Name | Type | Description | Notes ## GetAllRoles -> InlineResponse20030 GetAllRoles(ctx).Execute() +> InlineResponse20029 GetAllRoles(ctx).Execute() Get all roles @@ -1359,7 +1364,7 @@ Other parameters are passed through a pointer to a apiGetAllRolesRequest struct ### Return type -[**InlineResponse20030**](inline_response_200_30.md) +[**InlineResponse20029**](inline_response_200_29.md) ### Authorization @@ -1504,7 +1509,7 @@ Name | Type | Description | Notes ## GetApplicationCustomers -> InlineResponse20012 GetApplicationCustomers(ctx, applicationId).IntegrationId(integrationId).PageSize(pageSize).Skip(skip).WithTotalResultSize(withTotalResultSize).Execute() +> InlineResponse20011 GetApplicationCustomers(ctx, applicationId).IntegrationId(integrationId).PageSize(pageSize).Skip(skip).WithTotalResultSize(withTotalResultSize).Execute() List Application Customers @@ -1527,11 +1532,11 @@ 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. | + **withTotalResultSize** | **bool** | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. | ### Return type -[**InlineResponse20012**](inline_response_200_12.md) +[**InlineResponse20011**](inline_response_200_11.md) ### Authorization @@ -1549,7 +1554,7 @@ Name | Type | Description | Notes ## GetApplicationCustomersByAttributes -> InlineResponse20013 GetApplicationCustomersByAttributes(ctx).Body(body).Execute() +> InlineResponse20012 GetApplicationCustomersByAttributes(ctx).Body(body).Execute() Get a list of the customer profiles that match the given attributes (with total count) @@ -1570,7 +1575,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20013**](inline_response_200_13.md) +[**InlineResponse20012**](inline_response_200_12.md) ### Authorization @@ -1588,7 +1593,7 @@ Name | Type | Description | Notes ## GetApplicationEventTypes -> InlineResponse20019 GetApplicationEventTypes(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20018 GetApplicationEventTypes(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Execute() List Applications Event Types @@ -1616,7 +1621,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20019**](inline_response_200_19.md) +[**InlineResponse20018**](inline_response_200_18.md) ### Authorization @@ -1634,7 +1639,7 @@ Name | Type | Description | Notes ## GetApplicationEvents -> InlineResponse20017 GetApplicationEvents(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Type_(type_).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Session(session).Profile(profile).CustomerName(customerName).CustomerEmail(customerEmail).CouponCode(couponCode).ReferralCode(referralCode).RuleQuery(ruleQuery).CampaignQuery(campaignQuery).Execute() +> InlineResponse20016 GetApplicationEvents(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Type_(type_).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Session(session).Profile(profile).CustomerName(customerName).CustomerEmail(customerEmail).CouponCode(couponCode).ReferralCode(referralCode).RuleQuery(ruleQuery).CampaignQuery(campaignQuery).Execute() List Applications Events (with total count) @@ -1673,7 +1678,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20017**](inline_response_200_17.md) +[**InlineResponse20016**](inline_response_200_16.md) ### Authorization @@ -1691,7 +1696,7 @@ Name | Type | Description | Notes ## GetApplicationEventsWithoutTotalCount -> InlineResponse20018 GetApplicationEventsWithoutTotalCount(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Type_(type_).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Session(session).Profile(profile).CustomerName(customerName).CustomerEmail(customerEmail).CouponCode(couponCode).ReferralCode(referralCode).RuleQuery(ruleQuery).CampaignQuery(campaignQuery).Execute() +> InlineResponse20017 GetApplicationEventsWithoutTotalCount(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Type_(type_).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Session(session).Profile(profile).CustomerName(customerName).CustomerEmail(customerEmail).CouponCode(couponCode).ReferralCode(referralCode).RuleQuery(ruleQuery).CampaignQuery(campaignQuery).Execute() List Applications Events @@ -1730,7 +1735,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20018**](inline_response_200_18.md) +[**InlineResponse20017**](inline_response_200_17.md) ### Authorization @@ -1791,7 +1796,7 @@ Name | Type | Description | Notes ## GetApplicationSessions -> 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() +> InlineResponse20015 GetApplicationSessions(ctx, applicationId).PageSize(pageSize).Skip(skip).Sort(sort).Profile(profile).State(state).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Coupon(coupon).Referral(referral).IntegrationId(integrationId).Execute() List Application Sessions @@ -1824,7 +1829,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20016**](inline_response_200_16.md) +[**InlineResponse20015**](inline_response_200_15.md) ### Authorization @@ -1926,7 +1931,7 @@ Name | Type | Description | Notes ## GetAttributes -> InlineResponse20021 GetAttributes(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20020 GetAttributes(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Entity(entity).Execute() List custom attributes @@ -1946,10 +1951,11 @@ Name | Type | Description | Notes **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | + **entity** | **string** | Returned attributes will be filtered by supplied entity | ### Return type -[**InlineResponse20021**](inline_response_200_21.md) +[**InlineResponse20020**](inline_response_200_20.md) ### Authorization @@ -1967,7 +1973,7 @@ Name | Type | Description | Notes ## GetAudiences -> InlineResponse20020 GetAudiences(ctx).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Execute() +> InlineResponse20019 GetAudiences(ctx).PageSize(pageSize).Skip(skip).Sort(sort).WithTotalResultSize(withTotalResultSize).Execute() Get all audiences @@ -1987,11 +1993,11 @@ Name | Type | Description | Notes **pageSize** | **int32** | The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | **skip** | **int32** | Skips the given number of items when paging through large result sets. | **sort** | **string** | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | - **withTotalResultSize** | **bool** | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be 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. | + **withTotalResultSize** | **bool** | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. | ### Return type -[**InlineResponse20020**](inline_response_200_20.md) +[**InlineResponse20019**](inline_response_200_19.md) ### Authorization @@ -2052,7 +2058,7 @@ Name | Type | Description | Notes ## GetCampaignAnalytics -> InlineResponse20011 GetCampaignAnalytics(ctx, applicationId, campaignId).RangeStart(rangeStart).RangeEnd(rangeEnd).Granularity(granularity).Execute() +> InlineResponse20010 GetCampaignAnalytics(ctx, applicationId, campaignId).RangeStart(rangeStart).RangeEnd(rangeEnd).Granularity(granularity).Execute() Get analytics of campaigns @@ -2080,7 +2086,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20011**](inline_response_200_11.md) +[**InlineResponse20010**](inline_response_200_10.md) ### Authorization @@ -2196,7 +2202,7 @@ Name | Type | Description | Notes ## GetChanges -> InlineResponse20028 GetChanges(ctx).PageSize(pageSize).Skip(skip).Sort(sort).ApplicationId(applicationId).EntityPath(entityPath).UserId(userId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).WithTotalResultSize(withTotalResultSize).IncludeOld(includeOld).Execute() +> InlineResponse20027 GetChanges(ctx).PageSize(pageSize).Skip(skip).Sort(sort).ApplicationId(applicationId).EntityPath(entityPath).UserId(userId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).WithTotalResultSize(withTotalResultSize).IncludeOld(includeOld).Execute() Get audit log for an account @@ -2221,12 +2227,12 @@ Name | Type | Description | Notes **userId** | **int32** | | **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | - **withTotalResultSize** | **bool** | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be 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. | + **withTotalResultSize** | **bool** | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, `hasMore` will be true whenever there is a next page. `totalResultSize` will always be zero. With this flag set to false, `hasMore` will always be set to false. `totalResultSize` will contain the total number of results for this query. | **includeOld** | **bool** | When this flag is set to false, the state without the change will not be returned. The default value is true. | ### Return type -[**InlineResponse20028**](inline_response_200_28.md) +[**InlineResponse20027**](inline_response_200_27.md) ### Authorization @@ -2522,7 +2528,7 @@ Name | Type | Description | Notes ## GetCustomerActivityReports -> InlineResponse20014 GetCustomerActivityReports(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).PageSize(pageSize).Skip(skip).Sort(sort).Name(name).IntegrationId(integrationId).CampaignName(campaignName).AdvocateName(advocateName).Execute() +> InlineResponse20013 GetCustomerActivityReports(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).PageSize(pageSize).Skip(skip).Sort(sort).Name(name).IntegrationId(integrationId).CampaignName(campaignName).AdvocateName(advocateName).Execute() Get Activity Reports for Application Customers (with total count) @@ -2556,7 +2562,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20014**](inline_response_200_14.md) +[**InlineResponse20013**](inline_response_200_13.md) ### Authorization @@ -2574,7 +2580,7 @@ Name | Type | Description | Notes ## GetCustomerActivityReportsWithoutTotalCount -> InlineResponse20015 GetCustomerActivityReportsWithoutTotalCount(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).PageSize(pageSize).Skip(skip).Sort(sort).Name(name).IntegrationId(integrationId).CampaignName(campaignName).AdvocateName(advocateName).Execute() +> InlineResponse20014 GetCustomerActivityReportsWithoutTotalCount(ctx, applicationId).RangeStart(rangeStart).RangeEnd(rangeEnd).PageSize(pageSize).Skip(skip).Sort(sort).Name(name).IntegrationId(integrationId).CampaignName(campaignName).AdvocateName(advocateName).Execute() Get Activity Reports for Application Customers @@ -2608,7 +2614,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20015**](inline_response_200_15.md) +[**InlineResponse20014**](inline_response_200_14.md) ### Authorization @@ -2715,7 +2721,7 @@ Name | Type | Description | Notes ## GetCustomerProfiles -> InlineResponse20013 GetCustomerProfiles(ctx).PageSize(pageSize).Skip(skip).Execute() +> InlineResponse20012 GetCustomerProfiles(ctx).PageSize(pageSize).Skip(skip).Execute() List Customer Profiles @@ -2735,7 +2741,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20013**](inline_response_200_13.md) +[**InlineResponse20012**](inline_response_200_12.md) ### Authorization @@ -2753,7 +2759,7 @@ Name | Type | Description | Notes ## GetCustomersByAttributes -> InlineResponse20013 GetCustomersByAttributes(ctx).Body(body).PageSize(pageSize).Skip(skip).Execute() +> InlineResponse20012 GetCustomersByAttributes(ctx).Body(body).PageSize(pageSize).Skip(skip).Execute() Get a list of the customer profiles that match the given attributes @@ -2776,7 +2782,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20013**](inline_response_200_13.md) +[**InlineResponse20012**](inline_response_200_12.md) ### Authorization @@ -2794,7 +2800,7 @@ Name | Type | Description | Notes ## GetEventTypes -> InlineResponse20026 GetEventTypes(ctx).ApplicationIds(applicationIds).Name(name).IncludeOldVersions(includeOldVersions).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20025 GetEventTypes(ctx).ApplicationIds(applicationIds).Name(name).IncludeOldVersions(includeOldVersions).PageSize(pageSize).Skip(skip).Sort(sort).Execute() List Event Types @@ -2820,7 +2826,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20026**](inline_response_200_26.md) +[**InlineResponse20025**](inline_response_200_25.md) ### Authorization @@ -2838,7 +2844,7 @@ Name | Type | Description | Notes ## GetExports -> InlineResponse20029 GetExports(ctx).PageSize(pageSize).Skip(skip).ApplicationId(applicationId).CampaignId(campaignId).Entity(entity).Execute() +> InlineResponse20028 GetExports(ctx).PageSize(pageSize).Skip(skip).ApplicationId(applicationId).CampaignId(campaignId).Entity(entity).Execute() Get Exports @@ -2863,7 +2869,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20029**](inline_response_200_29.md) +[**InlineResponse20028**](inline_response_200_28.md) ### Authorization @@ -2936,7 +2942,7 @@ Get a loyalty program Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**programID** | **string** | | +**programID** | **int32** | | ### Other Parameters @@ -2967,7 +2973,7 @@ Name | Type | Description | Notes ## GetLoyaltyPrograms -> InlineResponse2008 GetLoyaltyPrograms(ctx).Execute() +> InlineResponse2007 GetLoyaltyPrograms(ctx).Execute() List all loyalty Programs @@ -2982,7 +2988,7 @@ Other parameters are passed through a pointer to a apiGetLoyaltyProgramsRequest ### Return type -[**InlineResponse2008**](inline_response_200_8.md) +[**InlineResponse2007**](inline_response_200_7.md) ### Authorization @@ -3041,7 +3047,7 @@ Name | Type | Description | Notes ## 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() +> InlineResponse201 GetReferrals(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Code(code).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).Advocate(advocate).Execute() List Referrals (with total count) @@ -3075,7 +3081,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2006**](inline_response_200_6.md) +[**InlineResponse201**](inline_response_201.md) ### Authorization @@ -3093,7 +3099,7 @@ Name | Type | Description | Notes ## GetReferralsWithoutTotalCount -> InlineResponse2007 GetReferralsWithoutTotalCount(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Code(code).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).Advocate(advocate).Execute() +> InlineResponse2006 GetReferralsWithoutTotalCount(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Code(code).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).Advocate(advocate).Execute() List Referrals @@ -3127,7 +3133,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2007**](inline_response_200_7.md) +[**InlineResponse2006**](inline_response_200_6.md) ### Authorization @@ -3320,7 +3326,7 @@ Name | Type | Description | Notes ## GetUsers -> InlineResponse20027 GetUsers(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() +> InlineResponse20026 GetUsers(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Execute() List Users in your account @@ -3343,7 +3349,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20027**](inline_response_200_27.md) +[**InlineResponse20026**](inline_response_200_26.md) ### Authorization @@ -3404,7 +3410,7 @@ Name | Type | Description | Notes ## GetWebhookActivationLogs -> InlineResponse20024 GetWebhookActivationLogs(ctx).PageSize(pageSize).Skip(skip).Sort(sort).IntegrationRequestUuid(integrationRequestUuid).WebhookId(webhookId).ApplicationId(applicationId).CampaignId(campaignId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Execute() +> InlineResponse20023 GetWebhookActivationLogs(ctx).PageSize(pageSize).Skip(skip).Sort(sort).IntegrationRequestUuid(integrationRequestUuid).WebhookId(webhookId).ApplicationId(applicationId).CampaignId(campaignId).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Execute() List Webhook activation Log Entries @@ -3433,7 +3439,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20024**](inline_response_200_24.md) +[**InlineResponse20023**](inline_response_200_23.md) ### Authorization @@ -3451,7 +3457,7 @@ Name | Type | Description | Notes ## GetWebhookLogs -> InlineResponse20025 GetWebhookLogs(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Status(status).WebhookId(webhookId).ApplicationId(applicationId).CampaignId(campaignId).RequestUuid(requestUuid).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Execute() +> InlineResponse20024 GetWebhookLogs(ctx).PageSize(pageSize).Skip(skip).Sort(sort).Status(status).WebhookId(webhookId).ApplicationId(applicationId).CampaignId(campaignId).RequestUuid(requestUuid).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Execute() List Webhook Log Entries @@ -3479,7 +3485,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20025**](inline_response_200_25.md) +[**InlineResponse20024**](inline_response_200_24.md) ### Authorization @@ -3497,7 +3503,7 @@ Name | Type | Description | Notes ## GetWebhooks -> InlineResponse20023 GetWebhooks(ctx).ApplicationIds(applicationIds).Sort(sort).PageSize(pageSize).Skip(skip).Execute() +> InlineResponse20022 GetWebhooks(ctx).ApplicationIds(applicationIds).Sort(sort).PageSize(pageSize).Skip(skip).Execute() List Webhooks @@ -3519,7 +3525,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse20023**](inline_response_200_23.md) +[**InlineResponse20022**](inline_response_200_22.md) ### Authorization @@ -3535,6 +3541,186 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## ImportCoupons + +> Import ImportCoupons(ctx, applicationId, campaignId).UpFile(upFile).Execute() + +Import coupons via CSV file + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | | +**campaignId** | **int32** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportCouponsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **upFile** | **string** | The file with the information about the data that should be imported. | + +### Return type + +[**Import**](Import.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ImportLoyaltyPoints + +> Import ImportLoyaltyPoints(ctx, programID).UpFile(upFile).Execute() + +Import loyalty points via CSV file + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**programID** | **int32** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportLoyaltyPointsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **upFile** | **string** | The file with the information about the data that should be imported. | + +### Return type + +[**Import**](Import.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ImportPoolGiveaways + +> Import ImportPoolGiveaways(ctx, poolId).UpFile(upFile).Execute() + +Import giveaways codes into a giveaways pool + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**poolId** | **int32** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportPoolGiveawaysRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **upFile** | **string** | The file with the information about the data that should be imported. | + +### Return type + +[**Import**](Import.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ImportReferrals + +> Import ImportReferrals(ctx, applicationId, campaignId).UpFile(upFile).Execute() + +Import referrals via CSV file + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | | +**campaignId** | **int32** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportReferralsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **upFile** | **string** | The file with the information about the data that should be imported. | + +### Return type + +[**Import**](Import.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## RemoveLoyaltyPoints > RemoveLoyaltyPoints(ctx, programID, integrationID).Body(body).Execute() @@ -4070,6 +4256,52 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## UpdateReferral + +> Referral UpdateReferral(ctx, applicationId, campaignId, referralId).Body(body).Execute() + +Update one Referral + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | | +**campaignId** | **int32** | | +**referralId** | **string** | The ID of the referral code to delete | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateReferralRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **body** | [**UpdateReferral**](UpdateReferral.md) | | + +### Return type + +[**Referral**](Referral.md) + +### Authorization + +[manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## UpdateRuleset > Ruleset UpdateRuleset(ctx, applicationId, campaignId, rulesetId).Body(body).Execute() diff --git a/docs/NewCustomEffect.md b/docs/NewCustomEffect.md new file mode 100644 index 00000000..1763576c --- /dev/null +++ b/docs/NewCustomEffect.md @@ -0,0 +1,195 @@ +# NewCustomEffect + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of this effect. | +**Title** | Pointer to **string** | The title of this effect. | +**Payload** | Pointer to **string** | The JSON payload of this effect. | +**Description** | Pointer to **string** | The description of this effect. | [optional] +**Enabled** | Pointer to **bool** | Determines if this effect is active. | +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this effect is enabled for | [optional] +**Params** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | Array of template argument definitions | [optional] + +## Methods + +### GetName + +`func (o *NewCustomEffect) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NewCustomEffect) 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 *NewCustomEffect) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *NewCustomEffect) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetTitle + +`func (o *NewCustomEffect) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *NewCustomEffect) 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 *NewCustomEffect) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitle + +`func (o *NewCustomEffect) SetTitle(v string)` + +SetTitle gets a reference to the given string and assigns it to the Title field. + +### GetPayload + +`func (o *NewCustomEffect) GetPayload() string` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *NewCustomEffect) GetPayloadOk() (string, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPayload + +`func (o *NewCustomEffect) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + +### SetPayload + +`func (o *NewCustomEffect) SetPayload(v string)` + +SetPayload gets a reference to the given string and assigns it to the Payload field. + +### GetDescription + +`func (o *NewCustomEffect) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NewCustomEffect) 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 *NewCustomEffect) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *NewCustomEffect) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetEnabled + +`func (o *NewCustomEffect) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *NewCustomEffect) GetEnabledOk() (bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnabled + +`func (o *NewCustomEffect) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### SetEnabled + +`func (o *NewCustomEffect) SetEnabled(v bool)` + +SetEnabled gets a reference to the given bool and assigns it to the Enabled field. + +### GetSubscribedApplicationsIds + +`func (o *NewCustomEffect) GetSubscribedApplicationsIds() []int32` + +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. + +### GetSubscribedApplicationsIdsOk + +`func (o *NewCustomEffect) 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 *NewCustomEffect) HasSubscribedApplicationsIds() bool` + +HasSubscribedApplicationsIds returns a boolean if a field has been set. + +### SetSubscribedApplicationsIds + +`func (o *NewCustomEffect) SetSubscribedApplicationsIds(v []int32)` + +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. + +### GetParams + +`func (o *NewCustomEffect) GetParams() []TemplateArgDef` + +GetParams returns the Params field if non-nil, zero value otherwise. + +### GetParamsOk + +`func (o *NewCustomEffect) GetParamsOk() ([]TemplateArgDef, bool)` + +GetParamsOk returns a tuple with the Params field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasParams + +`func (o *NewCustomEffect) HasParams() bool` + +HasParams returns a boolean if a field has been set. + +### SetParams + +`func (o *NewCustomEffect) SetParams(v []TemplateArgDef)` + +SetParams gets a reference to the given []TemplateArgDef and assigns it to the Params field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewGiveawaysPool.md b/docs/NewGiveawaysPool.md new file mode 100644 index 00000000..c1b8da2b --- /dev/null +++ b/docs/NewGiveawaysPool.md @@ -0,0 +1,91 @@ +# NewGiveawaysPool + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of this giveaways pool. | +**Description** | Pointer to **string** | The description of this giveaways pool. | [optional] +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this giveaways pool is enabled for | [optional] + +## Methods + +### GetName + +`func (o *NewGiveawaysPool) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NewGiveawaysPool) 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 *NewGiveawaysPool) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *NewGiveawaysPool) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *NewGiveawaysPool) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NewGiveawaysPool) 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 *NewGiveawaysPool) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *NewGiveawaysPool) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetSubscribedApplicationsIds + +`func (o *NewGiveawaysPool) GetSubscribedApplicationsIds() []int32` + +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. + +### GetSubscribedApplicationsIdsOk + +`func (o *NewGiveawaysPool) 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 *NewGiveawaysPool) HasSubscribedApplicationsIds() bool` + +HasSubscribedApplicationsIds returns a boolean if a field has been set. + +### SetSubscribedApplicationsIds + +`func (o *NewGiveawaysPool) SetSubscribedApplicationsIds(v []int32)` + +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewLoyaltyTier.md b/docs/NewLoyaltyTier.md new file mode 100644 index 00000000..a878a2f7 --- /dev/null +++ b/docs/NewLoyaltyTier.md @@ -0,0 +1,65 @@ +# NewLoyaltyTier + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the tier | +**MinPoints** | Pointer to **float32** | The minimum amount of points required to be eligible for the tier | + +## Methods + +### GetName + +`func (o *NewLoyaltyTier) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NewLoyaltyTier) 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 *NewLoyaltyTier) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *NewLoyaltyTier) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetMinPoints + +`func (o *NewLoyaltyTier) GetMinPoints() float32` + +GetMinPoints returns the MinPoints field if non-nil, zero value otherwise. + +### GetMinPointsOk + +`func (o *NewLoyaltyTier) GetMinPointsOk() (float32, bool)` + +GetMinPointsOk returns a tuple with the MinPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasMinPoints + +`func (o *NewLoyaltyTier) HasMinPoints() bool` + +HasMinPoints returns a boolean if a field has been set. + +### SetMinPoints + +`func (o *NewLoyaltyTier) SetMinPoints(v float32)` + +SetMinPoints gets a reference to the given float32 and assigns it to the MinPoints field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewReferral.md b/docs/NewReferral.md index 1df2f419..68f22f9b 100644 --- a/docs/NewReferral.md +++ b/docs/NewReferral.md @@ -4,14 +4,91 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CampaignId** | Pointer to **int32** | ID of the campaign from which the referral received the referral code. | -**AdvocateProfileIntegrationId** | Pointer to **string** | The Integration Id of the Advocate's Profile | -**FriendProfileIntegrationId** | Pointer to **string** | An optional Integration ID of the Friend's Profile | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] +**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional] +**CampaignId** | Pointer to **int32** | ID of the campaign from which the referral received the referral code. | +**AdvocateProfileIntegrationId** | Pointer to **string** | The Integration ID of the Advocate's Profile. | +**FriendProfileIntegrationId** | Pointer to **string** | An optional Integration ID of the Friend's Profile | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] ## Methods +### GetStartDate + +`func (o *NewReferral) GetStartDate() time.Time` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NewReferral) 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 *NewReferral) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *NewReferral) SetStartDate(v time.Time)` + +SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. + +### GetExpiryDate + +`func (o *NewReferral) GetExpiryDate() time.Time` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *NewReferral) 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 *NewReferral) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *NewReferral) SetExpiryDate(v time.Time)` + +SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. + +### GetUsageLimit + +`func (o *NewReferral) GetUsageLimit() int32` + +GetUsageLimit returns the UsageLimit field if non-nil, zero value otherwise. + +### GetUsageLimitOk + +`func (o *NewReferral) GetUsageLimitOk() (int32, bool)` + +GetUsageLimitOk returns a tuple with the UsageLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUsageLimit + +`func (o *NewReferral) HasUsageLimit() bool` + +HasUsageLimit returns a boolean if a field has been set. + +### SetUsageLimit + +`func (o *NewReferral) SetUsageLimit(v int32)` + +SetUsageLimit gets a reference to the given int32 and assigns it to the UsageLimit field. + ### GetCampaignId `func (o *NewReferral) GetCampaignId() int32` @@ -87,55 +164,30 @@ HasFriendProfileIntegrationId returns a boolean if a field has been set. SetFriendProfileIntegrationId gets a reference to the given string and assigns it to the FriendProfileIntegrationId field. -### GetStartDate - -`func (o *NewReferral) GetStartDate() time.Time` - -GetStartDate returns the StartDate field if non-nil, zero value otherwise. - -### GetStartDateOk - -`func (o *NewReferral) 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 *NewReferral) HasStartDate() bool` - -HasStartDate returns a boolean if a field has been set. - -### SetStartDate - -`func (o *NewReferral) SetStartDate(v time.Time)` - -SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. - -### GetExpiryDate +### GetAttributes -`func (o *NewReferral) GetExpiryDate() time.Time` +`func (o *NewReferral) GetAttributes() map[string]interface{}` -GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. +GetAttributes returns the Attributes field if non-nil, zero value otherwise. -### GetExpiryDateOk +### GetAttributesOk -`func (o *NewReferral) GetExpiryDateOk() (time.Time, bool)` +`func (o *NewReferral) GetAttributesOk() (map[string]interface{}, bool)` -GetExpiryDateOk returns a tuple with the ExpiryDate field if it's non-nil, zero value otherwise +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. -### HasExpiryDate +### HasAttributes -`func (o *NewReferral) HasExpiryDate() bool` +`func (o *NewReferral) HasAttributes() bool` -HasExpiryDate returns a boolean if a field has been set. +HasAttributes returns a boolean if a field has been set. -### SetExpiryDate +### SetAttributes -`func (o *NewReferral) SetExpiryDate(v time.Time)` +`func (o *NewReferral) SetAttributes(v map[string]interface{})` -SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/NewReferralsForMultipleAdvocates.md b/docs/NewReferralsForMultipleAdvocates.md new file mode 100644 index 00000000..3ae07d32 --- /dev/null +++ b/docs/NewReferralsForMultipleAdvocates.md @@ -0,0 +1,221 @@ +# NewReferralsForMultipleAdvocates + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] +**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | +**CampaignId** | Pointer to **int32** | The ID of the campaign from which the referral received the referral code. | +**AdvocateProfileIntegrationIds** | Pointer to **[]string** | An array containing all the respective advocate profiles. | +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] +**ValidCharacters** | Pointer to **[]string** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). | [optional] +**ReferralPattern** | Pointer to **string** | The pattern that will be used to generate referrals. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. | [optional] + +## Methods + +### GetStartDate + +`func (o *NewReferralsForMultipleAdvocates) GetStartDate() time.Time` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *NewReferralsForMultipleAdvocates) 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 *NewReferralsForMultipleAdvocates) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *NewReferralsForMultipleAdvocates) SetStartDate(v time.Time)` + +SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. + +### GetExpiryDate + +`func (o *NewReferralsForMultipleAdvocates) GetExpiryDate() time.Time` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *NewReferralsForMultipleAdvocates) 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 *NewReferralsForMultipleAdvocates) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *NewReferralsForMultipleAdvocates) SetExpiryDate(v time.Time)` + +SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. + +### GetUsageLimit + +`func (o *NewReferralsForMultipleAdvocates) GetUsageLimit() int32` + +GetUsageLimit returns the UsageLimit field if non-nil, zero value otherwise. + +### GetUsageLimitOk + +`func (o *NewReferralsForMultipleAdvocates) GetUsageLimitOk() (int32, bool)` + +GetUsageLimitOk returns a tuple with the UsageLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUsageLimit + +`func (o *NewReferralsForMultipleAdvocates) HasUsageLimit() bool` + +HasUsageLimit returns a boolean if a field has been set. + +### SetUsageLimit + +`func (o *NewReferralsForMultipleAdvocates) SetUsageLimit(v int32)` + +SetUsageLimit gets a reference to the given int32 and assigns it to the UsageLimit field. + +### GetCampaignId + +`func (o *NewReferralsForMultipleAdvocates) GetCampaignId() int32` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *NewReferralsForMultipleAdvocates) GetCampaignIdOk() (int32, bool)` + +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignId + +`func (o *NewReferralsForMultipleAdvocates) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignId + +`func (o *NewReferralsForMultipleAdvocates) SetCampaignId(v int32)` + +SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. + +### GetAdvocateProfileIntegrationIds + +`func (o *NewReferralsForMultipleAdvocates) GetAdvocateProfileIntegrationIds() []string` + +GetAdvocateProfileIntegrationIds returns the AdvocateProfileIntegrationIds field if non-nil, zero value otherwise. + +### GetAdvocateProfileIntegrationIdsOk + +`func (o *NewReferralsForMultipleAdvocates) GetAdvocateProfileIntegrationIdsOk() ([]string, bool)` + +GetAdvocateProfileIntegrationIdsOk returns a tuple with the AdvocateProfileIntegrationIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAdvocateProfileIntegrationIds + +`func (o *NewReferralsForMultipleAdvocates) HasAdvocateProfileIntegrationIds() bool` + +HasAdvocateProfileIntegrationIds returns a boolean if a field has been set. + +### SetAdvocateProfileIntegrationIds + +`func (o *NewReferralsForMultipleAdvocates) SetAdvocateProfileIntegrationIds(v []string)` + +SetAdvocateProfileIntegrationIds gets a reference to the given []string and assigns it to the AdvocateProfileIntegrationIds field. + +### GetAttributes + +`func (o *NewReferralsForMultipleAdvocates) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *NewReferralsForMultipleAdvocates) 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 *NewReferralsForMultipleAdvocates) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *NewReferralsForMultipleAdvocates) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + +### GetValidCharacters + +`func (o *NewReferralsForMultipleAdvocates) GetValidCharacters() []string` + +GetValidCharacters returns the ValidCharacters field if non-nil, zero value otherwise. + +### GetValidCharactersOk + +`func (o *NewReferralsForMultipleAdvocates) GetValidCharactersOk() ([]string, bool)` + +GetValidCharactersOk returns a tuple with the ValidCharacters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValidCharacters + +`func (o *NewReferralsForMultipleAdvocates) HasValidCharacters() bool` + +HasValidCharacters returns a boolean if a field has been set. + +### SetValidCharacters + +`func (o *NewReferralsForMultipleAdvocates) SetValidCharacters(v []string)` + +SetValidCharacters gets a reference to the given []string and assigns it to the ValidCharacters field. + +### GetReferralPattern + +`func (o *NewReferralsForMultipleAdvocates) GetReferralPattern() string` + +GetReferralPattern returns the ReferralPattern field if non-nil, zero value otherwise. + +### GetReferralPatternOk + +`func (o *NewReferralsForMultipleAdvocates) GetReferralPatternOk() (string, bool)` + +GetReferralPatternOk returns a tuple with the ReferralPattern field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReferralPattern + +`func (o *NewReferralsForMultipleAdvocates) HasReferralPattern() bool` + +HasReferralPattern returns a boolean if a field has been set. + +### SetReferralPattern + +`func (o *NewReferralsForMultipleAdvocates) SetReferralPattern(v string)` + +SetReferralPattern gets a reference to the given string and assigns it to the ReferralPattern field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/NewRole.md b/docs/NewRole.md index 2f385174..ca949fb0 100644 --- a/docs/NewRole.md +++ b/docs/NewRole.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **Name** | Pointer to **string** | Name of the role | **Description** | Pointer to **string** | Description of the role | [optional] **Acl** | Pointer to **string** | Role Policy this should be a stringified blob of json | -**Users** | Pointer to **[]int32** | An array of userIDs | +**Users** | Pointer to **[]int32** | An array of user identifiers | ## Methods diff --git a/docs/Referral.md b/docs/Referral.md index 2fb156d7..1a45752f 100644 --- a/docs/Referral.md +++ b/docs/Referral.md @@ -6,14 +6,17 @@ 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. | -**CampaignId** | Pointer to **int32** | ID of the campaign from which the referral received the referral code. | -**AdvocateProfileIntegrationId** | Pointer to **string** | The Integration Id of the Advocate's Profile | -**FriendProfileIntegrationId** | Pointer to **string** | An optional Integration ID of the Friend's Profile | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] +**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | +**CampaignId** | Pointer to **int32** | ID of the campaign from which the referral received the referral code. | +**AdvocateProfileIntegrationId** | Pointer to **string** | The Integration ID of the Advocate's Profile. | +**FriendProfileIntegrationId** | Pointer to **string** | An optional Integration ID of the Friend's Profile | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] +**ImportId** | Pointer to **int32** | The ID of the Import which created this referral. | [optional] **Code** | Pointer to **string** | The actual referral code. | **UsageCounter** | Pointer to **int32** | The number of times this referral code has been successfully used. | -**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | +**BatchId** | Pointer to **string** | The ID of the batch the referrals belong to. | [optional] ## Methods @@ -67,6 +70,81 @@ 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. +### GetStartDate + +`func (o *Referral) GetStartDate() time.Time` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *Referral) 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 *Referral) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *Referral) SetStartDate(v time.Time)` + +SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. + +### GetExpiryDate + +`func (o *Referral) GetExpiryDate() time.Time` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *Referral) 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 *Referral) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *Referral) SetExpiryDate(v time.Time)` + +SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. + +### GetUsageLimit + +`func (o *Referral) GetUsageLimit() int32` + +GetUsageLimit returns the UsageLimit field if non-nil, zero value otherwise. + +### GetUsageLimitOk + +`func (o *Referral) GetUsageLimitOk() (int32, bool)` + +GetUsageLimitOk returns a tuple with the UsageLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUsageLimit + +`func (o *Referral) HasUsageLimit() bool` + +HasUsageLimit returns a boolean if a field has been set. + +### SetUsageLimit + +`func (o *Referral) SetUsageLimit(v int32)` + +SetUsageLimit gets a reference to the given int32 and assigns it to the UsageLimit field. + ### GetCampaignId `func (o *Referral) GetCampaignId() int32` @@ -142,55 +220,55 @@ HasFriendProfileIntegrationId returns a boolean if a field has been set. SetFriendProfileIntegrationId gets a reference to the given string and assigns it to the FriendProfileIntegrationId field. -### GetStartDate +### GetAttributes -`func (o *Referral) GetStartDate() time.Time` +`func (o *Referral) GetAttributes() map[string]interface{}` -GetStartDate returns the StartDate field if non-nil, zero value otherwise. +GetAttributes returns the Attributes field if non-nil, zero value otherwise. -### GetStartDateOk +### GetAttributesOk -`func (o *Referral) GetStartDateOk() (time.Time, bool)` +`func (o *Referral) GetAttributesOk() (map[string]interface{}, bool)` -GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +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. -### HasStartDate +### HasAttributes -`func (o *Referral) HasStartDate() bool` +`func (o *Referral) HasAttributes() bool` -HasStartDate returns a boolean if a field has been set. +HasAttributes returns a boolean if a field has been set. -### SetStartDate +### SetAttributes -`func (o *Referral) SetStartDate(v time.Time)` +`func (o *Referral) SetAttributes(v map[string]interface{})` -SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. -### GetExpiryDate +### GetImportId -`func (o *Referral) GetExpiryDate() time.Time` +`func (o *Referral) GetImportId() int32` -GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. +GetImportId returns the ImportId field if non-nil, zero value otherwise. -### GetExpiryDateOk +### GetImportIdOk -`func (o *Referral) GetExpiryDateOk() (time.Time, bool)` +`func (o *Referral) GetImportIdOk() (int32, bool)` -GetExpiryDateOk returns a tuple with the ExpiryDate field if it's non-nil, zero value otherwise +GetImportIdOk returns a tuple with the ImportId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasExpiryDate +### HasImportId -`func (o *Referral) HasExpiryDate() bool` +`func (o *Referral) HasImportId() bool` -HasExpiryDate returns a boolean if a field has been set. +HasImportId returns a boolean if a field has been set. -### SetExpiryDate +### SetImportId -`func (o *Referral) SetExpiryDate(v time.Time)` +`func (o *Referral) SetImportId(v int32)` -SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +SetImportId gets a reference to the given int32 and assigns it to the ImportId field. ### GetCode @@ -242,30 +320,30 @@ HasUsageCounter returns a boolean if a field has been set. SetUsageCounter gets a reference to the given int32 and assigns it to the UsageCounter field. -### GetUsageLimit +### GetBatchId -`func (o *Referral) GetUsageLimit() int32` +`func (o *Referral) GetBatchId() string` -GetUsageLimit returns the UsageLimit field if non-nil, zero value otherwise. +GetBatchId returns the BatchId field if non-nil, zero value otherwise. -### GetUsageLimitOk +### GetBatchIdOk -`func (o *Referral) GetUsageLimitOk() (int32, bool)` +`func (o *Referral) GetBatchIdOk() (string, bool)` -GetUsageLimitOk returns a tuple with the UsageLimit field if it's non-nil, zero value otherwise +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasUsageLimit +### HasBatchId -`func (o *Referral) HasUsageLimit() bool` +`func (o *Referral) HasBatchId() bool` -HasUsageLimit returns a boolean if a field has been set. +HasBatchId returns a boolean if a field has been set. -### SetUsageLimit +### SetBatchId -`func (o *Referral) SetUsageLimit(v int32)` +`func (o *Referral) SetBatchId(v string)` -SetUsageLimit gets a reference to the given int32 and assigns it to the UsageLimit field. +SetBatchId gets a reference to the given string and assigns it to the BatchId field. [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ReferralConstraints.md b/docs/ReferralConstraints.md new file mode 100644 index 00000000..5ebb2684 --- /dev/null +++ b/docs/ReferralConstraints.md @@ -0,0 +1,91 @@ +# ReferralConstraints + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] +**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional] + +## Methods + +### GetStartDate + +`func (o *ReferralConstraints) GetStartDate() time.Time` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *ReferralConstraints) 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 *ReferralConstraints) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *ReferralConstraints) SetStartDate(v time.Time)` + +SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. + +### GetExpiryDate + +`func (o *ReferralConstraints) GetExpiryDate() time.Time` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *ReferralConstraints) 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 *ReferralConstraints) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *ReferralConstraints) SetExpiryDate(v time.Time)` + +SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. + +### GetUsageLimit + +`func (o *ReferralConstraints) GetUsageLimit() int32` + +GetUsageLimit returns the UsageLimit field if non-nil, zero value otherwise. + +### GetUsageLimitOk + +`func (o *ReferralConstraints) GetUsageLimitOk() (int32, bool)` + +GetUsageLimitOk returns a tuple with the UsageLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUsageLimit + +`func (o *ReferralConstraints) HasUsageLimit() bool` + +HasUsageLimit returns a boolean if a field has been set. + +### SetUsageLimit + +`func (o *ReferralConstraints) SetUsageLimit(v int32)` + +SetUsageLimit gets a reference to the given int32 and assigns it to the UsageLimit field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Role.md b/docs/Role.md index 5ef2d7a6..3992bdd4 100644 --- a/docs/Role.md +++ b/docs/Role.md @@ -4,13 +4,15 @@ 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. | +**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. | **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] +**Name** | Pointer to **string** | Name of the role | **Description** | Pointer to **string** | Description of the role | [optional] **Members** | Pointer to **[]int32** | A list of user identifiers assigned to this role | [optional] -**Acl** | Pointer to [**map[string]interface{}**](.md) | Role ACL Policy | [optional] +**Acl** | Pointer to [**map[string]interface{}**](.md) | Role ACL Policy | ## Methods @@ -39,30 +41,80 @@ HasId returns a boolean if a field has been set. SetId gets a reference to the given int32 and assigns it to the Id field. -### GetAccountID +### GetCreated -`func (o *Role) GetAccountID() int32` +`func (o *Role) GetCreated() time.Time` -GetAccountID returns the AccountID field if non-nil, zero value otherwise. +GetCreated returns the Created field if non-nil, zero value otherwise. -### GetAccountIDOk +### GetCreatedOk -`func (o *Role) GetAccountIDOk() (int32, bool)` +`func (o *Role) GetCreatedOk() (time.Time, bool)` -GetAccountIDOk returns a tuple with the AccountID field if it's non-nil, zero value otherwise +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. -### HasAccountID +### HasCreated -`func (o *Role) HasAccountID() bool` +`func (o *Role) HasCreated() bool` -HasAccountID returns a boolean if a field has been set. +HasCreated returns a boolean if a field has been set. -### SetAccountID +### SetCreated -`func (o *Role) SetAccountID(v int32)` +`func (o *Role) SetCreated(v time.Time)` -SetAccountID gets a reference to the given int32 and assigns it to the AccountID field. +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetModified + +`func (o *Role) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *Role) 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 *Role) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *Role) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + +### GetAccountId + +`func (o *Role) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *Role) 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 *Role) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *Role) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. ### GetCampaignGroupID diff --git a/docs/UpdateCustomEffect.md b/docs/UpdateCustomEffect.md new file mode 100644 index 00000000..3f98a1e2 --- /dev/null +++ b/docs/UpdateCustomEffect.md @@ -0,0 +1,195 @@ +# UpdateCustomEffect + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of this effect. | +**Title** | Pointer to **string** | The title of this effect. | +**Payload** | Pointer to **string** | The JSON payload of this effect. | +**Description** | Pointer to **string** | The description of this effect. | [optional] +**Enabled** | Pointer to **bool** | Determines if this effect is active. | +**SubscribedApplicationsIds** | Pointer to **[]int32** | A list of the IDs of the applications that this effect is enabled for | [optional] +**Params** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | Array of template argument definitions | [optional] + +## Methods + +### GetName + +`func (o *UpdateCustomEffect) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UpdateCustomEffect) 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 *UpdateCustomEffect) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *UpdateCustomEffect) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetTitle + +`func (o *UpdateCustomEffect) GetTitle() string` + +GetTitle returns the Title field if non-nil, zero value otherwise. + +### GetTitleOk + +`func (o *UpdateCustomEffect) 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 *UpdateCustomEffect) HasTitle() bool` + +HasTitle returns a boolean if a field has been set. + +### SetTitle + +`func (o *UpdateCustomEffect) SetTitle(v string)` + +SetTitle gets a reference to the given string and assigns it to the Title field. + +### GetPayload + +`func (o *UpdateCustomEffect) GetPayload() string` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *UpdateCustomEffect) GetPayloadOk() (string, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPayload + +`func (o *UpdateCustomEffect) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + +### SetPayload + +`func (o *UpdateCustomEffect) SetPayload(v string)` + +SetPayload gets a reference to the given string and assigns it to the Payload field. + +### GetDescription + +`func (o *UpdateCustomEffect) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *UpdateCustomEffect) 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 *UpdateCustomEffect) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *UpdateCustomEffect) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetEnabled + +`func (o *UpdateCustomEffect) GetEnabled() bool` + +GetEnabled returns the Enabled field if non-nil, zero value otherwise. + +### GetEnabledOk + +`func (o *UpdateCustomEffect) GetEnabledOk() (bool, bool)` + +GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnabled + +`func (o *UpdateCustomEffect) HasEnabled() bool` + +HasEnabled returns a boolean if a field has been set. + +### SetEnabled + +`func (o *UpdateCustomEffect) SetEnabled(v bool)` + +SetEnabled gets a reference to the given bool and assigns it to the Enabled field. + +### GetSubscribedApplicationsIds + +`func (o *UpdateCustomEffect) GetSubscribedApplicationsIds() []int32` + +GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field if non-nil, zero value otherwise. + +### GetSubscribedApplicationsIdsOk + +`func (o *UpdateCustomEffect) 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 *UpdateCustomEffect) HasSubscribedApplicationsIds() bool` + +HasSubscribedApplicationsIds returns a boolean if a field has been set. + +### SetSubscribedApplicationsIds + +`func (o *UpdateCustomEffect) SetSubscribedApplicationsIds(v []int32)` + +SetSubscribedApplicationsIds gets a reference to the given []int32 and assigns it to the SubscribedApplicationsIds field. + +### GetParams + +`func (o *UpdateCustomEffect) GetParams() []TemplateArgDef` + +GetParams returns the Params field if non-nil, zero value otherwise. + +### GetParamsOk + +`func (o *UpdateCustomEffect) GetParamsOk() ([]TemplateArgDef, bool)` + +GetParamsOk returns a tuple with the Params field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasParams + +`func (o *UpdateCustomEffect) HasParams() bool` + +HasParams returns a boolean if a field has been set. + +### SetParams + +`func (o *UpdateCustomEffect) SetParams(v []TemplateArgDef)` + +SetParams gets a reference to the given []TemplateArgDef and assigns it to the Params field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateLoyaltyTier.md b/docs/UpdateLoyaltyTier.md new file mode 100644 index 00000000..1c40e77d --- /dev/null +++ b/docs/UpdateLoyaltyTier.md @@ -0,0 +1,65 @@ +# UpdateLoyaltyTier + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the tier | +**MinPoints** | Pointer to **float32** | The minimum amount of points required to be eligible for the tier | + +## Methods + +### GetName + +`func (o *UpdateLoyaltyTier) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UpdateLoyaltyTier) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *UpdateLoyaltyTier) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *UpdateLoyaltyTier) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetMinPoints + +`func (o *UpdateLoyaltyTier) GetMinPoints() float32` + +GetMinPoints returns the MinPoints field if non-nil, zero value otherwise. + +### GetMinPointsOk + +`func (o *UpdateLoyaltyTier) GetMinPointsOk() (float32, bool)` + +GetMinPointsOk returns a tuple with the MinPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasMinPoints + +`func (o *UpdateLoyaltyTier) HasMinPoints() bool` + +HasMinPoints returns a boolean if a field has been set. + +### SetMinPoints + +`func (o *UpdateLoyaltyTier) SetMinPoints(v float32)` + +SetMinPoints gets a reference to the given float32 and assigns it to the MinPoints field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateReferral.md b/docs/UpdateReferral.md new file mode 100644 index 00000000..ac80a797 --- /dev/null +++ b/docs/UpdateReferral.md @@ -0,0 +1,143 @@ +# UpdateReferral + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FriendProfileIntegrationId** | Pointer to **string** | An optional Integration ID of the Friend's Profile | [optional] +**StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] +**UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item | [optional] + +## Methods + +### GetFriendProfileIntegrationId + +`func (o *UpdateReferral) GetFriendProfileIntegrationId() string` + +GetFriendProfileIntegrationId returns the FriendProfileIntegrationId field if non-nil, zero value otherwise. + +### GetFriendProfileIntegrationIdOk + +`func (o *UpdateReferral) GetFriendProfileIntegrationIdOk() (string, bool)` + +GetFriendProfileIntegrationIdOk returns a tuple with the FriendProfileIntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasFriendProfileIntegrationId + +`func (o *UpdateReferral) HasFriendProfileIntegrationId() bool` + +HasFriendProfileIntegrationId returns a boolean if a field has been set. + +### SetFriendProfileIntegrationId + +`func (o *UpdateReferral) SetFriendProfileIntegrationId(v string)` + +SetFriendProfileIntegrationId gets a reference to the given string and assigns it to the FriendProfileIntegrationId field. + +### GetStartDate + +`func (o *UpdateReferral) GetStartDate() time.Time` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *UpdateReferral) 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 *UpdateReferral) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *UpdateReferral) SetStartDate(v time.Time)` + +SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. + +### GetExpiryDate + +`func (o *UpdateReferral) GetExpiryDate() time.Time` + +GetExpiryDate returns the ExpiryDate field if non-nil, zero value otherwise. + +### GetExpiryDateOk + +`func (o *UpdateReferral) 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 *UpdateReferral) HasExpiryDate() bool` + +HasExpiryDate returns a boolean if a field has been set. + +### SetExpiryDate + +`func (o *UpdateReferral) SetExpiryDate(v time.Time)` + +SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. + +### GetUsageLimit + +`func (o *UpdateReferral) GetUsageLimit() int32` + +GetUsageLimit returns the UsageLimit field if non-nil, zero value otherwise. + +### GetUsageLimitOk + +`func (o *UpdateReferral) GetUsageLimitOk() (int32, bool)` + +GetUsageLimitOk returns a tuple with the UsageLimit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUsageLimit + +`func (o *UpdateReferral) HasUsageLimit() bool` + +HasUsageLimit returns a boolean if a field has been set. + +### SetUsageLimit + +`func (o *UpdateReferral) SetUsageLimit(v int32)` + +SetUsageLimit gets a reference to the given int32 and assigns it to the UsageLimit field. + +### GetAttributes + +`func (o *UpdateReferral) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *UpdateReferral) 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 *UpdateReferral) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *UpdateReferral) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdateRole.md b/docs/UpdateRole.md index 450b1c15..0a103315 100644 --- a/docs/UpdateRole.md +++ b/docs/UpdateRole.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **Name** | Pointer to **string** | Name of the role | [optional] **Description** | Pointer to **string** | Description of the role | [optional] **Acl** | Pointer to **string** | Role Policy this should be a stringified blob of json | [optional] -**Users** | Pointer to **[]int32** | an array of user identifiers | [optional] +**Users** | Pointer to **[]int32** | An array of user identifiers | [optional] ## Methods diff --git a/docs/WillAwardGiveawayEffectProps.md b/docs/WillAwardGiveawayEffectProps.md new file mode 100644 index 00000000..501e7bf6 --- /dev/null +++ b/docs/WillAwardGiveawayEffectProps.md @@ -0,0 +1,91 @@ +# WillAwardGiveawayEffectProps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PoolId** | Pointer to **int32** | The ID of the giveaways pool the code will be taken from. | +**PoolName** | Pointer to **string** | The name of the giveaways pool the code will be taken from. | +**RecipientIntegrationId** | Pointer to **string** | The integration ID of the profile that will be awarded the giveaway. | + +## Methods + +### GetPoolId + +`func (o *WillAwardGiveawayEffectProps) GetPoolId() int32` + +GetPoolId returns the PoolId field if non-nil, zero value otherwise. + +### GetPoolIdOk + +`func (o *WillAwardGiveawayEffectProps) GetPoolIdOk() (int32, bool)` + +GetPoolIdOk returns a tuple with the PoolId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPoolId + +`func (o *WillAwardGiveawayEffectProps) HasPoolId() bool` + +HasPoolId returns a boolean if a field has been set. + +### SetPoolId + +`func (o *WillAwardGiveawayEffectProps) SetPoolId(v int32)` + +SetPoolId gets a reference to the given int32 and assigns it to the PoolId field. + +### GetPoolName + +`func (o *WillAwardGiveawayEffectProps) GetPoolName() string` + +GetPoolName returns the PoolName field if non-nil, zero value otherwise. + +### GetPoolNameOk + +`func (o *WillAwardGiveawayEffectProps) GetPoolNameOk() (string, bool)` + +GetPoolNameOk returns a tuple with the PoolName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPoolName + +`func (o *WillAwardGiveawayEffectProps) HasPoolName() bool` + +HasPoolName returns a boolean if a field has been set. + +### SetPoolName + +`func (o *WillAwardGiveawayEffectProps) SetPoolName(v string)` + +SetPoolName gets a reference to the given string and assigns it to the PoolName field. + +### GetRecipientIntegrationId + +`func (o *WillAwardGiveawayEffectProps) GetRecipientIntegrationId() string` + +GetRecipientIntegrationId returns the RecipientIntegrationId field if non-nil, zero value otherwise. + +### GetRecipientIntegrationIdOk + +`func (o *WillAwardGiveawayEffectProps) GetRecipientIntegrationIdOk() (string, bool)` + +GetRecipientIntegrationIdOk returns a tuple with the RecipientIntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRecipientIntegrationId + +`func (o *WillAwardGiveawayEffectProps) HasRecipientIntegrationId() bool` + +HasRecipientIntegrationId returns a boolean if a field has been set. + +### SetRecipientIntegrationId + +`func (o *WillAwardGiveawayEffectProps) SetRecipientIntegrationId(v string)` + +SetRecipientIntegrationId gets a reference to the given string and assigns it to the RecipientIntegrationId field. + + +[[Back to Model 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_application_campaign_stats.go b/model_application_campaign_stats.go new file mode 100644 index 00000000..f3c9de20 --- /dev/null +++ b/model_application_campaign_stats.go @@ -0,0 +1,144 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// ApplicationCampaignStats Provides statistics regarding an application's campaigns +type ApplicationCampaignStats struct { + // Number of draft campaigns + Draft int32 `json:"draft"` + // Number of disabled campaigns + Disabled int32 `json:"disabled"` + // Number of scheduled campaigns + Scheduled int32 `json:"scheduled"` + // Number of running campaigns + Running int32 `json:"running"` + // Number of expired campaigns + Expired int32 `json:"expired"` + // Number of archived campaigns + Archived int32 `json:"archived"` +} + +// GetDraft returns the Draft field value +func (o *ApplicationCampaignStats) GetDraft() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Draft +} + +// SetDraft sets field value +func (o *ApplicationCampaignStats) SetDraft(v int32) { + o.Draft = v +} + +// GetDisabled returns the Disabled field value +func (o *ApplicationCampaignStats) GetDisabled() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Disabled +} + +// SetDisabled sets field value +func (o *ApplicationCampaignStats) SetDisabled(v int32) { + o.Disabled = v +} + +// GetScheduled returns the Scheduled field value +func (o *ApplicationCampaignStats) GetScheduled() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Scheduled +} + +// SetScheduled sets field value +func (o *ApplicationCampaignStats) SetScheduled(v int32) { + o.Scheduled = v +} + +// GetRunning returns the Running field value +func (o *ApplicationCampaignStats) GetRunning() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Running +} + +// SetRunning sets field value +func (o *ApplicationCampaignStats) SetRunning(v int32) { + o.Running = v +} + +// GetExpired returns the Expired field value +func (o *ApplicationCampaignStats) GetExpired() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Expired +} + +// SetExpired sets field value +func (o *ApplicationCampaignStats) SetExpired(v int32) { + o.Expired = v +} + +// GetArchived returns the Archived field value +func (o *ApplicationCampaignStats) GetArchived() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Archived +} + +// SetArchived sets field value +func (o *ApplicationCampaignStats) SetArchived(v int32) { + o.Archived = v +} + +type NullableApplicationCampaignStats struct { + Value ApplicationCampaignStats + ExplicitNull bool +} + +func (v NullableApplicationCampaignStats) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableApplicationCampaignStats) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_application_referee.go b/model_application_referee.go new file mode 100644 index 00000000..80da5ccd --- /dev/null +++ b/model_application_referee.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" +) + +// ApplicationReferee +type ApplicationReferee struct { + // The ID of the application that owns this entity. + ApplicationId int32 `json:"applicationId"` + // Integration ID of the session in which the customer redeemed the referral + SessionId string `json:"sessionId"` + // Integration ID of the Advocate's Profile + AdvocateIntegrationId string `json:"advocateIntegrationId"` + // Integration ID of the Friend's Profile + FriendIntegrationId string `json:"friendIntegrationId"` + // Advocate's referral code. + Code string `json:"code"` + // Timestamp of the moment the customer redeemed the referral + Created time.Time `json:"created"` +} + +// GetApplicationId returns the ApplicationId field value +func (o *ApplicationReferee) GetApplicationId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ApplicationId +} + +// SetApplicationId sets field value +func (o *ApplicationReferee) SetApplicationId(v int32) { + o.ApplicationId = v +} + +// GetSessionId returns the SessionId field value +func (o *ApplicationReferee) GetSessionId() string { + if o == nil { + var ret string + return ret + } + + return o.SessionId +} + +// SetSessionId sets field value +func (o *ApplicationReferee) SetSessionId(v string) { + o.SessionId = v +} + +// GetAdvocateIntegrationId returns the AdvocateIntegrationId field value +func (o *ApplicationReferee) GetAdvocateIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.AdvocateIntegrationId +} + +// SetAdvocateIntegrationId sets field value +func (o *ApplicationReferee) SetAdvocateIntegrationId(v string) { + o.AdvocateIntegrationId = v +} + +// GetFriendIntegrationId returns the FriendIntegrationId field value +func (o *ApplicationReferee) GetFriendIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.FriendIntegrationId +} + +// SetFriendIntegrationId sets field value +func (o *ApplicationReferee) SetFriendIntegrationId(v string) { + o.FriendIntegrationId = v +} + +// GetCode returns the Code field value +func (o *ApplicationReferee) GetCode() string { + if o == nil { + var ret string + return ret + } + + return o.Code +} + +// SetCode sets field value +func (o *ApplicationReferee) SetCode(v string) { + o.Code = v +} + +// GetCreated returns the Created field value +func (o *ApplicationReferee) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *ApplicationReferee) SetCreated(v time.Time) { + o.Created = v +} + +type NullableApplicationReferee struct { + Value ApplicationReferee + ExplicitNull bool +} + +func (v NullableApplicationReferee) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableApplicationReferee) 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_award_giveaway_effect_props.go b/model_award_giveaway_effect_props.go new file mode 100644 index 00000000..0896843e --- /dev/null +++ b/model_award_giveaway_effect_props.go @@ -0,0 +1,127 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// AwardGiveawayEffectProps The properties specific to the \"awardGiveaway\" effect. This effect contains information on the giveaway item, and which profile it was awarded to. +type AwardGiveawayEffectProps struct { + // The ID of the giveaways pool the code was taken from. + PoolId int32 `json:"poolId"` + // The name of the giveaways pool the code was taken from. + PoolName string `json:"poolName"` + // The integration ID of the profile that was awarded the giveaway. + RecipientIntegrationId string `json:"recipientIntegrationId"` + // The internal ID for the giveaway that was awarded. + GiveawayId int32 `json:"giveawayId"` + // The giveaway code that was awarded. + Code string `json:"code"` +} + +// GetPoolId returns the PoolId field value +func (o *AwardGiveawayEffectProps) GetPoolId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.PoolId +} + +// SetPoolId sets field value +func (o *AwardGiveawayEffectProps) SetPoolId(v int32) { + o.PoolId = v +} + +// GetPoolName returns the PoolName field value +func (o *AwardGiveawayEffectProps) GetPoolName() string { + if o == nil { + var ret string + return ret + } + + return o.PoolName +} + +// SetPoolName sets field value +func (o *AwardGiveawayEffectProps) SetPoolName(v string) { + o.PoolName = v +} + +// GetRecipientIntegrationId returns the RecipientIntegrationId field value +func (o *AwardGiveawayEffectProps) GetRecipientIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.RecipientIntegrationId +} + +// SetRecipientIntegrationId sets field value +func (o *AwardGiveawayEffectProps) SetRecipientIntegrationId(v string) { + o.RecipientIntegrationId = v +} + +// GetGiveawayId returns the GiveawayId field value +func (o *AwardGiveawayEffectProps) GetGiveawayId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.GiveawayId +} + +// SetGiveawayId sets field value +func (o *AwardGiveawayEffectProps) SetGiveawayId(v int32) { + o.GiveawayId = v +} + +// GetCode returns the Code field value +func (o *AwardGiveawayEffectProps) GetCode() string { + if o == nil { + var ret string + return ret + } + + return o.Code +} + +// SetCode sets field value +func (o *AwardGiveawayEffectProps) SetCode(v string) { + o.Code = v +} + +type NullableAwardGiveawayEffectProps struct { + Value AwardGiveawayEffectProps + ExplicitNull bool +} + +func (v NullableAwardGiveawayEffectProps) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAwardGiveawayEffectProps) 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 79661963..b5ec2053 100644 --- a/model_campaign.go +++ b/model_campaign.go @@ -61,6 +61,8 @@ type Campaign struct { CouponCreationCount *int32 `json:"couponCreationCount,omitempty"` // Total number of referrals created by rules in this campaign. ReferralCreationCount *int32 `json:"referralCreationCount,omitempty"` + // Total number of giveaways awarded by rules in this campaign. + AwardedGiveawaysCount *int32 `json:"awardedGiveawaysCount,omitempty"` // Total number of loyalty points created by rules in this campaign. CreatedLoyaltyPointsCount *float32 `json:"createdLoyaltyPointsCount,omitempty"` // Total number of loyalty point creation effects triggered by rules in this campaign. @@ -658,6 +660,39 @@ func (o *Campaign) SetReferralCreationCount(v int32) { o.ReferralCreationCount = &v } +// GetAwardedGiveawaysCount returns the AwardedGiveawaysCount field value if set, zero value otherwise. +func (o *Campaign) GetAwardedGiveawaysCount() int32 { + if o == nil || o.AwardedGiveawaysCount == nil { + var ret int32 + return ret + } + return *o.AwardedGiveawaysCount +} + +// GetAwardedGiveawaysCountOk returns a tuple with the AwardedGiveawaysCount field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Campaign) GetAwardedGiveawaysCountOk() (int32, bool) { + if o == nil || o.AwardedGiveawaysCount == nil { + var ret int32 + return ret, false + } + return *o.AwardedGiveawaysCount, true +} + +// HasAwardedGiveawaysCount returns a boolean if a field has been set. +func (o *Campaign) HasAwardedGiveawaysCount() bool { + if o != nil && o.AwardedGiveawaysCount != nil { + return true + } + + return false +} + +// SetAwardedGiveawaysCount gets a reference to the given int32 and assigns it to the AwardedGiveawaysCount field. +func (o *Campaign) SetAwardedGiveawaysCount(v int32) { + o.AwardedGiveawaysCount = &v +} + // GetCreatedLoyaltyPointsCount returns the CreatedLoyaltyPointsCount field value if set, zero value otherwise. func (o *Campaign) GetCreatedLoyaltyPointsCount() float32 { if o == nil || o.CreatedLoyaltyPointsCount == nil { diff --git a/model_coupon.go b/model_coupon.go index fcdd1920..19b36ab0 100644 --- a/model_coupon.go +++ b/model_coupon.go @@ -47,7 +47,7 @@ type Coupon struct { RecipientIntegrationId *string `json:"recipientIntegrationId,omitempty"` // The ID of the Import which created this coupon. ImportId *int32 `json:"importId,omitempty"` - // This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favourite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. + // This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favorite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. Reservation *bool `json:"reservation,omitempty"` // The id of the batch the coupon belongs to. BatchId *string `json:"batchId,omitempty"` diff --git a/model_custom_effect.go b/model_custom_effect.go new file mode 100644 index 00000000..a1a37498 --- /dev/null +++ b/model_custom_effect.go @@ -0,0 +1,336 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// CustomEffect +type CustomEffect struct { + // Unique ID for this entity. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The ID of the account that owns this entity. + AccountId int32 `json:"accountId"` + // The exact moment this entity was last modified. + Modified time.Time `json:"modified"` + // The name of this effect. + Name string `json:"name"` + // The title of this effect. + Title string `json:"title"` + // The JSON payload of this effect. + Payload string `json:"payload"` + // The description of this effect. + Description *string `json:"description,omitempty"` + // Determines if this effect is active. + Enabled bool `json:"enabled"` + // A list of the IDs of the applications that this effect is enabled for + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // Array of template argument definitions + Params *[]TemplateArgDef `json:"params,omitempty"` + // ID of the user who last updated this effect if available. + ModifiedBy *int32 `json:"modifiedBy,omitempty"` + // ID of the user who created this effect. + CreatedBy int32 `json:"createdBy"` +} + +// GetId returns the Id field value +func (o *CustomEffect) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *CustomEffect) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *CustomEffect) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *CustomEffect) SetCreated(v time.Time) { + o.Created = v +} + +// GetAccountId returns the AccountId field value +func (o *CustomEffect) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *CustomEffect) SetAccountId(v int32) { + o.AccountId = v +} + +// GetModified returns the Modified field value +func (o *CustomEffect) GetModified() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Modified +} + +// SetModified sets field value +func (o *CustomEffect) SetModified(v time.Time) { + o.Modified = v +} + +// GetName returns the Name field value +func (o *CustomEffect) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *CustomEffect) SetName(v string) { + o.Name = v +} + +// GetTitle returns the Title field value +func (o *CustomEffect) GetTitle() string { + if o == nil { + var ret string + return ret + } + + return o.Title +} + +// SetTitle sets field value +func (o *CustomEffect) SetTitle(v string) { + o.Title = v +} + +// GetPayload returns the Payload field value +func (o *CustomEffect) GetPayload() string { + if o == nil { + var ret string + return ret + } + + return o.Payload +} + +// SetPayload sets field value +func (o *CustomEffect) SetPayload(v string) { + o.Payload = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *CustomEffect) 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 *CustomEffect) 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 *CustomEffect) 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 *CustomEffect) SetDescription(v string) { + o.Description = &v +} + +// GetEnabled returns the Enabled field value +func (o *CustomEffect) GetEnabled() bool { + if o == nil { + var ret bool + return ret + } + + return o.Enabled +} + +// SetEnabled sets field value +func (o *CustomEffect) SetEnabled(v bool) { + o.Enabled = v +} + +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *CustomEffect) 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 *CustomEffect) 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 *CustomEffect) 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 *CustomEffect) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +// GetParams returns the Params field value if set, zero value otherwise. +func (o *CustomEffect) GetParams() []TemplateArgDef { + if o == nil || o.Params == nil { + var ret []TemplateArgDef + return ret + } + return *o.Params +} + +// GetParamsOk returns a tuple with the Params field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CustomEffect) GetParamsOk() ([]TemplateArgDef, bool) { + if o == nil || o.Params == nil { + var ret []TemplateArgDef + return ret, false + } + return *o.Params, true +} + +// HasParams returns a boolean if a field has been set. +func (o *CustomEffect) HasParams() bool { + if o != nil && o.Params != nil { + return true + } + + return false +} + +// SetParams gets a reference to the given []TemplateArgDef and assigns it to the Params field. +func (o *CustomEffect) SetParams(v []TemplateArgDef) { + o.Params = &v +} + +// GetModifiedBy returns the ModifiedBy field value if set, zero value otherwise. +func (o *CustomEffect) GetModifiedBy() int32 { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret + } + return *o.ModifiedBy +} + +// GetModifiedByOk returns a tuple with the ModifiedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CustomEffect) GetModifiedByOk() (int32, bool) { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret, false + } + return *o.ModifiedBy, true +} + +// HasModifiedBy returns a boolean if a field has been set. +func (o *CustomEffect) HasModifiedBy() bool { + if o != nil && o.ModifiedBy != nil { + return true + } + + return false +} + +// SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. +func (o *CustomEffect) SetModifiedBy(v int32) { + o.ModifiedBy = &v +} + +// GetCreatedBy returns the CreatedBy field value +func (o *CustomEffect) GetCreatedBy() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CreatedBy +} + +// SetCreatedBy sets field value +func (o *CustomEffect) SetCreatedBy(v int32) { + o.CreatedBy = v +} + +type NullableCustomEffect struct { + Value CustomEffect + ExplicitNull bool +} + +func (v NullableCustomEffect) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCustomEffect) 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_custom_effect_props.go b/model_custom_effect_props.go new file mode 100644 index 00000000..9917ad16 --- /dev/null +++ b/model_custom_effect_props.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" +) + +// CustomEffectProps Effect containing custom payload. +type CustomEffectProps struct { + // The type of the custom effect. + Type string `json:"type"` + // The JSON payload of the custom effect. + Payload map[string]interface{} `json:"payload"` +} + +// GetType returns the Type field value +func (o *CustomEffectProps) GetType() string { + if o == nil { + var ret string + return ret + } + + return o.Type +} + +// SetType sets field value +func (o *CustomEffectProps) SetType(v string) { + o.Type = v +} + +// GetPayload returns the Payload field value +func (o *CustomEffectProps) GetPayload() map[string]interface{} { + if o == nil { + var ret map[string]interface{} + return ret + } + + return o.Payload +} + +// SetPayload sets field value +func (o *CustomEffectProps) SetPayload(v map[string]interface{}) { + o.Payload = v +} + +type NullableCustomEffectProps struct { + Value CustomEffectProps + ExplicitNull bool +} + +func (v NullableCustomEffectProps) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCustomEffectProps) 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_inventory.go b/model_customer_inventory.go index 19336599..4ef231cf 100644 --- a/model_customer_inventory.go +++ b/model_customer_inventory.go @@ -16,10 +16,11 @@ 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"` + Profile *CustomerProfile `json:"profile,omitempty"` + Loyalty *Loyalty `json:"loyalty,omitempty"` + Referrals *[]Referral `json:"referrals,omitempty"` + Coupons *[]InventoryCoupon `json:"coupons,omitempty"` + Giveaways *[]Giveaway `json:"giveaways,omitempty"` } // GetProfile returns the Profile field value if set, zero value otherwise. @@ -122,9 +123,9 @@ func (o *CustomerInventory) SetReferrals(v []Referral) { } // GetCoupons returns the Coupons field value if set, zero value otherwise. -func (o *CustomerInventory) GetCoupons() []Coupon { +func (o *CustomerInventory) GetCoupons() []InventoryCoupon { if o == nil || o.Coupons == nil { - var ret []Coupon + var ret []InventoryCoupon return ret } return *o.Coupons @@ -132,9 +133,9 @@ func (o *CustomerInventory) GetCoupons() []Coupon { // GetCouponsOk returns a tuple with the Coupons field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *CustomerInventory) GetCouponsOk() ([]Coupon, bool) { +func (o *CustomerInventory) GetCouponsOk() ([]InventoryCoupon, bool) { if o == nil || o.Coupons == nil { - var ret []Coupon + var ret []InventoryCoupon return ret, false } return *o.Coupons, true @@ -149,11 +150,44 @@ func (o *CustomerInventory) HasCoupons() bool { return false } -// SetCoupons gets a reference to the given []Coupon and assigns it to the Coupons field. -func (o *CustomerInventory) SetCoupons(v []Coupon) { +// SetCoupons gets a reference to the given []InventoryCoupon and assigns it to the Coupons field. +func (o *CustomerInventory) SetCoupons(v []InventoryCoupon) { o.Coupons = &v } +// GetGiveaways returns the Giveaways field value if set, zero value otherwise. +func (o *CustomerInventory) GetGiveaways() []Giveaway { + if o == nil || o.Giveaways == nil { + var ret []Giveaway + return ret + } + return *o.Giveaways +} + +// GetGiveawaysOk returns a tuple with the Giveaways field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CustomerInventory) GetGiveawaysOk() ([]Giveaway, bool) { + if o == nil || o.Giveaways == nil { + var ret []Giveaway + return ret, false + } + return *o.Giveaways, true +} + +// HasGiveaways returns a boolean if a field has been set. +func (o *CustomerInventory) HasGiveaways() bool { + if o != nil && o.Giveaways != nil { + return true + } + + return false +} + +// SetGiveaways gets a reference to the given []Giveaway and assigns it to the Giveaways field. +func (o *CustomerInventory) SetGiveaways(v []Giveaway) { + o.Giveaways = &v +} + type NullableCustomerInventory struct { Value CustomerInventory ExplicitNull bool diff --git a/model_customer_profile_integration_request_v2.go b/model_customer_profile_integration_request_v2.go index 27f96e69..869cb294 100644 --- a/model_customer_profile_integration_request_v2.go +++ b/model_customer_profile_integration_request_v2.go @@ -19,7 +19,7 @@ type CustomerProfileIntegrationRequestV2 struct { // Arbitrary properties associated with this item Attributes *map[string]interface{} `json:"attributes,omitempty"` AudiencesChanges *ProfileAudiencesChanges `json:"audiencesChanges,omitempty"` - // Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\", \"event\" and \"ruleFailureReasons\". + // Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\", \"event\", \"awardedGiveaways\", \"ruleFailureReasons\". ResponseContent *[]string `json:"responseContent,omitempty"` } diff --git a/model_environment.go b/model_environment.go index ad45c4e9..c791e271 100644 --- a/model_environment.go +++ b/model_environment.go @@ -29,7 +29,17 @@ type Environment struct { Functions []FunctionDef `json:"functions"` // The templates defined for this application. Templates []TemplateDef `json:"templates"` - Variables string `json:"variables"` + // The giveaways pools that the application is subscribed to. + GiveawaysPools *[]GiveawaysPool `json:"giveawaysPools,omitempty"` + // The loyalty programs that the application is subscribed to. + LoyaltyPrograms *[]LoyaltyProgram `json:"loyaltyPrograms,omitempty"` + // The attributes that the application is subscribed to. + Attributes *[]Attribute `json:"attributes,omitempty"` + // The additional costs that the application is subscribed to. + AdditionalCosts *[]AccountAdditionalCost `json:"additionalCosts,omitempty"` + // The audiences contained in the account which the application belongs to. + Audiences *[]Audience `json:"audiences,omitempty"` + Variables string `json:"variables"` } // GetId returns the Id field value @@ -122,6 +132,171 @@ func (o *Environment) SetTemplates(v []TemplateDef) { o.Templates = v } +// GetGiveawaysPools returns the GiveawaysPools field value if set, zero value otherwise. +func (o *Environment) GetGiveawaysPools() []GiveawaysPool { + if o == nil || o.GiveawaysPools == nil { + var ret []GiveawaysPool + return ret + } + return *o.GiveawaysPools +} + +// GetGiveawaysPoolsOk returns a tuple with the GiveawaysPools field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Environment) GetGiveawaysPoolsOk() ([]GiveawaysPool, bool) { + if o == nil || o.GiveawaysPools == nil { + var ret []GiveawaysPool + return ret, false + } + return *o.GiveawaysPools, true +} + +// HasGiveawaysPools returns a boolean if a field has been set. +func (o *Environment) HasGiveawaysPools() bool { + if o != nil && o.GiveawaysPools != nil { + return true + } + + return false +} + +// SetGiveawaysPools gets a reference to the given []GiveawaysPool and assigns it to the GiveawaysPools field. +func (o *Environment) SetGiveawaysPools(v []GiveawaysPool) { + o.GiveawaysPools = &v +} + +// GetLoyaltyPrograms returns the LoyaltyPrograms field value if set, zero value otherwise. +func (o *Environment) GetLoyaltyPrograms() []LoyaltyProgram { + if o == nil || o.LoyaltyPrograms == nil { + var ret []LoyaltyProgram + return ret + } + return *o.LoyaltyPrograms +} + +// GetLoyaltyProgramsOk returns a tuple with the LoyaltyPrograms field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Environment) GetLoyaltyProgramsOk() ([]LoyaltyProgram, bool) { + if o == nil || o.LoyaltyPrograms == nil { + var ret []LoyaltyProgram + return ret, false + } + return *o.LoyaltyPrograms, true +} + +// HasLoyaltyPrograms returns a boolean if a field has been set. +func (o *Environment) HasLoyaltyPrograms() bool { + if o != nil && o.LoyaltyPrograms != nil { + return true + } + + return false +} + +// SetLoyaltyPrograms gets a reference to the given []LoyaltyProgram and assigns it to the LoyaltyPrograms field. +func (o *Environment) SetLoyaltyPrograms(v []LoyaltyProgram) { + o.LoyaltyPrograms = &v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *Environment) GetAttributes() []Attribute { + if o == nil || o.Attributes == nil { + var ret []Attribute + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Environment) GetAttributesOk() ([]Attribute, bool) { + if o == nil || o.Attributes == nil { + var ret []Attribute + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *Environment) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given []Attribute and assigns it to the Attributes field. +func (o *Environment) SetAttributes(v []Attribute) { + o.Attributes = &v +} + +// GetAdditionalCosts returns the AdditionalCosts field value if set, zero value otherwise. +func (o *Environment) GetAdditionalCosts() []AccountAdditionalCost { + if o == nil || o.AdditionalCosts == nil { + var ret []AccountAdditionalCost + return ret + } + return *o.AdditionalCosts +} + +// GetAdditionalCostsOk returns a tuple with the AdditionalCosts field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Environment) GetAdditionalCostsOk() ([]AccountAdditionalCost, bool) { + if o == nil || o.AdditionalCosts == nil { + var ret []AccountAdditionalCost + return ret, false + } + return *o.AdditionalCosts, true +} + +// HasAdditionalCosts returns a boolean if a field has been set. +func (o *Environment) HasAdditionalCosts() bool { + if o != nil && o.AdditionalCosts != nil { + return true + } + + return false +} + +// SetAdditionalCosts gets a reference to the given []AccountAdditionalCost and assigns it to the AdditionalCosts field. +func (o *Environment) SetAdditionalCosts(v []AccountAdditionalCost) { + o.AdditionalCosts = &v +} + +// GetAudiences returns the Audiences field value if set, zero value otherwise. +func (o *Environment) GetAudiences() []Audience { + if o == nil || o.Audiences == nil { + var ret []Audience + return ret + } + return *o.Audiences +} + +// GetAudiencesOk returns a tuple with the Audiences field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Environment) GetAudiencesOk() ([]Audience, bool) { + if o == nil || o.Audiences == nil { + var ret []Audience + return ret, false + } + return *o.Audiences, true +} + +// HasAudiences returns a boolean if a field has been set. +func (o *Environment) HasAudiences() bool { + if o != nil && o.Audiences != nil { + return true + } + + return false +} + +// SetAudiences gets a reference to the given []Audience and assigns it to the Audiences field. +func (o *Environment) SetAudiences(v []Audience) { + o.Audiences = &v +} + // GetVariables returns the Variables field value func (o *Environment) GetVariables() string { if o == nil { diff --git a/model_giveaway.go b/model_giveaway.go new file mode 100644 index 00000000..24ad2a55 --- /dev/null +++ b/model_giveaway.go @@ -0,0 +1,286 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// Giveaway +type Giveaway struct { + // Unique ID for this entity. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The code value of this giveaway. + Code string `json:"code"` + // The ID of the pool to return giveaway codes from. + PoolId int32 `json:"poolId"` + // Timestamp at which point the giveaway becomes valid. + StartDate *time.Time `json:"startDate,omitempty"` + // Timestamp at which point the giveaway becomes invalid. + EndDate *time.Time `json:"endDate,omitempty"` + // Arbitrary properties associated with this giveaway. + Attributes *map[string]interface{} `json:"attributes,omitempty"` + // Flag indicating whether this giveaway code was given before. + Used *bool `json:"used,omitempty"` + // The ID of the Import which created this giveaway. + ImportId *int32 `json:"importId,omitempty"` +} + +// GetId returns the Id field value +func (o *Giveaway) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *Giveaway) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *Giveaway) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *Giveaway) SetCreated(v time.Time) { + o.Created = v +} + +// GetCode returns the Code field value +func (o *Giveaway) GetCode() string { + if o == nil { + var ret string + return ret + } + + return o.Code +} + +// SetCode sets field value +func (o *Giveaway) SetCode(v string) { + o.Code = v +} + +// GetPoolId returns the PoolId field value +func (o *Giveaway) GetPoolId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.PoolId +} + +// SetPoolId sets field value +func (o *Giveaway) SetPoolId(v int32) { + o.PoolId = v +} + +// GetStartDate returns the StartDate field value if set, zero value otherwise. +func (o *Giveaway) 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 *Giveaway) 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 *Giveaway) 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 *Giveaway) SetStartDate(v time.Time) { + o.StartDate = &v +} + +// GetEndDate returns the EndDate field value if set, zero value otherwise. +func (o *Giveaway) GetEndDate() time.Time { + if o == nil || o.EndDate == nil { + var ret time.Time + return ret + } + return *o.EndDate +} + +// GetEndDateOk returns a tuple with the EndDate field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Giveaway) GetEndDateOk() (time.Time, bool) { + if o == nil || o.EndDate == nil { + var ret time.Time + return ret, false + } + return *o.EndDate, true +} + +// HasEndDate returns a boolean if a field has been set. +func (o *Giveaway) HasEndDate() bool { + if o != nil && o.EndDate != nil { + return true + } + + return false +} + +// SetEndDate gets a reference to the given time.Time and assigns it to the EndDate field. +func (o *Giveaway) SetEndDate(v time.Time) { + o.EndDate = &v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *Giveaway) 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 *Giveaway) 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 *Giveaway) 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 *Giveaway) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +// GetUsed returns the Used field value if set, zero value otherwise. +func (o *Giveaway) GetUsed() bool { + if o == nil || o.Used == nil { + var ret bool + return ret + } + return *o.Used +} + +// GetUsedOk returns a tuple with the Used field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Giveaway) GetUsedOk() (bool, bool) { + if o == nil || o.Used == nil { + var ret bool + return ret, false + } + return *o.Used, true +} + +// HasUsed returns a boolean if a field has been set. +func (o *Giveaway) HasUsed() bool { + if o != nil && o.Used != nil { + return true + } + + return false +} + +// SetUsed gets a reference to the given bool and assigns it to the Used field. +func (o *Giveaway) SetUsed(v bool) { + o.Used = &v +} + +// GetImportId returns the ImportId field value if set, zero value otherwise. +func (o *Giveaway) GetImportId() int32 { + if o == nil || o.ImportId == nil { + var ret int32 + return ret + } + return *o.ImportId +} + +// GetImportIdOk returns a tuple with the ImportId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Giveaway) GetImportIdOk() (int32, bool) { + if o == nil || o.ImportId == nil { + var ret int32 + return ret, false + } + return *o.ImportId, true +} + +// HasImportId returns a boolean if a field has been set. +func (o *Giveaway) HasImportId() bool { + if o != nil && o.ImportId != nil { + return true + } + + return false +} + +// SetImportId gets a reference to the given int32 and assigns it to the ImportId field. +func (o *Giveaway) SetImportId(v int32) { + o.ImportId = &v +} + +type NullableGiveaway struct { + Value Giveaway + ExplicitNull bool +} + +func (v NullableGiveaway) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableGiveaway) 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_giveaways_pool.go b/model_giveaways_pool.go new file mode 100644 index 00000000..4a178e56 --- /dev/null +++ b/model_giveaways_pool.go @@ -0,0 +1,268 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// GiveawaysPool +type GiveawaysPool struct { + // Unique ID for this entity. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The ID of the account that owns this entity. + AccountId int32 `json:"accountId"` + // The name of this giveaways pool. + Name string `json:"name"` + // The description of this giveaways pool. + Description *string `json:"description,omitempty"` + // A list of the IDs of the applications that this giveaways pool is enabled for + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // Timestamp of the most recent update to the giveaways pool. + Modified *time.Time `json:"modified,omitempty"` + // ID of the user who created this giveaways pool. + CreatedBy int32 `json:"createdBy"` + // ID of the user who last updated this giveaways pool if available. + ModifiedBy *int32 `json:"modifiedBy,omitempty"` +} + +// GetId returns the Id field value +func (o *GiveawaysPool) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *GiveawaysPool) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *GiveawaysPool) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *GiveawaysPool) SetCreated(v time.Time) { + o.Created = v +} + +// GetAccountId returns the AccountId field value +func (o *GiveawaysPool) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *GiveawaysPool) SetAccountId(v int32) { + o.AccountId = v +} + +// GetName returns the Name field value +func (o *GiveawaysPool) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *GiveawaysPool) SetName(v string) { + o.Name = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *GiveawaysPool) 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 *GiveawaysPool) 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 *GiveawaysPool) 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 *GiveawaysPool) SetDescription(v string) { + o.Description = &v +} + +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *GiveawaysPool) 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 *GiveawaysPool) 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 *GiveawaysPool) 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 *GiveawaysPool) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +// GetModified returns the Modified field value if set, zero value otherwise. +func (o *GiveawaysPool) GetModified() time.Time { + if o == nil || o.Modified == nil { + var ret time.Time + return ret + } + return *o.Modified +} + +// GetModifiedOk returns a tuple with the Modified field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *GiveawaysPool) GetModifiedOk() (time.Time, bool) { + if o == nil || o.Modified == nil { + var ret time.Time + return ret, false + } + return *o.Modified, true +} + +// HasModified returns a boolean if a field has been set. +func (o *GiveawaysPool) HasModified() bool { + if o != nil && o.Modified != nil { + return true + } + + return false +} + +// SetModified gets a reference to the given time.Time and assigns it to the Modified field. +func (o *GiveawaysPool) SetModified(v time.Time) { + o.Modified = &v +} + +// GetCreatedBy returns the CreatedBy field value +func (o *GiveawaysPool) GetCreatedBy() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CreatedBy +} + +// SetCreatedBy sets field value +func (o *GiveawaysPool) SetCreatedBy(v int32) { + o.CreatedBy = v +} + +// GetModifiedBy returns the ModifiedBy field value if set, zero value otherwise. +func (o *GiveawaysPool) GetModifiedBy() int32 { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret + } + return *o.ModifiedBy +} + +// GetModifiedByOk returns a tuple with the ModifiedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *GiveawaysPool) GetModifiedByOk() (int32, bool) { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret, false + } + return *o.ModifiedBy, true +} + +// HasModifiedBy returns a boolean if a field has been set. +func (o *GiveawaysPool) HasModifiedBy() bool { + if o != nil && o.ModifiedBy != nil { + return true + } + + return false +} + +// SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. +func (o *GiveawaysPool) SetModifiedBy(v int32) { + o.ModifiedBy = &v +} + +type NullableGiveawaysPool struct { + Value GiveawaysPool + ExplicitNull bool +} + +func (v NullableGiveawaysPool) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableGiveawaysPool) 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_import_entity.go b/model_import_entity.go new file mode 100644 index 00000000..2b785697 --- /dev/null +++ b/model_import_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" +) + +// ImportEntity struct for ImportEntity +type ImportEntity struct { + // The ID of the Import which created this referral. + ImportId *int32 `json:"importId,omitempty"` +} + +// GetImportId returns the ImportId field value if set, zero value otherwise. +func (o *ImportEntity) GetImportId() int32 { + if o == nil || o.ImportId == nil { + var ret int32 + return ret + } + return *o.ImportId +} + +// GetImportIdOk returns a tuple with the ImportId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ImportEntity) GetImportIdOk() (int32, bool) { + if o == nil || o.ImportId == nil { + var ret int32 + return ret, false + } + return *o.ImportId, true +} + +// HasImportId returns a boolean if a field has been set. +func (o *ImportEntity) HasImportId() bool { + if o != nil && o.ImportId != nil { + return true + } + + return false +} + +// SetImportId gets a reference to the given int32 and assigns it to the ImportId field. +func (o *ImportEntity) SetImportId(v int32) { + o.ImportId = &v +} + +type NullableImportEntity struct { + Value ImportEntity + ExplicitNull bool +} + +func (v NullableImportEntity) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableImportEntity) 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_10.go b/model_inline_response_200_10.go index 9ab25790..2bcd21d5 100644 --- a/model_inline_response_200_10.go +++ b/model_inline_response_200_10.go @@ -16,29 +16,29 @@ import ( // InlineResponse20010 struct for InlineResponse20010 type InlineResponse20010 struct { - HasMore bool `json:"hasMore"` - Data []AccessLogEntry `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []CampaignAnalytics `json:"data"` } -// GetHasMore returns the HasMore field value -func (o *InlineResponse20010) GetHasMore() bool { +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20010) GetTotalResultSize() int32 { if o == nil { - var ret bool + var ret int32 return ret } - return o.HasMore + return o.TotalResultSize } -// SetHasMore sets field value -func (o *InlineResponse20010) SetHasMore(v bool) { - o.HasMore = v +// SetTotalResultSize sets field value +func (o *InlineResponse20010) SetTotalResultSize(v int32) { + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20010) GetData() []AccessLogEntry { +func (o *InlineResponse20010) GetData() []CampaignAnalytics { if o == nil { - var ret []AccessLogEntry + var ret []CampaignAnalytics return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20010) GetData() []AccessLogEntry { } // SetData sets field value -func (o *InlineResponse20010) SetData(v []AccessLogEntry) { +func (o *InlineResponse20010) SetData(v []CampaignAnalytics) { o.Data = v } diff --git a/model_inline_response_200_11.go b/model_inline_response_200_11.go index 4f13750a..a440dd91 100644 --- a/model_inline_response_200_11.go +++ b/model_inline_response_200_11.go @@ -16,29 +16,81 @@ import ( // InlineResponse20011 struct for InlineResponse20011 type InlineResponse20011 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []CampaignAnalytics `json:"data"` + 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 *InlineResponse20011) 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 *InlineResponse20011) 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 *InlineResponse20011) 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 *InlineResponse20011) SetTotalResultSize(v int32) { - o.TotalResultSize = v + o.TotalResultSize = &v +} + +// GetHasMore returns the HasMore field value if set, zero value otherwise. +func (o *InlineResponse20011) GetHasMore() bool { + if o == nil || o.HasMore == nil { + var ret bool + 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 *InlineResponse20011) 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 *InlineResponse20011) 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 *InlineResponse20011) SetHasMore(v bool) { + o.HasMore = &v } // GetData returns the Data field value -func (o *InlineResponse20011) GetData() []CampaignAnalytics { +func (o *InlineResponse20011) GetData() []ApplicationCustomer { if o == nil { - var ret []CampaignAnalytics + var ret []ApplicationCustomer return ret } @@ -46,7 +98,7 @@ func (o *InlineResponse20011) GetData() []CampaignAnalytics { } // SetData sets field value -func (o *InlineResponse20011) SetData(v []CampaignAnalytics) { +func (o *InlineResponse20011) SetData(v []ApplicationCustomer) { o.Data = v } diff --git a/model_inline_response_200_12.go b/model_inline_response_200_12.go index bfe9903f..11b364d9 100644 --- a/model_inline_response_200_12.go +++ b/model_inline_response_200_12.go @@ -16,75 +16,23 @@ import ( // InlineResponse20012 struct for InlineResponse20012 type InlineResponse20012 struct { - TotalResultSize *int32 `json:"totalResultSize,omitempty"` - HasMore *bool `json:"hasMore,omitempty"` - Data []ApplicationCustomer `json:"data"` + HasMore bool `json:"hasMore"` + Data []ApplicationCustomer `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. -func (o *InlineResponse20012) GetTotalResultSize() int32 { - if o == nil || o.TotalResultSize == nil { - var ret int32 - return ret - } - return *o.TotalResultSize -} - -// GetTotalResultSizeOk returns a tuple with the TotalResultSize field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *InlineResponse20012) GetTotalResultSizeOk() (int32, bool) { - if o == nil || o.TotalResultSize == nil { - var ret int32 - return ret, false - } - return *o.TotalResultSize, true -} - -// HasTotalResultSize returns a boolean if a field has been set. -func (o *InlineResponse20012) HasTotalResultSize() bool { - if o != nil && o.TotalResultSize != nil { - return true - } - - return false -} - -// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. -func (o *InlineResponse20012) SetTotalResultSize(v int32) { - o.TotalResultSize = &v -} - -// GetHasMore returns the HasMore field value if set, zero value otherwise. +// GetHasMore returns the HasMore field value func (o *InlineResponse20012) GetHasMore() bool { - if o == nil || o.HasMore == nil { + if o == nil { var ret bool return ret } - return *o.HasMore -} - -// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *InlineResponse20012) GetHasMoreOk() (bool, bool) { - if o == nil || o.HasMore == nil { - var ret bool - return ret, false - } - return *o.HasMore, true -} - -// 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 + return o.HasMore } -// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +// SetHasMore sets field value func (o *InlineResponse20012) SetHasMore(v bool) { - o.HasMore = &v + o.HasMore = v } // GetData returns the Data field value diff --git a/model_inline_response_200_13.go b/model_inline_response_200_13.go index 1fe5912d..e98920a2 100644 --- a/model_inline_response_200_13.go +++ b/model_inline_response_200_13.go @@ -16,29 +16,29 @@ import ( // InlineResponse20013 struct for InlineResponse20013 type InlineResponse20013 struct { - HasMore bool `json:"hasMore"` - Data []ApplicationCustomer `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []CustomerActivityReport `json:"data"` } -// GetHasMore returns the HasMore field value -func (o *InlineResponse20013) GetHasMore() bool { +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20013) GetTotalResultSize() int32 { if o == nil { - var ret bool + var ret int32 return ret } - return o.HasMore + return o.TotalResultSize } -// SetHasMore sets field value -func (o *InlineResponse20013) SetHasMore(v bool) { - o.HasMore = v +// SetTotalResultSize sets field value +func (o *InlineResponse20013) SetTotalResultSize(v int32) { + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20013) GetData() []ApplicationCustomer { +func (o *InlineResponse20013) GetData() []CustomerActivityReport { if o == nil { - var ret []ApplicationCustomer + var ret []CustomerActivityReport return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20013) GetData() []ApplicationCustomer { } // SetData sets field value -func (o *InlineResponse20013) SetData(v []ApplicationCustomer) { +func (o *InlineResponse20013) SetData(v []CustomerActivityReport) { o.Data = v } diff --git a/model_inline_response_200_14.go b/model_inline_response_200_14.go index 059be7b7..4dd7d55a 100644 --- a/model_inline_response_200_14.go +++ b/model_inline_response_200_14.go @@ -16,23 +16,23 @@ import ( // InlineResponse20014 struct for InlineResponse20014 type InlineResponse20014 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []CustomerActivityReport `json:"data"` + HasMore bool `json:"hasMore"` + Data []CustomerActivityReport `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse20014) GetTotalResultSize() int32 { +// GetHasMore returns the HasMore field value +func (o *InlineResponse20014) GetHasMore() bool { if o == nil { - var ret int32 + var ret bool return ret } - return o.TotalResultSize + return o.HasMore } -// SetTotalResultSize sets field value -func (o *InlineResponse20014) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore sets field value +func (o *InlineResponse20014) SetHasMore(v bool) { + o.HasMore = v } // GetData returns the Data field value diff --git a/model_inline_response_200_15.go b/model_inline_response_200_15.go index 813b5327..69110639 100644 --- a/model_inline_response_200_15.go +++ b/model_inline_response_200_15.go @@ -16,29 +16,47 @@ import ( // InlineResponse20015 struct for InlineResponse20015 type InlineResponse20015 struct { - HasMore bool `json:"hasMore"` - Data []CustomerActivityReport `json:"data"` + HasMore *bool `json:"hasMore,omitempty"` + Data []ApplicationSession `json:"data"` } -// GetHasMore returns the HasMore field value +// GetHasMore returns the HasMore field value if set, zero value otherwise. func (o *InlineResponse20015) GetHasMore() bool { - if o == nil { + if o == nil || o.HasMore == nil { var ret bool return ret } + return *o.HasMore +} + +// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InlineResponse20015) GetHasMoreOk() (bool, bool) { + if o == nil || o.HasMore == nil { + var ret bool + return ret, false + } + return *o.HasMore, true +} + +// HasHasMore returns a boolean if a field has been set. +func (o *InlineResponse20015) HasHasMore() bool { + if o != nil && o.HasMore != nil { + return true + } - return o.HasMore + return false } -// SetHasMore sets field value +// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. func (o *InlineResponse20015) SetHasMore(v bool) { - o.HasMore = v + o.HasMore = &v } // GetData returns the Data field value -func (o *InlineResponse20015) GetData() []CustomerActivityReport { +func (o *InlineResponse20015) GetData() []ApplicationSession { if o == nil { - var ret []CustomerActivityReport + var ret []ApplicationSession return ret } @@ -46,7 +64,7 @@ func (o *InlineResponse20015) GetData() []CustomerActivityReport { } // SetData sets field value -func (o *InlineResponse20015) SetData(v []CustomerActivityReport) { +func (o *InlineResponse20015) SetData(v []ApplicationSession) { o.Data = v } diff --git a/model_inline_response_200_16.go b/model_inline_response_200_16.go index ac02236c..c0f541f0 100644 --- a/model_inline_response_200_16.go +++ b/model_inline_response_200_16.go @@ -16,47 +16,29 @@ import ( // InlineResponse20016 struct for InlineResponse20016 type InlineResponse20016 struct { - HasMore *bool `json:"hasMore,omitempty"` - Data []ApplicationSession `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []ApplicationEvent `json:"data"` } -// GetHasMore returns the HasMore field value if set, zero value otherwise. -func (o *InlineResponse20016) GetHasMore() bool { - if o == nil || o.HasMore == nil { - var ret bool +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20016) GetTotalResultSize() int32 { + if o == nil { + var ret int32 return ret } - return *o.HasMore -} - -// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *InlineResponse20016) GetHasMoreOk() (bool, bool) { - if o == nil || o.HasMore == nil { - var ret bool - return ret, false - } - return *o.HasMore, true -} - -// HasHasMore returns a boolean if a field has been set. -func (o *InlineResponse20016) HasHasMore() bool { - if o != nil && o.HasMore != nil { - return true - } - return false + return o.TotalResultSize } -// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. -func (o *InlineResponse20016) SetHasMore(v bool) { - o.HasMore = &v +// SetTotalResultSize sets field value +func (o *InlineResponse20016) SetTotalResultSize(v int32) { + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20016) GetData() []ApplicationSession { +func (o *InlineResponse20016) GetData() []ApplicationEvent { if o == nil { - var ret []ApplicationSession + var ret []ApplicationEvent return ret } @@ -64,7 +46,7 @@ func (o *InlineResponse20016) GetData() []ApplicationSession { } // SetData sets field value -func (o *InlineResponse20016) SetData(v []ApplicationSession) { +func (o *InlineResponse20016) SetData(v []ApplicationEvent) { o.Data = v } diff --git a/model_inline_response_200_17.go b/model_inline_response_200_17.go index 825d7938..a85bf335 100644 --- a/model_inline_response_200_17.go +++ b/model_inline_response_200_17.go @@ -16,23 +16,23 @@ import ( // InlineResponse20017 struct for InlineResponse20017 type InlineResponse20017 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []ApplicationEvent `json:"data"` + HasMore bool `json:"hasMore"` + Data []ApplicationEvent `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse20017) GetTotalResultSize() int32 { +// GetHasMore returns the HasMore field value +func (o *InlineResponse20017) GetHasMore() bool { if o == nil { - var ret int32 + var ret bool return ret } - return o.TotalResultSize + return o.HasMore } -// SetTotalResultSize sets field value -func (o *InlineResponse20017) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore sets field value +func (o *InlineResponse20017) SetHasMore(v bool) { + o.HasMore = v } // GetData returns the Data field value diff --git a/model_inline_response_200_18.go b/model_inline_response_200_18.go index 91e4f16c..8f3f4482 100644 --- a/model_inline_response_200_18.go +++ b/model_inline_response_200_18.go @@ -16,29 +16,29 @@ import ( // InlineResponse20018 struct for InlineResponse20018 type InlineResponse20018 struct { - HasMore bool `json:"hasMore"` - Data []ApplicationEvent `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []string `json:"data"` } -// GetHasMore returns the HasMore field value -func (o *InlineResponse20018) GetHasMore() bool { +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse20018) GetTotalResultSize() int32 { if o == nil { - var ret bool + var ret int32 return ret } - return o.HasMore + return o.TotalResultSize } -// SetHasMore sets field value -func (o *InlineResponse20018) SetHasMore(v bool) { - o.HasMore = v +// SetTotalResultSize sets field value +func (o *InlineResponse20018) SetTotalResultSize(v int32) { + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20018) GetData() []ApplicationEvent { +func (o *InlineResponse20018) GetData() []string { if o == nil { - var ret []ApplicationEvent + var ret []string return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20018) GetData() []ApplicationEvent { } // SetData sets field value -func (o *InlineResponse20018) SetData(v []ApplicationEvent) { +func (o *InlineResponse20018) SetData(v []string) { o.Data = v } diff --git a/model_inline_response_200_19.go b/model_inline_response_200_19.go index cdfbb884..fc20d8bf 100644 --- a/model_inline_response_200_19.go +++ b/model_inline_response_200_19.go @@ -16,29 +16,81 @@ import ( // InlineResponse20019 struct for InlineResponse20019 type InlineResponse20019 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []string `json:"data"` + HasMore *bool `json:"hasMore,omitempty"` + TotalResultSize *int32 `json:"totalResultSize,omitempty"` + Data []Audience `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value +// GetHasMore returns the HasMore field value if set, zero value otherwise. +func (o *InlineResponse20019) 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 *InlineResponse20019) 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 *InlineResponse20019) 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 *InlineResponse20019) SetHasMore(v bool) { + o.HasMore = &v +} + +// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. func (o *InlineResponse20019) GetTotalResultSize() int32 { - if o == nil { + if o == nil || o.TotalResultSize == nil { var ret int32 return ret } + return *o.TotalResultSize +} + +// GetTotalResultSizeOk returns a tuple with the TotalResultSize field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InlineResponse20019) GetTotalResultSizeOk() (int32, bool) { + if o == nil || o.TotalResultSize == nil { + var ret int32 + return ret, false + } + return *o.TotalResultSize, true +} + +// HasTotalResultSize returns a boolean if a field has been set. +func (o *InlineResponse20019) HasTotalResultSize() bool { + if o != nil && o.TotalResultSize != nil { + return true + } - return o.TotalResultSize + return false } -// SetTotalResultSize sets field value +// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. func (o *InlineResponse20019) SetTotalResultSize(v int32) { - o.TotalResultSize = v + o.TotalResultSize = &v } // GetData returns the Data field value -func (o *InlineResponse20019) GetData() []string { +func (o *InlineResponse20019) GetData() []Audience { if o == nil { - var ret []string + var ret []Audience return ret } @@ -46,7 +98,7 @@ func (o *InlineResponse20019) GetData() []string { } // SetData sets field value -func (o *InlineResponse20019) SetData(v []string) { +func (o *InlineResponse20019) SetData(v []Audience) { o.Data = v } diff --git a/model_inline_response_200_20.go b/model_inline_response_200_20.go index 56f1d731..c89de4d6 100644 --- a/model_inline_response_200_20.go +++ b/model_inline_response_200_20.go @@ -16,47 +16,29 @@ import ( // InlineResponse20020 struct for InlineResponse20020 type InlineResponse20020 struct { - TotalResultSize *int32 `json:"totalResultSize,omitempty"` - Data []Audience `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []Attribute `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. +// GetTotalResultSize returns the TotalResultSize field value func (o *InlineResponse20020) GetTotalResultSize() int32 { - if o == nil || o.TotalResultSize == nil { + if o == nil { var ret int32 return ret } - return *o.TotalResultSize -} - -// GetTotalResultSizeOk returns a tuple with the TotalResultSize field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *InlineResponse20020) GetTotalResultSizeOk() (int32, bool) { - if o == nil || o.TotalResultSize == nil { - var ret int32 - return ret, false - } - return *o.TotalResultSize, true -} - -// HasTotalResultSize returns a boolean if a field has been set. -func (o *InlineResponse20020) HasTotalResultSize() bool { - if o != nil && o.TotalResultSize != nil { - return true - } - return false + return o.TotalResultSize } -// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +// SetTotalResultSize sets field value func (o *InlineResponse20020) SetTotalResultSize(v int32) { - o.TotalResultSize = &v + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20020) GetData() []Audience { +func (o *InlineResponse20020) GetData() []Attribute { if o == nil { - var ret []Audience + var ret []Attribute return ret } @@ -64,7 +46,7 @@ func (o *InlineResponse20020) GetData() []Audience { } // SetData sets field value -func (o *InlineResponse20020) SetData(v []Audience) { +func (o *InlineResponse20020) SetData(v []Attribute) { o.Data = v } diff --git a/model_inline_response_200_21.go b/model_inline_response_200_21.go index 9124015a..f3435f5d 100644 --- a/model_inline_response_200_21.go +++ b/model_inline_response_200_21.go @@ -16,8 +16,8 @@ import ( // InlineResponse20021 struct for InlineResponse20021 type InlineResponse20021 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Attribute `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []AccountAdditionalCost `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20021) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20021) GetData() []Attribute { +func (o *InlineResponse20021) GetData() []AccountAdditionalCost { if o == nil { - var ret []Attribute + var ret []AccountAdditionalCost return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20021) GetData() []Attribute { } // SetData sets field value -func (o *InlineResponse20021) SetData(v []Attribute) { +func (o *InlineResponse20021) SetData(v []AccountAdditionalCost) { o.Data = v } diff --git a/model_inline_response_200_22.go b/model_inline_response_200_22.go index 1bfafe36..ba594dc3 100644 --- a/model_inline_response_200_22.go +++ b/model_inline_response_200_22.go @@ -16,8 +16,8 @@ import ( // InlineResponse20022 struct for InlineResponse20022 type InlineResponse20022 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []AccountAdditionalCost `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []Webhook `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20022) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20022) GetData() []AccountAdditionalCost { +func (o *InlineResponse20022) GetData() []Webhook { if o == nil { - var ret []AccountAdditionalCost + var ret []Webhook return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20022) GetData() []AccountAdditionalCost { } // SetData sets field value -func (o *InlineResponse20022) SetData(v []AccountAdditionalCost) { +func (o *InlineResponse20022) SetData(v []Webhook) { o.Data = v } diff --git a/model_inline_response_200_23.go b/model_inline_response_200_23.go index 9909add7..be0960bf 100644 --- a/model_inline_response_200_23.go +++ b/model_inline_response_200_23.go @@ -16,8 +16,8 @@ import ( // InlineResponse20023 struct for InlineResponse20023 type InlineResponse20023 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Webhook `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []WebhookActivationLogEntry `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20023) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20023) GetData() []Webhook { +func (o *InlineResponse20023) GetData() []WebhookActivationLogEntry { if o == nil { - var ret []Webhook + var ret []WebhookActivationLogEntry return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20023) GetData() []Webhook { } // SetData sets field value -func (o *InlineResponse20023) SetData(v []Webhook) { +func (o *InlineResponse20023) SetData(v []WebhookActivationLogEntry) { o.Data = v } diff --git a/model_inline_response_200_24.go b/model_inline_response_200_24.go index 17fc5a83..47251011 100644 --- a/model_inline_response_200_24.go +++ b/model_inline_response_200_24.go @@ -16,8 +16,8 @@ import ( // InlineResponse20024 struct for InlineResponse20024 type InlineResponse20024 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []WebhookActivationLogEntry `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []WebhookLogEntry `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20024) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20024) GetData() []WebhookActivationLogEntry { +func (o *InlineResponse20024) GetData() []WebhookLogEntry { if o == nil { - var ret []WebhookActivationLogEntry + var ret []WebhookLogEntry return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20024) GetData() []WebhookActivationLogEntry { } // SetData sets field value -func (o *InlineResponse20024) SetData(v []WebhookActivationLogEntry) { +func (o *InlineResponse20024) SetData(v []WebhookLogEntry) { o.Data = v } diff --git a/model_inline_response_200_25.go b/model_inline_response_200_25.go index 58ade5ab..dc10f93c 100644 --- a/model_inline_response_200_25.go +++ b/model_inline_response_200_25.go @@ -16,8 +16,8 @@ import ( // InlineResponse20025 struct for InlineResponse20025 type InlineResponse20025 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []WebhookLogEntry `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []EventType `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20025) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20025) GetData() []WebhookLogEntry { +func (o *InlineResponse20025) GetData() []EventType { if o == nil { - var ret []WebhookLogEntry + var ret []EventType return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20025) GetData() []WebhookLogEntry { } // SetData sets field value -func (o *InlineResponse20025) SetData(v []WebhookLogEntry) { +func (o *InlineResponse20025) SetData(v []EventType) { o.Data = v } diff --git a/model_inline_response_200_26.go b/model_inline_response_200_26.go index 2ed8fd97..0c7e1ecf 100644 --- a/model_inline_response_200_26.go +++ b/model_inline_response_200_26.go @@ -16,8 +16,8 @@ import ( // InlineResponse20026 struct for InlineResponse20026 type InlineResponse20026 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []EventType `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []User `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20026) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20026) GetData() []EventType { +func (o *InlineResponse20026) GetData() []User { if o == nil { - var ret []EventType + var ret []User return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20026) GetData() []EventType { } // SetData sets field value -func (o *InlineResponse20026) SetData(v []EventType) { +func (o *InlineResponse20026) SetData(v []User) { o.Data = v } diff --git a/model_inline_response_200_27.go b/model_inline_response_200_27.go index c73cfb68..b4ca4eda 100644 --- a/model_inline_response_200_27.go +++ b/model_inline_response_200_27.go @@ -16,29 +16,81 @@ import ( // InlineResponse20027 struct for InlineResponse20027 type InlineResponse20027 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []User `json:"data"` + TotalResultSize *int32 `json:"totalResultSize,omitempty"` + HasMore *bool `json:"hasMore,omitempty"` + Data []Change `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value +// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. func (o *InlineResponse20027) 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 *InlineResponse20027) 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 *InlineResponse20027) HasTotalResultSize() bool { + if o != nil && o.TotalResultSize != nil { + return true + } + + return false +} + +// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. func (o *InlineResponse20027) SetTotalResultSize(v int32) { - o.TotalResultSize = v + o.TotalResultSize = &v +} + +// GetHasMore returns the HasMore field value if set, zero value otherwise. +func (o *InlineResponse20027) GetHasMore() bool { + if o == nil || o.HasMore == nil { + var ret bool + return ret + } + return *o.HasMore +} + +// GetHasMoreOk returns a tuple with the HasMore field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InlineResponse20027) GetHasMoreOk() (bool, bool) { + if o == nil || o.HasMore == nil { + var ret bool + return ret, false + } + return *o.HasMore, true +} + +// HasHasMore returns a boolean if a field has been set. +func (o *InlineResponse20027) HasHasMore() bool { + if o != nil && o.HasMore != nil { + return true + } + + return false +} + +// SetHasMore gets a reference to the given bool and assigns it to the HasMore field. +func (o *InlineResponse20027) SetHasMore(v bool) { + o.HasMore = &v } // GetData returns the Data field value -func (o *InlineResponse20027) GetData() []User { +func (o *InlineResponse20027) GetData() []Change { if o == nil { - var ret []User + var ret []Change return ret } @@ -46,7 +98,7 @@ func (o *InlineResponse20027) GetData() []User { } // SetData sets field value -func (o *InlineResponse20027) SetData(v []User) { +func (o *InlineResponse20027) SetData(v []Change) { o.Data = v } diff --git a/model_inline_response_200_28.go b/model_inline_response_200_28.go index f76e2a0d..369911c6 100644 --- a/model_inline_response_200_28.go +++ b/model_inline_response_200_28.go @@ -16,81 +16,29 @@ import ( // InlineResponse20028 struct for InlineResponse20028 type InlineResponse20028 struct { - TotalResultSize *int32 `json:"totalResultSize,omitempty"` - HasMore *bool `json:"hasMore,omitempty"` - Data []Change `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []Export `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value if set, zero value otherwise. +// GetTotalResultSize returns the TotalResultSize field value func (o *InlineResponse20028) GetTotalResultSize() int32 { - if o == nil || o.TotalResultSize == nil { + if o == nil { var ret int32 return ret } - return *o.TotalResultSize -} -// GetTotalResultSizeOk returns a tuple with the TotalResultSize field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *InlineResponse20028) GetTotalResultSizeOk() (int32, bool) { - if o == nil || o.TotalResultSize == nil { - var ret int32 - return ret, false - } - return *o.TotalResultSize, true + return o.TotalResultSize } -// HasTotalResultSize returns a boolean if a field has been set. -func (o *InlineResponse20028) HasTotalResultSize() bool { - if o != nil && o.TotalResultSize != nil { - return true - } - - return false -} - -// SetTotalResultSize gets a reference to the given int32 and assigns it to the TotalResultSize field. +// SetTotalResultSize sets field value func (o *InlineResponse20028) SetTotalResultSize(v int32) { - o.TotalResultSize = &v -} - -// GetHasMore returns the HasMore field value if set, zero value otherwise. -func (o *InlineResponse20028) 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 *InlineResponse20028) 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 *InlineResponse20028) 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 *InlineResponse20028) SetHasMore(v bool) { - o.HasMore = &v + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20028) GetData() []Change { +func (o *InlineResponse20028) GetData() []Export { if o == nil { - var ret []Change + var ret []Export return ret } @@ -98,7 +46,7 @@ func (o *InlineResponse20028) GetData() []Change { } // SetData sets field value -func (o *InlineResponse20028) SetData(v []Change) { +func (o *InlineResponse20028) SetData(v []Export) { o.Data = v } diff --git a/model_inline_response_200_29.go b/model_inline_response_200_29.go index 0d59a6ae..d4bee651 100644 --- a/model_inline_response_200_29.go +++ b/model_inline_response_200_29.go @@ -16,8 +16,8 @@ import ( // InlineResponse20029 struct for InlineResponse20029 type InlineResponse20029 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Export `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []Role `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse20029) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse20029) GetData() []Export { +func (o *InlineResponse20029) GetData() []Role { if o == nil { - var ret []Export + var ret []Role return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse20029) GetData() []Export { } // SetData sets field value -func (o *InlineResponse20029) SetData(v []Export) { +func (o *InlineResponse20029) SetData(v []Role) { o.Data = v } diff --git a/model_inline_response_200_6.go b/model_inline_response_200_6.go index 72319525..9d9afa70 100644 --- a/model_inline_response_200_6.go +++ b/model_inline_response_200_6.go @@ -16,23 +16,23 @@ import ( // InlineResponse2006 struct for InlineResponse2006 type InlineResponse2006 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Referral `json:"data"` + HasMore bool `json:"hasMore"` + Data []Referral `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse2006) GetTotalResultSize() int32 { +// GetHasMore returns the HasMore field value +func (o *InlineResponse2006) GetHasMore() bool { if o == nil { - var ret int32 + var ret bool return ret } - return o.TotalResultSize + return o.HasMore } -// SetTotalResultSize sets field value -func (o *InlineResponse2006) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore sets field value +func (o *InlineResponse2006) SetHasMore(v bool) { + o.HasMore = v } // GetData returns the Data field value diff --git a/model_inline_response_200_7.go b/model_inline_response_200_7.go index dc1535fe..baf46b8b 100644 --- a/model_inline_response_200_7.go +++ b/model_inline_response_200_7.go @@ -16,29 +16,29 @@ import ( // InlineResponse2007 struct for InlineResponse2007 type InlineResponse2007 struct { - HasMore bool `json:"hasMore"` - Data []Referral `json:"data"` + TotalResultSize int32 `json:"totalResultSize"` + Data []LoyaltyProgram `json:"data"` } -// GetHasMore returns the HasMore field value -func (o *InlineResponse2007) GetHasMore() bool { +// GetTotalResultSize returns the TotalResultSize field value +func (o *InlineResponse2007) GetTotalResultSize() int32 { if o == nil { - var ret bool + var ret int32 return ret } - return o.HasMore + return o.TotalResultSize } -// SetHasMore sets field value -func (o *InlineResponse2007) SetHasMore(v bool) { - o.HasMore = v +// SetTotalResultSize sets field value +func (o *InlineResponse2007) SetTotalResultSize(v int32) { + o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse2007) GetData() []Referral { +func (o *InlineResponse2007) GetData() []LoyaltyProgram { if o == nil { - var ret []Referral + var ret []LoyaltyProgram return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2007) GetData() []Referral { } // SetData sets field value -func (o *InlineResponse2007) SetData(v []Referral) { +func (o *InlineResponse2007) SetData(v []LoyaltyProgram) { o.Data = v } diff --git a/model_inline_response_200_8.go b/model_inline_response_200_8.go index 7fddea60..8b61acdf 100644 --- a/model_inline_response_200_8.go +++ b/model_inline_response_200_8.go @@ -17,7 +17,7 @@ import ( // InlineResponse2008 struct for InlineResponse2008 type InlineResponse2008 struct { TotalResultSize int32 `json:"totalResultSize"` - Data []LoyaltyProgram `json:"data"` + Data []AccessLogEntry `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value @@ -36,9 +36,9 @@ func (o *InlineResponse2008) SetTotalResultSize(v int32) { } // GetData returns the Data field value -func (o *InlineResponse2008) GetData() []LoyaltyProgram { +func (o *InlineResponse2008) GetData() []AccessLogEntry { if o == nil { - var ret []LoyaltyProgram + var ret []AccessLogEntry return ret } @@ -46,7 +46,7 @@ func (o *InlineResponse2008) GetData() []LoyaltyProgram { } // SetData sets field value -func (o *InlineResponse2008) SetData(v []LoyaltyProgram) { +func (o *InlineResponse2008) SetData(v []AccessLogEntry) { o.Data = v } diff --git a/model_inline_response_200_9.go b/model_inline_response_200_9.go index 2c79c2bf..c28715ff 100644 --- a/model_inline_response_200_9.go +++ b/model_inline_response_200_9.go @@ -16,23 +16,23 @@ import ( // InlineResponse2009 struct for InlineResponse2009 type InlineResponse2009 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []AccessLogEntry `json:"data"` + HasMore bool `json:"hasMore"` + Data []AccessLogEntry `json:"data"` } -// GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse2009) GetTotalResultSize() int32 { +// GetHasMore returns the HasMore field value +func (o *InlineResponse2009) GetHasMore() bool { if o == nil { - var ret int32 + var ret bool return ret } - return o.TotalResultSize + return o.HasMore } -// SetTotalResultSize sets field value -func (o *InlineResponse2009) SetTotalResultSize(v int32) { - o.TotalResultSize = v +// SetHasMore sets field value +func (o *InlineResponse2009) SetHasMore(v bool) { + o.HasMore = v } // GetData returns the Data field value diff --git a/model_inline_response_200_30.go b/model_inline_response_201.go similarity index 69% rename from model_inline_response_200_30.go rename to model_inline_response_201.go index e5888897..57ee26bc 100644 --- a/model_inline_response_200_30.go +++ b/model_inline_response_201.go @@ -14,14 +14,14 @@ import ( "encoding/json" ) -// InlineResponse20030 struct for InlineResponse20030 -type InlineResponse20030 struct { - TotalResultSize int32 `json:"totalResultSize"` - Data []Role `json:"data"` +// InlineResponse201 struct for InlineResponse201 +type InlineResponse201 struct { + TotalResultSize int32 `json:"totalResultSize"` + Data []Referral `json:"data"` } // GetTotalResultSize returns the TotalResultSize field value -func (o *InlineResponse20030) GetTotalResultSize() int32 { +func (o *InlineResponse201) GetTotalResultSize() int32 { if o == nil { var ret int32 return ret @@ -31,14 +31,14 @@ func (o *InlineResponse20030) GetTotalResultSize() int32 { } // SetTotalResultSize sets field value -func (o *InlineResponse20030) SetTotalResultSize(v int32) { +func (o *InlineResponse201) SetTotalResultSize(v int32) { o.TotalResultSize = v } // GetData returns the Data field value -func (o *InlineResponse20030) GetData() []Role { +func (o *InlineResponse201) GetData() []Referral { if o == nil { - var ret []Role + var ret []Referral return ret } @@ -46,16 +46,16 @@ func (o *InlineResponse20030) GetData() []Role { } // SetData sets field value -func (o *InlineResponse20030) SetData(v []Role) { +func (o *InlineResponse201) SetData(v []Referral) { o.Data = v } -type NullableInlineResponse20030 struct { - Value InlineResponse20030 +type NullableInlineResponse201 struct { + Value InlineResponse201 ExplicitNull bool } -func (v NullableInlineResponse20030) MarshalJSON() ([]byte, error) { +func (v NullableInlineResponse201) MarshalJSON() ([]byte, error) { switch { case v.ExplicitNull: return []byte("null"), nil @@ -64,7 +64,7 @@ func (v NullableInlineResponse20030) MarshalJSON() ([]byte, error) { } } -func (v *NullableInlineResponse20030) UnmarshalJSON(src []byte) error { +func (v *NullableInlineResponse201) UnmarshalJSON(src []byte) error { if bytes.Equal(src, []byte("null")) { v.ExplicitNull = true return nil diff --git a/model_integration_request.go b/model_integration_request.go index 7d97b1ef..4f8b5bd3 100644 --- a/model_integration_request.go +++ b/model_integration_request.go @@ -17,7 +17,7 @@ import ( // IntegrationRequest The body of a V2 integration API request (customer session update). Next to the customer session details, this contains an optional listing of extra properties that should be returned in the response. type IntegrationRequest struct { CustomerSession NewCustomerSessionV2 `json:"customerSession"` - // Optional list of requested information to be present on the response related to the customer session update. Currently supported: \"customerSession\", \"customerProfile\", \"coupons\", \"triggeredCampaigns\", \"referral\", \"loyalty\", \"event\" and \"ruleFailureReasons\". + // Optional list of requested information to be present on the response related to the customer session update. Currently supported: \"customerSession\", \"customerProfile\", \"coupons\", \"triggeredCampaigns\", \"referral\", \"loyalty\", \"event\", \"awardedGiveaways\" and \"ruleFailureReasons\". ResponseContent *[]string `json:"responseContent,omitempty"` } diff --git a/model_integration_state_v2.go b/model_integration_state_v2.go index f3e07393..65989e5f 100644 --- a/model_integration_state_v2.go +++ b/model_integration_state_v2.go @@ -27,6 +27,7 @@ type IntegrationStateV2 struct { RuleFailureReasons *[]RuleFailureReason `json:"ruleFailureReasons,omitempty"` CreatedCoupons []Coupon `json:"createdCoupons"` CreatedReferrals []Referral `json:"createdReferrals"` + AwardedGiveaways *[]Giveaway `json:"awardedGiveaways,omitempty"` } // GetCustomerSession returns the CustomerSession field value if set, zero value otherwise. @@ -338,6 +339,39 @@ func (o *IntegrationStateV2) SetCreatedReferrals(v []Referral) { o.CreatedReferrals = v } +// GetAwardedGiveaways returns the AwardedGiveaways field value if set, zero value otherwise. +func (o *IntegrationStateV2) GetAwardedGiveaways() []Giveaway { + if o == nil || o.AwardedGiveaways == nil { + var ret []Giveaway + return ret + } + return *o.AwardedGiveaways +} + +// GetAwardedGiveawaysOk returns a tuple with the AwardedGiveaways field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *IntegrationStateV2) GetAwardedGiveawaysOk() ([]Giveaway, bool) { + if o == nil || o.AwardedGiveaways == nil { + var ret []Giveaway + return ret, false + } + return *o.AwardedGiveaways, true +} + +// HasAwardedGiveaways returns a boolean if a field has been set. +func (o *IntegrationStateV2) HasAwardedGiveaways() bool { + if o != nil && o.AwardedGiveaways != nil { + return true + } + + return false +} + +// SetAwardedGiveaways gets a reference to the given []Giveaway and assigns it to the AwardedGiveaways field. +func (o *IntegrationStateV2) SetAwardedGiveaways(v []Giveaway) { + o.AwardedGiveaways = &v +} + type NullableIntegrationStateV2 struct { Value IntegrationStateV2 ExplicitNull bool diff --git a/model_inventory_coupon.go b/model_inventory_coupon.go new file mode 100644 index 00000000..55cd2af8 --- /dev/null +++ b/model_inventory_coupon.go @@ -0,0 +1,564 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// InventoryCoupon +type InventoryCoupon struct { + // Unique ID for this entity. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The ID of the campaign that owns this entity. + CampaignId int32 `json:"campaignId"` + // The actual coupon code. + Value string `json:"value"` + // The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply. + UsageLimit int32 `json:"usageLimit"` + // The amount of discounts that can be given with this coupon code. + DiscountLimit *float32 `json:"discountLimit,omitempty"` + // Timestamp at which point the coupon becomes valid. + StartDate *time.Time `json:"startDate,omitempty"` + // Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. + ExpiryDate *time.Time `json:"expiryDate,omitempty"` + // The number of times this coupon has been successfully used. + UsageCounter int32 `json:"usageCounter"` + // The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. + DiscountCounter *float32 `json:"discountCounter,omitempty"` + // The remaining discount this coupon can give. + DiscountRemainder *float32 `json:"discountRemainder,omitempty"` + // Arbitrary properties associated with this item + Attributes *map[string]interface{} `json:"attributes,omitempty"` + // The integration ID of the referring customer (if any) for whom this coupon was created as an effect. + ReferralId *int32 `json:"referralId,omitempty"` + // The Integration ID of the customer that is allowed to redeem this coupon. + RecipientIntegrationId *string `json:"recipientIntegrationId,omitempty"` + // The ID of the Import which created this coupon. + ImportId *int32 `json:"importId,omitempty"` + // This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favorite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. + Reservation *bool `json:"reservation,omitempty"` + // The id of the batch the coupon belongs to. + BatchId *string `json:"batchId,omitempty"` + // The number of times the coupon was redeemed by the profile. + ProfileRedemptionCount int32 `json:"profileRedemptionCount"` + // Can be either active, used, expired, or pending. active: reserved coupons that are neither pending nor used nor expired, and have a non-exhausted limit counter. used: coupons that are not pending, and have reached their redemption limit or were redeemed by the profile before expiration. expired: all non-pending, non-active, non-used coupons that were not redeemed by the profile. pending: coupons that have a start date in the future. + State string `json:"state"` +} + +// GetId returns the Id field value +func (o *InventoryCoupon) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *InventoryCoupon) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *InventoryCoupon) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *InventoryCoupon) SetCreated(v time.Time) { + o.Created = v +} + +// GetCampaignId returns the CampaignId field value +func (o *InventoryCoupon) GetCampaignId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CampaignId +} + +// SetCampaignId sets field value +func (o *InventoryCoupon) SetCampaignId(v int32) { + o.CampaignId = v +} + +// GetValue returns the Value field value +func (o *InventoryCoupon) GetValue() string { + if o == nil { + var ret string + return ret + } + + return o.Value +} + +// SetValue sets field value +func (o *InventoryCoupon) SetValue(v string) { + o.Value = v +} + +// GetUsageLimit returns the UsageLimit field value +func (o *InventoryCoupon) GetUsageLimit() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.UsageLimit +} + +// SetUsageLimit sets field value +func (o *InventoryCoupon) SetUsageLimit(v int32) { + o.UsageLimit = v +} + +// GetDiscountLimit returns the DiscountLimit field value if set, zero value otherwise. +func (o *InventoryCoupon) GetDiscountLimit() float32 { + if o == nil || o.DiscountLimit == nil { + var ret float32 + return ret + } + return *o.DiscountLimit +} + +// GetDiscountLimitOk returns a tuple with the DiscountLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryCoupon) GetDiscountLimitOk() (float32, bool) { + if o == nil || o.DiscountLimit == nil { + var ret float32 + return ret, false + } + return *o.DiscountLimit, true +} + +// HasDiscountLimit returns a boolean if a field has been set. +func (o *InventoryCoupon) HasDiscountLimit() bool { + if o != nil && o.DiscountLimit != nil { + return true + } + + return false +} + +// SetDiscountLimit gets a reference to the given float32 and assigns it to the DiscountLimit field. +func (o *InventoryCoupon) SetDiscountLimit(v float32) { + o.DiscountLimit = &v +} + +// GetStartDate returns the StartDate field value if set, zero value otherwise. +func (o *InventoryCoupon) 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 *InventoryCoupon) 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 *InventoryCoupon) 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 *InventoryCoupon) SetStartDate(v time.Time) { + o.StartDate = &v +} + +// GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise. +func (o *InventoryCoupon) 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 *InventoryCoupon) 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 *InventoryCoupon) HasExpiryDate() bool { + if o != nil && o.ExpiryDate != nil { + return true + } + + return false +} + +// SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +func (o *InventoryCoupon) SetExpiryDate(v time.Time) { + o.ExpiryDate = &v +} + +// GetUsageCounter returns the UsageCounter field value +func (o *InventoryCoupon) GetUsageCounter() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.UsageCounter +} + +// SetUsageCounter sets field value +func (o *InventoryCoupon) SetUsageCounter(v int32) { + o.UsageCounter = v +} + +// GetDiscountCounter returns the DiscountCounter field value if set, zero value otherwise. +func (o *InventoryCoupon) GetDiscountCounter() float32 { + if o == nil || o.DiscountCounter == nil { + var ret float32 + return ret + } + return *o.DiscountCounter +} + +// GetDiscountCounterOk returns a tuple with the DiscountCounter field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryCoupon) GetDiscountCounterOk() (float32, bool) { + if o == nil || o.DiscountCounter == nil { + var ret float32 + return ret, false + } + return *o.DiscountCounter, true +} + +// HasDiscountCounter returns a boolean if a field has been set. +func (o *InventoryCoupon) HasDiscountCounter() bool { + if o != nil && o.DiscountCounter != nil { + return true + } + + return false +} + +// SetDiscountCounter gets a reference to the given float32 and assigns it to the DiscountCounter field. +func (o *InventoryCoupon) SetDiscountCounter(v float32) { + o.DiscountCounter = &v +} + +// GetDiscountRemainder returns the DiscountRemainder field value if set, zero value otherwise. +func (o *InventoryCoupon) GetDiscountRemainder() float32 { + if o == nil || o.DiscountRemainder == nil { + var ret float32 + return ret + } + return *o.DiscountRemainder +} + +// GetDiscountRemainderOk returns a tuple with the DiscountRemainder field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryCoupon) GetDiscountRemainderOk() (float32, bool) { + if o == nil || o.DiscountRemainder == nil { + var ret float32 + return ret, false + } + return *o.DiscountRemainder, true +} + +// HasDiscountRemainder returns a boolean if a field has been set. +func (o *InventoryCoupon) HasDiscountRemainder() bool { + if o != nil && o.DiscountRemainder != nil { + return true + } + + return false +} + +// SetDiscountRemainder gets a reference to the given float32 and assigns it to the DiscountRemainder field. +func (o *InventoryCoupon) SetDiscountRemainder(v float32) { + o.DiscountRemainder = &v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *InventoryCoupon) GetAttributes() map[string]interface{} { + if o == nil || o.Attributes == nil { + 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 *InventoryCoupon) 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 *InventoryCoupon) 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 *InventoryCoupon) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +// GetReferralId returns the ReferralId field value if set, zero value otherwise. +func (o *InventoryCoupon) GetReferralId() int32 { + if o == nil || o.ReferralId == nil { + var ret int32 + return ret + } + return *o.ReferralId +} + +// GetReferralIdOk returns a tuple with the ReferralId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryCoupon) GetReferralIdOk() (int32, bool) { + if o == nil || o.ReferralId == nil { + var ret int32 + return ret, false + } + return *o.ReferralId, true +} + +// HasReferralId returns a boolean if a field has been set. +func (o *InventoryCoupon) HasReferralId() bool { + if o != nil && o.ReferralId != nil { + return true + } + + return false +} + +// SetReferralId gets a reference to the given int32 and assigns it to the ReferralId field. +func (o *InventoryCoupon) SetReferralId(v int32) { + o.ReferralId = &v +} + +// GetRecipientIntegrationId returns the RecipientIntegrationId field value if set, zero value otherwise. +func (o *InventoryCoupon) GetRecipientIntegrationId() string { + if o == nil || o.RecipientIntegrationId == nil { + var ret string + return ret + } + return *o.RecipientIntegrationId +} + +// GetRecipientIntegrationIdOk returns a tuple with the RecipientIntegrationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryCoupon) GetRecipientIntegrationIdOk() (string, bool) { + if o == nil || o.RecipientIntegrationId == nil { + var ret string + return ret, false + } + return *o.RecipientIntegrationId, true +} + +// HasRecipientIntegrationId returns a boolean if a field has been set. +func (o *InventoryCoupon) HasRecipientIntegrationId() bool { + if o != nil && o.RecipientIntegrationId != nil { + return true + } + + return false +} + +// SetRecipientIntegrationId gets a reference to the given string and assigns it to the RecipientIntegrationId field. +func (o *InventoryCoupon) SetRecipientIntegrationId(v string) { + o.RecipientIntegrationId = &v +} + +// GetImportId returns the ImportId field value if set, zero value otherwise. +func (o *InventoryCoupon) GetImportId() int32 { + if o == nil || o.ImportId == nil { + var ret int32 + return ret + } + return *o.ImportId +} + +// GetImportIdOk returns a tuple with the ImportId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryCoupon) GetImportIdOk() (int32, bool) { + if o == nil || o.ImportId == nil { + var ret int32 + return ret, false + } + return *o.ImportId, true +} + +// HasImportId returns a boolean if a field has been set. +func (o *InventoryCoupon) HasImportId() bool { + if o != nil && o.ImportId != nil { + return true + } + + return false +} + +// SetImportId gets a reference to the given int32 and assigns it to the ImportId field. +func (o *InventoryCoupon) SetImportId(v int32) { + o.ImportId = &v +} + +// GetReservation returns the Reservation field value if set, zero value otherwise. +func (o *InventoryCoupon) GetReservation() bool { + if o == nil || o.Reservation == nil { + var ret bool + return ret + } + return *o.Reservation +} + +// GetReservationOk returns a tuple with the Reservation field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryCoupon) GetReservationOk() (bool, bool) { + if o == nil || o.Reservation == nil { + var ret bool + return ret, false + } + return *o.Reservation, true +} + +// HasReservation returns a boolean if a field has been set. +func (o *InventoryCoupon) HasReservation() bool { + if o != nil && o.Reservation != nil { + return true + } + + return false +} + +// SetReservation gets a reference to the given bool and assigns it to the Reservation field. +func (o *InventoryCoupon) SetReservation(v bool) { + o.Reservation = &v +} + +// GetBatchId returns the BatchId field value if set, zero value otherwise. +func (o *InventoryCoupon) GetBatchId() string { + if o == nil || o.BatchId == nil { + var ret string + return ret + } + return *o.BatchId +} + +// GetBatchIdOk returns a tuple with the BatchId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *InventoryCoupon) GetBatchIdOk() (string, bool) { + if o == nil || o.BatchId == nil { + var ret string + return ret, false + } + return *o.BatchId, true +} + +// HasBatchId returns a boolean if a field has been set. +func (o *InventoryCoupon) HasBatchId() bool { + if o != nil && o.BatchId != nil { + return true + } + + return false +} + +// SetBatchId gets a reference to the given string and assigns it to the BatchId field. +func (o *InventoryCoupon) SetBatchId(v string) { + o.BatchId = &v +} + +// GetProfileRedemptionCount returns the ProfileRedemptionCount field value +func (o *InventoryCoupon) GetProfileRedemptionCount() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ProfileRedemptionCount +} + +// SetProfileRedemptionCount sets field value +func (o *InventoryCoupon) SetProfileRedemptionCount(v int32) { + o.ProfileRedemptionCount = v +} + +// GetState returns the State field value +func (o *InventoryCoupon) GetState() string { + if o == nil { + var ret string + return ret + } + + return o.State +} + +// SetState sets field value +func (o *InventoryCoupon) SetState(v string) { + o.State = v +} + +type NullableInventoryCoupon struct { + Value InventoryCoupon + ExplicitNull bool +} + +func (v NullableInventoryCoupon) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableInventoryCoupon) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_loyalty_program.go b/model_loyalty_program.go index 3433b7c9..9d8267d1 100644 --- a/model_loyalty_program.go +++ b/model_loyalty_program.go @@ -34,6 +34,8 @@ type LoyaltyProgram struct { DefaultPending string `json:"defaultPending"` // Indicates if this program supports subledgers inside the program AllowSubledger bool `json:"allowSubledger"` + // The tiers in this loyalty program + Tiers *[]LoyaltyTier `json:"tiers,omitempty"` } // GetId returns the Id field value @@ -171,6 +173,39 @@ func (o *LoyaltyProgram) SetAllowSubledger(v bool) { o.AllowSubledger = v } +// GetTiers returns the Tiers field value if set, zero value otherwise. +func (o *LoyaltyProgram) GetTiers() []LoyaltyTier { + if o == nil || o.Tiers == nil { + var ret []LoyaltyTier + return ret + } + return *o.Tiers +} + +// GetTiersOk returns a tuple with the Tiers field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyProgram) GetTiersOk() ([]LoyaltyTier, bool) { + if o == nil || o.Tiers == nil { + var ret []LoyaltyTier + return ret, false + } + return *o.Tiers, true +} + +// HasTiers returns a boolean if a field has been set. +func (o *LoyaltyProgram) HasTiers() bool { + if o != nil && o.Tiers != nil { + return true + } + + return false +} + +// SetTiers gets a reference to the given []LoyaltyTier and assigns it to the Tiers field. +func (o *LoyaltyProgram) SetTiers(v []LoyaltyTier) { + o.Tiers = &v +} + type NullableLoyaltyProgram struct { Value LoyaltyProgram ExplicitNull bool diff --git a/model_loyalty_program_entity.go b/model_loyalty_program_entity.go new file mode 100644 index 00000000..5009c16b --- /dev/null +++ b/model_loyalty_program_entity.go @@ -0,0 +1,59 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// LoyaltyProgramEntity struct for LoyaltyProgramEntity +type LoyaltyProgramEntity struct { + // The ID of the loyalty program that owns this entity. + ProgramID int32 `json:"programID"` +} + +// GetProgramID returns the ProgramID field value +func (o *LoyaltyProgramEntity) GetProgramID() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ProgramID +} + +// SetProgramID sets field value +func (o *LoyaltyProgramEntity) SetProgramID(v int32) { + o.ProgramID = v +} + +type NullableLoyaltyProgramEntity struct { + Value LoyaltyProgramEntity + ExplicitNull bool +} + +func (v NullableLoyaltyProgramEntity) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyProgramEntity) 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_tier.go b/model_loyalty_tier.go new file mode 100644 index 00000000..e2a96f37 --- /dev/null +++ b/model_loyalty_tier.go @@ -0,0 +1,128 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// LoyaltyTier +type LoyaltyTier struct { + // Unique ID for this entity. + Id int32 `json:"id"` + // The exact moment this entity was created. + Created time.Time `json:"created"` + // The ID of the loyalty program that owns this entity. + ProgramID int32 `json:"programID"` + // The name of the tier + Name string `json:"name"` + // The minimum amount of points required to be eligible for the tier + MinPoints float32 `json:"minPoints"` +} + +// GetId returns the Id field value +func (o *LoyaltyTier) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *LoyaltyTier) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *LoyaltyTier) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *LoyaltyTier) SetCreated(v time.Time) { + o.Created = v +} + +// GetProgramID returns the ProgramID field value +func (o *LoyaltyTier) GetProgramID() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ProgramID +} + +// SetProgramID sets field value +func (o *LoyaltyTier) SetProgramID(v int32) { + o.ProgramID = v +} + +// GetName returns the Name field value +func (o *LoyaltyTier) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *LoyaltyTier) SetName(v string) { + o.Name = v +} + +// GetMinPoints returns the MinPoints field value +func (o *LoyaltyTier) GetMinPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.MinPoints +} + +// SetMinPoints sets field value +func (o *LoyaltyTier) SetMinPoints(v float32) { + o.MinPoints = v +} + +type NullableLoyaltyTier struct { + Value LoyaltyTier + ExplicitNull bool +} + +func (v NullableLoyaltyTier) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyTier) 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_custom_effect.go b/model_new_custom_effect.go new file mode 100644 index 00000000..a5344a64 --- /dev/null +++ b/model_new_custom_effect.go @@ -0,0 +1,215 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// NewCustomEffect struct for NewCustomEffect +type NewCustomEffect struct { + // The name of this effect. + Name string `json:"name"` + // The title of this effect. + Title string `json:"title"` + // The JSON payload of this effect. + Payload string `json:"payload"` + // The description of this effect. + Description *string `json:"description,omitempty"` + // Determines if this effect is active. + Enabled bool `json:"enabled"` + // A list of the IDs of the applications that this effect is enabled for + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // Array of template argument definitions + Params *[]TemplateArgDef `json:"params,omitempty"` +} + +// GetName returns the Name field value +func (o *NewCustomEffect) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *NewCustomEffect) SetName(v string) { + o.Name = v +} + +// GetTitle returns the Title field value +func (o *NewCustomEffect) GetTitle() string { + if o == nil { + var ret string + return ret + } + + return o.Title +} + +// SetTitle sets field value +func (o *NewCustomEffect) SetTitle(v string) { + o.Title = v +} + +// GetPayload returns the Payload field value +func (o *NewCustomEffect) GetPayload() string { + if o == nil { + var ret string + return ret + } + + return o.Payload +} + +// SetPayload sets field value +func (o *NewCustomEffect) SetPayload(v string) { + o.Payload = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *NewCustomEffect) 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 *NewCustomEffect) 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 *NewCustomEffect) 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 *NewCustomEffect) SetDescription(v string) { + o.Description = &v +} + +// GetEnabled returns the Enabled field value +func (o *NewCustomEffect) GetEnabled() bool { + if o == nil { + var ret bool + return ret + } + + return o.Enabled +} + +// SetEnabled sets field value +func (o *NewCustomEffect) SetEnabled(v bool) { + o.Enabled = v +} + +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *NewCustomEffect) 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 *NewCustomEffect) 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 *NewCustomEffect) 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 *NewCustomEffect) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +// GetParams returns the Params field value if set, zero value otherwise. +func (o *NewCustomEffect) GetParams() []TemplateArgDef { + if o == nil || o.Params == nil { + var ret []TemplateArgDef + return ret + } + return *o.Params +} + +// GetParamsOk returns a tuple with the Params field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewCustomEffect) GetParamsOk() ([]TemplateArgDef, bool) { + if o == nil || o.Params == nil { + var ret []TemplateArgDef + return ret, false + } + return *o.Params, true +} + +// HasParams returns a boolean if a field has been set. +func (o *NewCustomEffect) HasParams() bool { + if o != nil && o.Params != nil { + return true + } + + return false +} + +// SetParams gets a reference to the given []TemplateArgDef and assigns it to the Params field. +func (o *NewCustomEffect) SetParams(v []TemplateArgDef) { + o.Params = &v +} + +type NullableNewCustomEffect struct { + Value NewCustomEffect + ExplicitNull bool +} + +func (v NullableNewCustomEffect) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewCustomEffect) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_giveaways_pool.go b/model_new_giveaways_pool.go new file mode 100644 index 00000000..b4b34503 --- /dev/null +++ b/model_new_giveaways_pool.go @@ -0,0 +1,129 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// NewGiveawaysPool struct for NewGiveawaysPool +type NewGiveawaysPool struct { + // The name of this giveaways pool. + Name string `json:"name"` + // The description of this giveaways pool. + Description *string `json:"description,omitempty"` + // A list of the IDs of the applications that this giveaways pool is enabled for + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` +} + +// GetName returns the Name field value +func (o *NewGiveawaysPool) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *NewGiveawaysPool) SetName(v string) { + o.Name = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *NewGiveawaysPool) 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 *NewGiveawaysPool) 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 *NewGiveawaysPool) 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 *NewGiveawaysPool) SetDescription(v string) { + o.Description = &v +} + +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *NewGiveawaysPool) 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 *NewGiveawaysPool) 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 *NewGiveawaysPool) 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 *NewGiveawaysPool) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +type NullableNewGiveawaysPool struct { + Value NewGiveawaysPool + ExplicitNull bool +} + +func (v NullableNewGiveawaysPool) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewGiveawaysPool) 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_tier.go b/model_new_loyalty_tier.go new file mode 100644 index 00000000..2db288f3 --- /dev/null +++ b/model_new_loyalty_tier.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" +) + +// NewLoyaltyTier A new loyalty tier +type NewLoyaltyTier struct { + // The name of the tier + Name string `json:"name"` + // The minimum amount of points required to be eligible for the tier + MinPoints float32 `json:"minPoints"` +} + +// GetName returns the Name field value +func (o *NewLoyaltyTier) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *NewLoyaltyTier) SetName(v string) { + o.Name = v +} + +// GetMinPoints returns the MinPoints field value +func (o *NewLoyaltyTier) GetMinPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.MinPoints +} + +// SetMinPoints sets field value +func (o *NewLoyaltyTier) SetMinPoints(v float32) { + o.MinPoints = v +} + +type NullableNewLoyaltyTier struct { + Value NewLoyaltyTier + ExplicitNull bool +} + +func (v NullableNewLoyaltyTier) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewLoyaltyTier) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_referral.go b/model_new_referral.go index 5f7cde13..72b1b6a7 100644 --- a/model_new_referral.go +++ b/model_new_referral.go @@ -15,18 +15,121 @@ import ( "time" ) -// NewReferral struct for NewReferral +// NewReferral type NewReferral struct { + // Timestamp at which point the referral code becomes valid. + StartDate *time.Time `json:"startDate,omitempty"` + // Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. + ExpiryDate *time.Time `json:"expiryDate,omitempty"` + // The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + UsageLimit *int32 `json:"usageLimit,omitempty"` // ID of the campaign from which the referral received the referral code. CampaignId int32 `json:"campaignId"` - // The Integration Id of the Advocate's Profile + // The Integration ID of the Advocate's Profile. AdvocateProfileIntegrationId string `json:"advocateProfileIntegrationId"` // An optional Integration ID of the Friend's Profile FriendProfileIntegrationId *string `json:"friendProfileIntegrationId,omitempty"` - // Timestamp at which point the referral code becomes valid. - StartDate *time.Time `json:"startDate,omitempty"` - // Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. - ExpiryDate *time.Time `json:"expiryDate,omitempty"` + // Arbitrary properties associated with this item. + Attributes *map[string]interface{} `json:"attributes,omitempty"` +} + +// GetStartDate returns the StartDate field value if set, zero value otherwise. +func (o *NewReferral) 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 *NewReferral) 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 *NewReferral) 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 *NewReferral) SetStartDate(v time.Time) { + o.StartDate = &v +} + +// GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise. +func (o *NewReferral) 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 *NewReferral) 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 *NewReferral) HasExpiryDate() bool { + if o != nil && o.ExpiryDate != nil { + return true + } + + return false +} + +// SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +func (o *NewReferral) SetExpiryDate(v time.Time) { + o.ExpiryDate = &v +} + +// GetUsageLimit returns the UsageLimit field value if set, zero value otherwise. +func (o *NewReferral) GetUsageLimit() int32 { + if o == nil || o.UsageLimit == nil { + var ret int32 + return ret + } + return *o.UsageLimit +} + +// GetUsageLimitOk returns a tuple with the UsageLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewReferral) GetUsageLimitOk() (int32, bool) { + if o == nil || o.UsageLimit == nil { + var ret int32 + return ret, false + } + return *o.UsageLimit, true +} + +// HasUsageLimit returns a boolean if a field has been set. +func (o *NewReferral) HasUsageLimit() bool { + if o != nil && o.UsageLimit != nil { + return true + } + + return false +} + +// SetUsageLimit gets a reference to the given int32 and assigns it to the UsageLimit field. +func (o *NewReferral) SetUsageLimit(v int32) { + o.UsageLimit = &v } // GetCampaignId returns the CampaignId field value @@ -92,70 +195,37 @@ func (o *NewReferral) SetFriendProfileIntegrationId(v string) { o.FriendProfileIntegrationId = &v } -// GetStartDate returns the StartDate field value if set, zero value otherwise. -func (o *NewReferral) GetStartDate() time.Time { - if o == nil || o.StartDate == nil { - var ret time.Time +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *NewReferral) GetAttributes() map[string]interface{} { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} return ret } - return *o.StartDate + return *o.Attributes } -// GetStartDateOk returns a tuple with the StartDate field value if set, zero value otherwise +// 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 *NewReferral) GetStartDateOk() (time.Time, bool) { - if o == nil || o.StartDate == nil { - var ret time.Time +func (o *NewReferral) GetAttributesOk() (map[string]interface{}, bool) { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} return ret, false } - return *o.StartDate, true + return *o.Attributes, true } -// HasStartDate returns a boolean if a field has been set. -func (o *NewReferral) HasStartDate() bool { - if o != nil && o.StartDate != nil { +// HasAttributes returns a boolean if a field has been set. +func (o *NewReferral) HasAttributes() bool { + if o != nil && o.Attributes != nil { return true } return false } -// SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. -func (o *NewReferral) SetStartDate(v time.Time) { - o.StartDate = &v -} - -// GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise. -func (o *NewReferral) 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 *NewReferral) 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 *NewReferral) HasExpiryDate() bool { - if o != nil && o.ExpiryDate != nil { - return true - } - - return false -} - -// SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. -func (o *NewReferral) SetExpiryDate(v time.Time) { - o.ExpiryDate = &v +// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. +func (o *NewReferral) SetAttributes(v map[string]interface{}) { + o.Attributes = &v } type NullableNewReferral struct { diff --git a/model_new_referrals_for_multiple_advocates.go b/model_new_referrals_for_multiple_advocates.go new file mode 100644 index 00000000..85f0e5a1 --- /dev/null +++ b/model_new_referrals_for_multiple_advocates.go @@ -0,0 +1,269 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// NewReferralsForMultipleAdvocates +type NewReferralsForMultipleAdvocates struct { + // Timestamp at which point the referral code becomes valid. + StartDate *time.Time `json:"startDate,omitempty"` + // Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. + ExpiryDate *time.Time `json:"expiryDate,omitempty"` + // The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + UsageLimit int32 `json:"usageLimit"` + // The ID of the campaign from which the referral received the referral code. + CampaignId int32 `json:"campaignId"` + // An array containing all the respective advocate profiles. + AdvocateProfileIntegrationIds []string `json:"advocateProfileIntegrationIds"` + // Arbitrary properties associated with this item. + Attributes *map[string]interface{} `json:"attributes,omitempty"` + // Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). + ValidCharacters *[]string `json:"validCharacters,omitempty"` + // The pattern that will be used to generate referrals. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set. + ReferralPattern *string `json:"referralPattern,omitempty"` +} + +// GetStartDate returns the StartDate field value if set, zero value otherwise. +func (o *NewReferralsForMultipleAdvocates) 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 *NewReferralsForMultipleAdvocates) 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 *NewReferralsForMultipleAdvocates) 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 *NewReferralsForMultipleAdvocates) SetStartDate(v time.Time) { + o.StartDate = &v +} + +// GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise. +func (o *NewReferralsForMultipleAdvocates) 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 *NewReferralsForMultipleAdvocates) 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 *NewReferralsForMultipleAdvocates) HasExpiryDate() bool { + if o != nil && o.ExpiryDate != nil { + return true + } + + return false +} + +// SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +func (o *NewReferralsForMultipleAdvocates) SetExpiryDate(v time.Time) { + o.ExpiryDate = &v +} + +// GetUsageLimit returns the UsageLimit field value +func (o *NewReferralsForMultipleAdvocates) GetUsageLimit() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.UsageLimit +} + +// SetUsageLimit sets field value +func (o *NewReferralsForMultipleAdvocates) SetUsageLimit(v int32) { + o.UsageLimit = v +} + +// GetCampaignId returns the CampaignId field value +func (o *NewReferralsForMultipleAdvocates) GetCampaignId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CampaignId +} + +// SetCampaignId sets field value +func (o *NewReferralsForMultipleAdvocates) SetCampaignId(v int32) { + o.CampaignId = v +} + +// GetAdvocateProfileIntegrationIds returns the AdvocateProfileIntegrationIds field value +func (o *NewReferralsForMultipleAdvocates) GetAdvocateProfileIntegrationIds() []string { + if o == nil { + var ret []string + return ret + } + + return o.AdvocateProfileIntegrationIds +} + +// SetAdvocateProfileIntegrationIds sets field value +func (o *NewReferralsForMultipleAdvocates) SetAdvocateProfileIntegrationIds(v []string) { + o.AdvocateProfileIntegrationIds = v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *NewReferralsForMultipleAdvocates) 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 *NewReferralsForMultipleAdvocates) 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 *NewReferralsForMultipleAdvocates) 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 *NewReferralsForMultipleAdvocates) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +// GetValidCharacters returns the ValidCharacters field value if set, zero value otherwise. +func (o *NewReferralsForMultipleAdvocates) GetValidCharacters() []string { + if o == nil || o.ValidCharacters == nil { + var ret []string + return ret + } + return *o.ValidCharacters +} + +// GetValidCharactersOk returns a tuple with the ValidCharacters field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewReferralsForMultipleAdvocates) GetValidCharactersOk() ([]string, bool) { + if o == nil || o.ValidCharacters == nil { + var ret []string + return ret, false + } + return *o.ValidCharacters, true +} + +// HasValidCharacters returns a boolean if a field has been set. +func (o *NewReferralsForMultipleAdvocates) HasValidCharacters() bool { + if o != nil && o.ValidCharacters != nil { + return true + } + + return false +} + +// SetValidCharacters gets a reference to the given []string and assigns it to the ValidCharacters field. +func (o *NewReferralsForMultipleAdvocates) SetValidCharacters(v []string) { + o.ValidCharacters = &v +} + +// GetReferralPattern returns the ReferralPattern field value if set, zero value otherwise. +func (o *NewReferralsForMultipleAdvocates) GetReferralPattern() string { + if o == nil || o.ReferralPattern == nil { + var ret string + return ret + } + return *o.ReferralPattern +} + +// GetReferralPatternOk returns a tuple with the ReferralPattern field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewReferralsForMultipleAdvocates) GetReferralPatternOk() (string, bool) { + if o == nil || o.ReferralPattern == nil { + var ret string + return ret, false + } + return *o.ReferralPattern, true +} + +// HasReferralPattern returns a boolean if a field has been set. +func (o *NewReferralsForMultipleAdvocates) HasReferralPattern() bool { + if o != nil && o.ReferralPattern != nil { + return true + } + + return false +} + +// SetReferralPattern gets a reference to the given string and assigns it to the ReferralPattern field. +func (o *NewReferralsForMultipleAdvocates) SetReferralPattern(v string) { + o.ReferralPattern = &v +} + +type NullableNewReferralsForMultipleAdvocates struct { + Value NewReferralsForMultipleAdvocates + ExplicitNull bool +} + +func (v NullableNewReferralsForMultipleAdvocates) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewReferralsForMultipleAdvocates) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_role.go b/model_new_role.go index d0dcfdba..7752de25 100644 --- a/model_new_role.go +++ b/model_new_role.go @@ -22,7 +22,7 @@ type NewRole struct { Description *string `json:"description,omitempty"` // Role Policy this should be a stringified blob of json Acl string `json:"acl"` - // An array of userIDs + // An array of user identifiers Users []int32 `json:"users"` } diff --git a/model_referral.go b/model_referral.go index 7f1c77b5..526c3e59 100644 --- a/model_referral.go +++ b/model_referral.go @@ -21,22 +21,28 @@ type Referral struct { Id int32 `json:"id"` // The exact moment this entity was created. Created time.Time `json:"created"` + // Timestamp at which point the referral code becomes valid. + StartDate *time.Time `json:"startDate,omitempty"` + // Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. + ExpiryDate *time.Time `json:"expiryDate,omitempty"` + // The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + UsageLimit int32 `json:"usageLimit"` // ID of the campaign from which the referral received the referral code. CampaignId int32 `json:"campaignId"` - // The Integration Id of the Advocate's Profile + // The Integration ID of the Advocate's Profile. AdvocateProfileIntegrationId string `json:"advocateProfileIntegrationId"` // An optional Integration ID of the Friend's Profile FriendProfileIntegrationId *string `json:"friendProfileIntegrationId,omitempty"` - // Timestamp at which point the referral code becomes valid. - StartDate *time.Time `json:"startDate,omitempty"` - // Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. - ExpiryDate *time.Time `json:"expiryDate,omitempty"` + // Arbitrary properties associated with this item. + Attributes *map[string]interface{} `json:"attributes,omitempty"` + // The ID of the Import which created this referral. + ImportId *int32 `json:"importId,omitempty"` // The actual referral code. Code string `json:"code"` // The number of times this referral code has been successfully used. UsageCounter int32 `json:"usageCounter"` - // The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. - UsageLimit int32 `json:"usageLimit"` + // The ID of the batch the referrals belong to. + BatchId *string `json:"batchId,omitempty"` } // GetId returns the Id field value @@ -69,6 +75,87 @@ func (o *Referral) SetCreated(v time.Time) { o.Created = v } +// GetStartDate returns the StartDate field value if set, zero value otherwise. +func (o *Referral) 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 *Referral) 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 *Referral) 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 *Referral) SetStartDate(v time.Time) { + o.StartDate = &v +} + +// GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise. +func (o *Referral) 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 *Referral) 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 *Referral) HasExpiryDate() bool { + if o != nil && o.ExpiryDate != nil { + return true + } + + return false +} + +// SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +func (o *Referral) SetExpiryDate(v time.Time) { + o.ExpiryDate = &v +} + +// GetUsageLimit returns the UsageLimit field value +func (o *Referral) GetUsageLimit() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.UsageLimit +} + +// SetUsageLimit sets field value +func (o *Referral) SetUsageLimit(v int32) { + o.UsageLimit = v +} + // GetCampaignId returns the CampaignId field value func (o *Referral) GetCampaignId() int32 { if o == nil { @@ -132,70 +219,70 @@ func (o *Referral) SetFriendProfileIntegrationId(v string) { o.FriendProfileIntegrationId = &v } -// GetStartDate returns the StartDate field value if set, zero value otherwise. -func (o *Referral) GetStartDate() time.Time { - if o == nil || o.StartDate == nil { - var ret time.Time +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *Referral) GetAttributes() map[string]interface{} { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} return ret } - return *o.StartDate + return *o.Attributes } -// GetStartDateOk returns a tuple with the StartDate field value if set, zero value otherwise +// 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 *Referral) GetStartDateOk() (time.Time, bool) { - if o == nil || o.StartDate == nil { - var ret time.Time +func (o *Referral) GetAttributesOk() (map[string]interface{}, bool) { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} return ret, false } - return *o.StartDate, true + return *o.Attributes, true } -// HasStartDate returns a boolean if a field has been set. -func (o *Referral) HasStartDate() bool { - if o != nil && o.StartDate != nil { +// HasAttributes returns a boolean if a field has been set. +func (o *Referral) HasAttributes() bool { + if o != nil && o.Attributes != nil { return true } return false } -// SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. -func (o *Referral) SetStartDate(v time.Time) { - o.StartDate = &v +// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. +func (o *Referral) SetAttributes(v map[string]interface{}) { + o.Attributes = &v } -// GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise. -func (o *Referral) GetExpiryDate() time.Time { - if o == nil || o.ExpiryDate == nil { - var ret time.Time +// GetImportId returns the ImportId field value if set, zero value otherwise. +func (o *Referral) GetImportId() int32 { + if o == nil || o.ImportId == nil { + var ret int32 return ret } - return *o.ExpiryDate + return *o.ImportId } -// GetExpiryDateOk returns a tuple with the ExpiryDate field value if set, zero value otherwise +// GetImportIdOk returns a tuple with the ImportId field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *Referral) GetExpiryDateOk() (time.Time, bool) { - if o == nil || o.ExpiryDate == nil { - var ret time.Time +func (o *Referral) GetImportIdOk() (int32, bool) { + if o == nil || o.ImportId == nil { + var ret int32 return ret, false } - return *o.ExpiryDate, true + return *o.ImportId, true } -// HasExpiryDate returns a boolean if a field has been set. -func (o *Referral) HasExpiryDate() bool { - if o != nil && o.ExpiryDate != nil { +// HasImportId returns a boolean if a field has been set. +func (o *Referral) HasImportId() bool { + if o != nil && o.ImportId != nil { return true } return false } -// SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. -func (o *Referral) SetExpiryDate(v time.Time) { - o.ExpiryDate = &v +// SetImportId gets a reference to the given int32 and assigns it to the ImportId field. +func (o *Referral) SetImportId(v int32) { + o.ImportId = &v } // GetCode returns the Code field value @@ -228,19 +315,37 @@ func (o *Referral) SetUsageCounter(v int32) { o.UsageCounter = v } -// GetUsageLimit returns the UsageLimit field value -func (o *Referral) GetUsageLimit() int32 { - if o == nil { - var ret int32 +// GetBatchId returns the BatchId field value if set, zero value otherwise. +func (o *Referral) GetBatchId() string { + if o == nil || o.BatchId == nil { + var ret string return ret } + return *o.BatchId +} - return o.UsageLimit +// GetBatchIdOk returns a tuple with the BatchId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Referral) GetBatchIdOk() (string, bool) { + if o == nil || o.BatchId == nil { + var ret string + return ret, false + } + return *o.BatchId, true } -// SetUsageLimit sets field value -func (o *Referral) SetUsageLimit(v int32) { - o.UsageLimit = v +// HasBatchId returns a boolean if a field has been set. +func (o *Referral) HasBatchId() bool { + if o != nil && o.BatchId != nil { + return true + } + + return false +} + +// SetBatchId gets a reference to the given string and assigns it to the BatchId field. +func (o *Referral) SetBatchId(v string) { + o.BatchId = &v } type NullableReferral struct { diff --git a/model_referral_constraints.go b/model_referral_constraints.go new file mode 100644 index 00000000..0da69966 --- /dev/null +++ b/model_referral_constraints.go @@ -0,0 +1,148 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// ReferralConstraints struct for ReferralConstraints +type ReferralConstraints struct { + // Timestamp at which point the referral code becomes valid. + StartDate *time.Time `json:"startDate,omitempty"` + // Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. + ExpiryDate *time.Time `json:"expiryDate,omitempty"` + // The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + UsageLimit *int32 `json:"usageLimit,omitempty"` +} + +// GetStartDate returns the StartDate field value if set, zero value otherwise. +func (o *ReferralConstraints) 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 *ReferralConstraints) 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 *ReferralConstraints) 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 *ReferralConstraints) SetStartDate(v time.Time) { + o.StartDate = &v +} + +// GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise. +func (o *ReferralConstraints) 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 *ReferralConstraints) 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 *ReferralConstraints) HasExpiryDate() bool { + if o != nil && o.ExpiryDate != nil { + return true + } + + return false +} + +// SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +func (o *ReferralConstraints) SetExpiryDate(v time.Time) { + o.ExpiryDate = &v +} + +// GetUsageLimit returns the UsageLimit field value if set, zero value otherwise. +func (o *ReferralConstraints) GetUsageLimit() int32 { + if o == nil || o.UsageLimit == nil { + var ret int32 + return ret + } + return *o.UsageLimit +} + +// GetUsageLimitOk returns a tuple with the UsageLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ReferralConstraints) GetUsageLimitOk() (int32, bool) { + if o == nil || o.UsageLimit == nil { + var ret int32 + return ret, false + } + return *o.UsageLimit, true +} + +// HasUsageLimit returns a boolean if a field has been set. +func (o *ReferralConstraints) HasUsageLimit() bool { + if o != nil && o.UsageLimit != nil { + return true + } + + return false +} + +// SetUsageLimit gets a reference to the given int32 and assigns it to the UsageLimit field. +func (o *ReferralConstraints) SetUsageLimit(v int32) { + o.UsageLimit = &v +} + +type NullableReferralConstraints struct { + Value ReferralConstraints + ExplicitNull bool +} + +func (v NullableReferralConstraints) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableReferralConstraints) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_role.go b/model_role.go index 96b32a2d..99139db8 100644 --- a/model_role.go +++ b/model_role.go @@ -12,24 +12,29 @@ package talon import ( "bytes" "encoding/json" + "time" ) // Role type Role struct { - // The ID of the role corresponding to the DB row + // Unique ID for this entity. Id int32 `json:"id"` - // The ID of the Talon.One account that owns this role. - AccountID int32 `json:"accountID"` + // 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 ID of the Campaign Group this role was created for. CampaignGroupID *int32 `json:"campaignGroupID,omitempty"` // Name of the role - Name *string `json:"name,omitempty"` + Name string `json:"name"` // Description of the role Description *string `json:"description,omitempty"` // A list of user identifiers assigned to this role Members *[]int32 `json:"members,omitempty"` // Role ACL Policy - Acl *map[string]interface{} `json:"acl,omitempty"` + Acl map[string]interface{} `json:"acl"` } // GetId returns the Id field value @@ -47,19 +52,49 @@ func (o *Role) SetId(v int32) { o.Id = v } -// GetAccountID returns the AccountID field value -func (o *Role) GetAccountID() int32 { +// GetCreated returns the Created field value +func (o *Role) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *Role) SetCreated(v time.Time) { + o.Created = v +} + +// GetModified returns the Modified field value +func (o *Role) GetModified() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Modified +} + +// SetModified sets field value +func (o *Role) SetModified(v time.Time) { + o.Modified = v +} + +// GetAccountId returns the AccountId field value +func (o *Role) GetAccountId() int32 { if o == nil { var ret int32 return ret } - return o.AccountID + return o.AccountId } -// SetAccountID sets field value -func (o *Role) SetAccountID(v int32) { - o.AccountID = v +// SetAccountId sets field value +func (o *Role) SetAccountId(v int32) { + o.AccountId = v } // GetCampaignGroupID returns the CampaignGroupID field value if set, zero value otherwise. @@ -95,37 +130,19 @@ func (o *Role) SetCampaignGroupID(v int32) { o.CampaignGroupID = &v } -// GetName returns the Name field value if set, zero value otherwise. +// GetName returns the Name field value func (o *Role) GetName() string { - if o == nil || o.Name == nil { + if o == nil { var ret string return ret } - return *o.Name -} - -// GetNameOk returns a tuple with the Name field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *Role) GetNameOk() (string, bool) { - if o == nil || o.Name == nil { - var ret string - return ret, false - } - return *o.Name, true -} - -// HasName returns a boolean if a field has been set. -func (o *Role) HasName() bool { - if o != nil && o.Name != nil { - return true - } - return false + return o.Name } -// SetName gets a reference to the given string and assigns it to the Name field. +// SetName sets field value func (o *Role) SetName(v string) { - o.Name = &v + o.Name = v } // GetDescription returns the Description field value if set, zero value otherwise. @@ -194,37 +211,19 @@ func (o *Role) SetMembers(v []int32) { o.Members = &v } -// GetAcl returns the Acl field value if set, zero value otherwise. +// GetAcl returns the Acl field value func (o *Role) GetAcl() map[string]interface{} { - if o == nil || o.Acl == nil { + if o == nil { var ret map[string]interface{} return ret } - return *o.Acl -} - -// 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() (map[string]interface{}, bool) { - if o == nil || o.Acl == nil { - var ret map[string]interface{} - return ret, false - } - return *o.Acl, true -} -// HasAcl returns a boolean if a field has been set. -func (o *Role) HasAcl() bool { - if o != nil && o.Acl != nil { - return true - } - - return false + return o.Acl } -// SetAcl gets a reference to the given map[string]interface{} and assigns it to the Acl field. +// SetAcl sets field value func (o *Role) SetAcl(v map[string]interface{}) { - o.Acl = &v + o.Acl = v } type NullableRole struct { diff --git a/model_update_custom_effect.go b/model_update_custom_effect.go new file mode 100644 index 00000000..228a6ba3 --- /dev/null +++ b/model_update_custom_effect.go @@ -0,0 +1,215 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// UpdateCustomEffect +type UpdateCustomEffect struct { + // The name of this effect. + Name string `json:"name"` + // The title of this effect. + Title string `json:"title"` + // The JSON payload of this effect. + Payload string `json:"payload"` + // The description of this effect. + Description *string `json:"description,omitempty"` + // Determines if this effect is active. + Enabled bool `json:"enabled"` + // A list of the IDs of the applications that this effect is enabled for + SubscribedApplicationsIds *[]int32 `json:"subscribedApplicationsIds,omitempty"` + // Array of template argument definitions + Params *[]TemplateArgDef `json:"params,omitempty"` +} + +// GetName returns the Name field value +func (o *UpdateCustomEffect) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *UpdateCustomEffect) SetName(v string) { + o.Name = v +} + +// GetTitle returns the Title field value +func (o *UpdateCustomEffect) GetTitle() string { + if o == nil { + var ret string + return ret + } + + return o.Title +} + +// SetTitle sets field value +func (o *UpdateCustomEffect) SetTitle(v string) { + o.Title = v +} + +// GetPayload returns the Payload field value +func (o *UpdateCustomEffect) GetPayload() string { + if o == nil { + var ret string + return ret + } + + return o.Payload +} + +// SetPayload sets field value +func (o *UpdateCustomEffect) SetPayload(v string) { + o.Payload = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *UpdateCustomEffect) 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 *UpdateCustomEffect) 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 *UpdateCustomEffect) 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 *UpdateCustomEffect) SetDescription(v string) { + o.Description = &v +} + +// GetEnabled returns the Enabled field value +func (o *UpdateCustomEffect) GetEnabled() bool { + if o == nil { + var ret bool + return ret + } + + return o.Enabled +} + +// SetEnabled sets field value +func (o *UpdateCustomEffect) SetEnabled(v bool) { + o.Enabled = v +} + +// GetSubscribedApplicationsIds returns the SubscribedApplicationsIds field value if set, zero value otherwise. +func (o *UpdateCustomEffect) 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 *UpdateCustomEffect) 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 *UpdateCustomEffect) 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 *UpdateCustomEffect) SetSubscribedApplicationsIds(v []int32) { + o.SubscribedApplicationsIds = &v +} + +// GetParams returns the Params field value if set, zero value otherwise. +func (o *UpdateCustomEffect) GetParams() []TemplateArgDef { + if o == nil || o.Params == nil { + var ret []TemplateArgDef + return ret + } + return *o.Params +} + +// GetParamsOk returns a tuple with the Params field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateCustomEffect) GetParamsOk() ([]TemplateArgDef, bool) { + if o == nil || o.Params == nil { + var ret []TemplateArgDef + return ret, false + } + return *o.Params, true +} + +// HasParams returns a boolean if a field has been set. +func (o *UpdateCustomEffect) HasParams() bool { + if o != nil && o.Params != nil { + return true + } + + return false +} + +// SetParams gets a reference to the given []TemplateArgDef and assigns it to the Params field. +func (o *UpdateCustomEffect) SetParams(v []TemplateArgDef) { + o.Params = &v +} + +type NullableUpdateCustomEffect struct { + Value UpdateCustomEffect + ExplicitNull bool +} + +func (v NullableUpdateCustomEffect) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableUpdateCustomEffect) 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_tier.go b/model_update_loyalty_tier.go new file mode 100644 index 00000000..96664f7e --- /dev/null +++ b/model_update_loyalty_tier.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" +) + +// UpdateLoyaltyTier +type UpdateLoyaltyTier struct { + // The name of the tier + Name string `json:"name"` + // The minimum amount of points required to be eligible for the tier + MinPoints float32 `json:"minPoints"` +} + +// GetName returns the Name field value +func (o *UpdateLoyaltyTier) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *UpdateLoyaltyTier) SetName(v string) { + o.Name = v +} + +// GetMinPoints returns the MinPoints field value +func (o *UpdateLoyaltyTier) GetMinPoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.MinPoints +} + +// SetMinPoints sets field value +func (o *UpdateLoyaltyTier) SetMinPoints(v float32) { + o.MinPoints = v +} + +type NullableUpdateLoyaltyTier struct { + Value UpdateLoyaltyTier + ExplicitNull bool +} + +func (v NullableUpdateLoyaltyTier) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableUpdateLoyaltyTier) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_update_referral.go b/model_update_referral.go new file mode 100644 index 00000000..ff09366d --- /dev/null +++ b/model_update_referral.go @@ -0,0 +1,218 @@ +/* + * Talon.One API + * + * The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/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" +) + +// UpdateReferral struct for UpdateReferral +type UpdateReferral struct { + // An optional Integration ID of the Friend's Profile + FriendProfileIntegrationId *string `json:"friendProfileIntegrationId,omitempty"` + // Timestamp at which point the referral code becomes valid. + StartDate *time.Time `json:"startDate,omitempty"` + // Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. + ExpiryDate *time.Time `json:"expiryDate,omitempty"` + // The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. + UsageLimit *int32 `json:"usageLimit,omitempty"` + // Arbitrary properties associated with this item + Attributes *map[string]interface{} `json:"attributes,omitempty"` +} + +// GetFriendProfileIntegrationId returns the FriendProfileIntegrationId field value if set, zero value otherwise. +func (o *UpdateReferral) GetFriendProfileIntegrationId() string { + if o == nil || o.FriendProfileIntegrationId == nil { + var ret string + return ret + } + return *o.FriendProfileIntegrationId +} + +// GetFriendProfileIntegrationIdOk returns a tuple with the FriendProfileIntegrationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateReferral) GetFriendProfileIntegrationIdOk() (string, bool) { + if o == nil || o.FriendProfileIntegrationId == nil { + var ret string + return ret, false + } + return *o.FriendProfileIntegrationId, true +} + +// HasFriendProfileIntegrationId returns a boolean if a field has been set. +func (o *UpdateReferral) HasFriendProfileIntegrationId() bool { + if o != nil && o.FriendProfileIntegrationId != nil { + return true + } + + return false +} + +// SetFriendProfileIntegrationId gets a reference to the given string and assigns it to the FriendProfileIntegrationId field. +func (o *UpdateReferral) SetFriendProfileIntegrationId(v string) { + o.FriendProfileIntegrationId = &v +} + +// GetStartDate returns the StartDate field value if set, zero value otherwise. +func (o *UpdateReferral) 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 *UpdateReferral) 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 *UpdateReferral) 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 *UpdateReferral) SetStartDate(v time.Time) { + o.StartDate = &v +} + +// GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise. +func (o *UpdateReferral) 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 *UpdateReferral) 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 *UpdateReferral) HasExpiryDate() bool { + if o != nil && o.ExpiryDate != nil { + return true + } + + return false +} + +// SetExpiryDate gets a reference to the given time.Time and assigns it to the ExpiryDate field. +func (o *UpdateReferral) SetExpiryDate(v time.Time) { + o.ExpiryDate = &v +} + +// GetUsageLimit returns the UsageLimit field value if set, zero value otherwise. +func (o *UpdateReferral) GetUsageLimit() int32 { + if o == nil || o.UsageLimit == nil { + var ret int32 + return ret + } + return *o.UsageLimit +} + +// GetUsageLimitOk returns a tuple with the UsageLimit field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateReferral) GetUsageLimitOk() (int32, bool) { + if o == nil || o.UsageLimit == nil { + var ret int32 + return ret, false + } + return *o.UsageLimit, true +} + +// HasUsageLimit returns a boolean if a field has been set. +func (o *UpdateReferral) HasUsageLimit() bool { + if o != nil && o.UsageLimit != nil { + return true + } + + return false +} + +// SetUsageLimit gets a reference to the given int32 and assigns it to the UsageLimit field. +func (o *UpdateReferral) SetUsageLimit(v int32) { + o.UsageLimit = &v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *UpdateReferral) 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 *UpdateReferral) 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 *UpdateReferral) 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 *UpdateReferral) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +type NullableUpdateReferral struct { + Value UpdateReferral + ExplicitNull bool +} + +func (v NullableUpdateReferral) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableUpdateReferral) 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_role.go b/model_update_role.go index 95b90bb4..eb07a90c 100644 --- a/model_update_role.go +++ b/model_update_role.go @@ -22,7 +22,7 @@ type UpdateRole struct { Description *string `json:"description,omitempty"` // Role Policy this should be a stringified blob of json Acl *string `json:"acl,omitempty"` - // an array of user identifiers + // An array of user identifiers Users *[]int32 `json:"users,omitempty"` } diff --git a/model_will_award_giveaway_effect_props.go b/model_will_award_giveaway_effect_props.go new file mode 100644 index 00000000..30fd6015 --- /dev/null +++ b/model_will_award_giveaway_effect_props.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" +) + +// WillAwardGiveawayEffectProps The properties specific to the \"awardGiveaway\" effect when the session is not closed yet. This effect replaces \"awardGiveaway\" only when updating a session with any state other than \"closed\". This is to ensure no giveaway codes are leaked when they are still not guaranteed to be awarded. +type WillAwardGiveawayEffectProps struct { + // The ID of the giveaways pool the code will be taken from. + PoolId int32 `json:"poolId"` + // The name of the giveaways pool the code will be taken from. + PoolName string `json:"poolName"` + // The integration ID of the profile that will be awarded the giveaway. + RecipientIntegrationId string `json:"recipientIntegrationId"` +} + +// GetPoolId returns the PoolId field value +func (o *WillAwardGiveawayEffectProps) GetPoolId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.PoolId +} + +// SetPoolId sets field value +func (o *WillAwardGiveawayEffectProps) SetPoolId(v int32) { + o.PoolId = v +} + +// GetPoolName returns the PoolName field value +func (o *WillAwardGiveawayEffectProps) GetPoolName() string { + if o == nil { + var ret string + return ret + } + + return o.PoolName +} + +// SetPoolName sets field value +func (o *WillAwardGiveawayEffectProps) SetPoolName(v string) { + o.PoolName = v +} + +// GetRecipientIntegrationId returns the RecipientIntegrationId field value +func (o *WillAwardGiveawayEffectProps) GetRecipientIntegrationId() string { + if o == nil { + var ret string + return ret + } + + return o.RecipientIntegrationId +} + +// SetRecipientIntegrationId sets field value +func (o *WillAwardGiveawayEffectProps) SetRecipientIntegrationId(v string) { + o.RecipientIntegrationId = v +} + +type NullableWillAwardGiveawayEffectProps struct { + Value WillAwardGiveawayEffectProps + ExplicitNull bool +} + +func (v NullableWillAwardGiveawayEffectProps) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableWillAwardGiveawayEffectProps) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +}