From 73d35fdfb1863803b31e3f3b0c5a9002a8baa2d4 Mon Sep 17 00:00:00 2001 From: p-zielinski Date: Wed, 10 Jul 2024 16:44:48 +0200 Subject: [PATCH] v6.0.0 in progress --- ENDPOINTS-COVERAGE.md | 1057 +++++------------ README.md | 2 + docs/AccessSettingsCampaignAssignmentsList.md | 11 + docs/AreaStoreCampaignAssignment.md | 12 + docs/Campaign.md | 1 + docs/CampaignsCreateResponseBody.md | 1 + docs/CampaignsGetResponseBody.md | 1 + docs/CampaignsUpdateResponseBody.md | 1 + lib/VoucherifySdk.rb | 2 + ...cess_settings_campaign_assignments_list.rb | 317 +++++ .../models/area_store_campaign_assignment.rb | 297 +++++ lib/VoucherifySdk/models/campaign.rb | 17 +- .../models/campaigns_create_response_body.rb | 17 +- .../models/campaigns_get_response_body.rb | 17 +- .../models/campaigns_update_response_body.rb | 17 +- 15 files changed, 986 insertions(+), 784 deletions(-) create mode 100644 docs/AccessSettingsCampaignAssignmentsList.md create mode 100644 docs/AreaStoreCampaignAssignment.md create mode 100644 lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb create mode 100644 lib/VoucherifySdk/models/area_store_campaign_assignment.rb diff --git a/ENDPOINTS-COVERAGE.md b/ENDPOINTS-COVERAGE.md index f4ad002b..87043f72 100644 --- a/ENDPOINTS-COVERAGE.md +++ b/ENDPOINTS-COVERAGE.md @@ -1,820 +1,341 @@ # Endpoints Coverage -# Table of Contents + +## Table of Content - [Publications](#publications) - - [/v1/publications/create](#v1publicationscreate) - - [/v1/publications](#v1publications) - [Qualifications](#qualifications) - - [/v1/qualifications](#v1qualifications) - [Validations](#validations) - - [/v1/validations](#v1validations) - - [/v1/vouchers/{code}/validate](#v1voucherscodevalidate-deprecated) - - [/v1/promotions/validation](#v1promotionsvalidation-deprecated) - - [/v1/promotions/tiers/{tierId}/validation](#v1promotionstierstieridvalidation-deprecated) - [Redemptions](#redemptions) - - [/v1/redemptions](#v1redemptions) - - [/v1/redemptions/{redemptionId}](#v1redemptionsredemptionid) - - [/v1/vouchers/{code}/redemption](#v1voucherscoderedemption) - - [/v1/redemptions/{redemptionId}/rollback](#v1redemptionsredemptionidrollback) - - [/v1/promotions/tiers/{promotionTierId}/redemption](#v1promotionstierspromotiontieridredemption-deprecated) - - [/v1/redemptions/{parentRedemptionId}/rollbacks](#v1redemptionsparentredemptionidrollbacks) - [Vouchers](#vouchers) - - [/v1/vouchers](#v1vouchers) - - [/v1/vouchers/{code}](#v1voucherscode) - - [/v1/vouchers/{code}/enable](#v1voucherscodeenable) - - [/v1/vouchers/{code}/disable](#v1voucherscodedisable) - - [/v1/vouchers/{code}/balance](#v1voucherscodebalance) - - [/v1/vouchers/{code}/transactions](#v1voucherscodetransactions) - - [/v1/vouchers/{code}/transactions/export](#v1voucherscodetransactionsexport) - - [/v1/vouchers/import](#v1vouchersimport) - - [/v1/vouchers/importCSV](#v1vouchersimportcsv) - - [/v1/vouchers/bulk/async](#v1vouchersbulkasync) - - [/v1/vouchers/metadata/async](#v1vouchersmetadataasync) - - [/v1/vouchers/{code}/sessions/{sessionKey}](#v1voucherscodesessionssessionkey) - - [/v1/vouchers/qualification](#v1vouchersqualification-deprecated) - [Campaigns](#campaigns) - - [/v1/campaigns](#v1campaigns) - - [/v1/campaigns/{campaignId}](#v1campaignscampaignid) - - [/v1/campaigns/{campaignId}/vouchers](#v1campaignscampaignidvouchers) - - [/v1/campaigns/{campaignId}/vouchers/{code}](#v1campaignscampaignidvoucherscode) - - [/v1/campaigns/{campaignId}/import](#v1campaignscampaignidimport) - - [/v1/campaigns/{campaignId}/importCSV](#v1campaignscampaignidimportcsv) - - [/v1/campaigns/qualification](#v1campaignsqualification-deprecated) - - [/v1/campaigns/{campaignId}/enable](#v1campaignscampaignidenable) - - [/v1/campaigns/{campaignId}/disable](#v1campaignscampaigniddisable) - [Promotions](#promotions) - - [/v1/promotions/tiers](#v1promotionstiers) - - [/v1/promotions/{campaignId}/tiers](#v1promotionscampaignidtiers) - - [/v1/promotions/tiers/{promotionTierId}](#v1promotionstierspromotiontierid) - - [/v1/promotions/tiers/{promotionTierId}/enable](#v1promotionstierspromotiontieridenable) - - [/v1/promotions/tiers/{promotionTierId}/disable](#v1promotionstierspromotiontieriddisable) - - [/v1/promotions/stacks](#v1promotionsstacks) - - [/v1/promotions/{campaignId}/stacks](#v1promotionscampaignidstacks) - - [/v1/promotions/{campaignId}/stacks/{stackId}](#v1promotionscampaignidstacksstackid) - [Rewards](#rewards) - - [/v1/rewards](#v1rewards) - - [/v1/rewards/{rewardId}](#v1rewardsrewardid) - - [/v1/rewards/{rewardId}/assignments](#v1rewardsrewardidassignments) - - [/v1/rewards/{rewardId}/assignments/{assignmentId}](#v1rewardsrewardidassignmentsassignmentid) - [Loyalties](#loyalties) - - [/v1/loyalties](#v1loyalties) - - [/v1/loyalties/{campaignId}](#v1loyaltiescampaignid) - - [/v1/loyalties/{campaignId}/members](#v1loyaltiescampaignidmembers) - - [/v1/loyalties/{campaignId}/members/{memberId}](#v1loyaltiescampaignidmembersmemberid) - - [/v1/loyalties/members/{memberId}](#v1loyaltiesmembersmemberid) - - [/v1/loyalties/{campaignId}/members/{memberId}/activity](#v1loyaltiescampaignidmembersmemberidactivity) - - [/v1/loyalties/members/{memberId}/activity](#v1loyaltiesmembersmemberidactivity) - - [/v1/loyalties/{campaignId}/members/{memberId}/balance](#v1loyaltiescampaignidmembersmemberidbalance) - - [/v1/loyalties/members/{memberId}/balance](#v1loyaltiesmembersmemberidbalance) - - [/v1/loyalties/{campaignId}/members/{memberId}/transfers](#v1loyaltiescampaignidmembersmemberidtransfers) - - [/v1/loyalties/{campaignId}/members/{memberId}/transactions](#v1loyaltiescampaignidmembersmemberidtransactions) - - [/v1/loyalties/members/{memberId}/transactions](#v1loyaltiesmembersmemberidtransactions) - - [/v1/loyalties/members/{memberId}/transactions/export](#v1loyaltiesmembersmemberidtransactionsexport) - - [/v1/loyalties/{campaignId}/members/{memberId}/transactions/export](#v1loyaltiescampaignidmembersmemberidtransactionsexport) - - [/v1/loyalties/{campaignId}/members/{memberId}/points-expiration](#v1loyaltiescampaignidmembersmemberidpoints-expiration) - - [/v1/loyalties/{campaignId}/points-expiration/export](#v1loyaltiescampaignidpoints-expirationexport) - - [/v1/loyalties/{campaignId}/earning-rules](#v1loyaltiescampaignidearning-rules) - - [/v1/loyalties/{campaignId}/earning-rules/{earningRuleId}](#v1loyaltiescampaignidearning-rulesearningruleid) - - [/v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable](#v1loyaltiescampaignidearning-rulesearningruleidenable) - - [/v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable](#v1loyaltiescampaignidearning-rulesearningruleiddisable) - - [/v1/loyalties/members/{memberId}/rewards](#v1loyaltiesmembersmemberidrewards) - - [/v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward](#v1loyaltiescampaignidreward-assignmentsassignmentidreward) - - [/v1/loyalties/{campaignId}/reward-assignments](#v1loyaltiescampaignidreward-assignments) - - [/v1/loyalties/{campaignId}/rewards](#v1loyaltiescampaignidrewards) - - [/v1/loyalties/{campaignId}/reward-assignments/{assignmentId}](#v1loyaltiescampaignidreward-assignmentsassignmentid) - - [/v1/loyalties/{campaignId}/rewards/{assignmentId}](#v1loyaltiescampaignidrewardsassignmentid) - - [/v1/loyalties/{campaignId}/members/{memberId}/redemption](#v1loyaltiescampaignidmembersmemberidredemption) - - [/v1/loyalties/members/{memberId}/redemption](#v1loyaltiesmembersmemberidredemption) - - [/v1/loyalties/{campaignId}/tiers](#v1loyaltiescampaignidtiers) - - [/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}](#v1loyaltiescampaignidtiersloyaltytierid) - - [/v1/loyalties/members/{memberId}/tiers](#v1loyaltiesmembersmemberidtiers) - - [/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules](#v1loyaltiescampaignidtiersloyaltytieridearning-rules) - - [/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards](#v1loyaltiescampaignidtiersloyaltytieridrewards) - [Customers](#customers) - - [/v1/customers](#v1customers) - - [/v1/customers/{customerId}](#v1customerscustomerid) - - [/v1/customers/{customerId}/permanent-deletion](#v1customerscustomeridpermanent-deletion) - - [/v1/customers/importCSV](#v1customersimportcsv) - - [/v1/customers/bulk/async](#v1customersbulkasync) - - [/v1/customers/metadata/async](#v1customersmetadataasync) - - [/v1/customers/{customerId}/consents](#v1customerscustomeridconsents) - - [/v1/customers/{customerId}/activity](#v1customerscustomeridactivity) - - [/v1/customers/{customerId}/activities](#v1customerscustomeridactivities) - - [/v1/customers/{customerId}/segments](#v1customerscustomeridsegments) - - [/v1/customers/{customerId}/redeemables](#v1customerscustomeridredeemables) - [Orders](#orders) - - [/v1/orders](#v1orders) - - [/v1/orders/{orderId}](#v1ordersorderid) - - [/v1/orders/import](#v1ordersimport) - - [/v1/orders/export](#v1ordersexport) - [Products](#products) - - [/v1/products](#v1products) - - [/v1/products/{productId}](#v1productsproductid) - - [/v1/products/bulk/async](#v1productsbulkasync) - - [/v1/products/metadata/async](#v1productsmetadataasync) - - [/v1/skus/{skuId}](#v1skusskuid) - - [/v1/products/{productId}/skus](#v1productsproductidskus) - - [/v1/products/{productId}/skus/{skuId}](#v1productsproductidskusskuid) - - [/v1/products/importCSV](#v1productsimportcsv) - - [/v1/skus/importCSV](#v1skusimportcsv) -- [Product Collections](#product collections) - - [/v1/product-collections](#v1product-collections) - - [/v1/product-collections/{productCollectionId}](#v1product-collectionsproductcollectionid) - - [/v1/product-collections/{productCollectionId}/products](#v1product-collectionsproductcollectionidproducts) -- [Validation Rules](#validation rules) - - [/v1/validation-rules](#v1validation-rules) - - [/v1/validation-rules/{validationRuleId}](#v1validation-rulesvalidationruleid) - - [/v1/validation-rules-assignments](#v1validation-rules-assignments) - - [/v1/validation-rules/{validationRuleId}/assignments](#v1validation-rulesvalidationruleidassignments) - - [/v1/validation-rules/{validationRuleId}/assignments/{assignmentId}](#v1validation-rulesvalidationruleidassignmentsassignmentid) +- [Product Collections](#product-collections) +- [Validation Rules](#validation-rules) - [Segments](#segments) - - [/v1/segments/{segmentId}](#v1segmentssegmentid) - - [/v1/segments](#v1segments) - [Events](#events) - - [/v1/events](#v1events) - [Consents](#consents) - - [/v1/consents](#v1consents) -- [Async Actions](#async actions) - - [/v1/async-actions](#v1async-actions) - - [/v1/async-actions/{asyncActionId}](#v1async-actionsasyncactionid) +- [Async Actions](#async-actions) - [Exports](#exports) - - [/v1/exports](#v1exports) - - [/v1/exports/{exportId}](#v1exportsexportid) - - [/v1/exports/{export_Id}](#v1exportsexport_id) - [Categories](#categories) - - [/v1/categories](#v1categories) - - [/v1/categories/{categoryId}](#v1categoriescategoryid) -- [Metadata Schemas](#metadata schemas) - - [/v1/metadata-schemas](#v1metadata-schemas) - - [/v1/metadata-schemas/{resource}](#v1metadata-schemasresource) +- [Metadata Schemas](#metadata-schemas) - [Locations](#locations) - - [/v1/locations](#v1locations) - - [/v1/locations/{locationId}](#v1locationslocationid) - [Referrals](#referrals) - - [/v1/referrals/{campaignId}/members/{memberId}/holders](#v1referralscampaignidmembersmemberidholders) - - [/v1/referrals/members/{memberId}/holders](#v1referralsmembersmemberidholders) - [Bin](#bin) - - [/v1/trash-bin](#v1trash-bin) - - [/v1/trash-bin/{binEntryId}](#v1trash-binbinentryid) - [Management](#management) - - [/management/v1/projects](#managementv1projects) - - [/management/v1/projects/{projectId}](#managementv1projectsprojectid) - - [/management/v1/projects/{projectId}/users](#managementv1projectsprojectidusers) - - [/management/v1/projects/{projectId}/users/{userId}](#managementv1projectsprojectidusersuserid) - - [/management/v1/projects/{projectId}/stacking-rules](#managementv1projectsprojectidstacking-rules) - - [/management/v1/projects/{projectId}/stacking-rules/{stackingRulesId}](#managementv1projectsprojectidstacking-rulesstackingrulesid) - - [/management/v1/projects/{projectId}/metadata-schemas](#managementv1projectsprojectidmetadata-schemas) - - [/management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId}](#managementv1projectsprojectidmetadata-schemasmetadataschemaid) - - [/management/v1/projects/{projectId}/custom-event-schemas](#managementv1projectsprojectidcustom-event-schemas) - - [/management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId}](#managementv1projectsprojectidcustom-event-schemascustomeventschemaid) - - [/management/v1/projects/{projectId}/webhooks](#managementv1projectsprojectidwebhooks) - - [/management/v1/projects/{projectId}/webhooks/{webhookId}](#managementv1projectsprojectidwebhookswebhookid) - - [/management/v1/projects/{projectId}/branding](#managementv1projectsprojectidbranding) - - [/management/v1/projects/{projectId}/branding/{brandingId}](#managementv1projectsprojectidbrandingbrandingid) - [Client-side](#client-side) - - [/client/v1/qualifications](#clientv1qualifications) - - [/client/v1/promotions/tiers](#clientv1promotionstiers) - - [/client/v1/redemptions](#clientv1redemptions) - - [/client/v1/validations](#clientv1validations) - - [/client/v1/customers/{customerId}/consents](#clientv1customerscustomeridconsents) - - [/client/v1/events](#clientv1events) - - [/client/v1/consents](#clientv1consents) - - [/client/v1/validate](#clientv1validate-deprecated) - - [/client/v1/redeem](#clientv1redeem-deprecated) - - [/client/v1/publish](#clientv1publish) # Endpoints ## Publications -### /v1/publications/create -#### Create Publication (get) - **Supported ✅** -### /v1/publications -#### List Publications (get) - **Supported ✅** -#### Create Publication (post) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| ----------------------- | ------ | ------------------ | ------------------------------------ | ------------- | +| /v1/publications/create | get | Create Publication | supported | | +| /v1/publications | get | List Publications | supported | | +| /v1/publications | post | Create Publication | supported | | ## Qualifications -### /v1/qualifications -#### Check Eligibility (post) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| ------------------ | ------ | ----------------- | ------------------------------------ | ------------- | +| /v1/qualifications | post | Check Eligibility | supported | | ## Validations -### /v1/validations -#### Validate Stackable Discounts (post) - **Supported ✅** -### ~~❗/v1/vouchers/{code}/validate [Deprecated]❗~~ -#### ~~❗Validate Voucher [Deprecated] (post)❗~~ -### ~~❗/v1/promotions/validation [Deprecated]❗~~ -#### ~~❗Validate Promotions [Deprecated] (post)❗~~ -### ~~❗/v1/promotions/tiers/{tierId}/validation [Deprecated]❗~~ -#### ~~❗Validate Promotion Tier [Deprecated] (post)❗~~ +| endpoint | method | summary | is supported | is deprecated | +| ---------------------------------------- | ------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | +| /v1/validations | post | Validate Stackable Discounts | supported | | +| /v1/vouchers/{code}/validate | post | Validate Voucher [Deprecated] | | deprecated | +| /v1/promotions/validation | post | Validate Promotions [Deprecated] | | deprecated | +| /v1/promotions/tiers/{tierId}/validation | post | Validate Promotion Tier [Deprecated] | | deprecated | ## Redemptions -### /v1/redemptions -#### List Redemptions (get) - **Supported ✅** -#### Redeem Stackable Discounts (post) - **Supported ✅** -### /v1/redemptions/{redemptionId} -#### Get Redemption (get) - **Supported ✅** -### /v1/vouchers/{code}/redemption -#### Get Voucher's Redemptions (get) - **Supported ✅** -#### ~~❗Redeem Voucher [Deprecated] (post)❗~~ -### /v1/redemptions/{redemptionId}/rollback -#### Rollback Redemption (post) - **Supported ✅** -### ~~❗/v1/promotions/tiers/{promotionTierId}/redemption [Deprecated]❗~~ -#### ~~❗Redeem Promotion [Deprecated] (post)❗~~ -### /v1/redemptions/{parentRedemptionId}/rollbacks -#### Rollback Stackable Redemptions (post) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| ------------------------------------------------- | ------ | ------------------------------ | ------------------------------------ | ------------------------------------ | +| /v1/redemptions | get | List Redemptions | supported | | +| /v1/redemptions | post | Redeem Stackable Discounts | supported | | +| /v1/redemptions/{redemptionId} | get | Get Redemption | supported | | +| /v1/vouchers/{code}/redemption | get | Get Voucher's Redemptions | supported | | +| /v1/vouchers/{code}/redemption | post | Redeem Voucher [Deprecated] | | deprecated | +| /v1/redemptions/{redemptionId}/rollback | post | Rollback Redemption | supported | | +| /v1/promotions/tiers/{promotionTierId}/redemption | post | Redeem Promotion [Deprecated] | | deprecated | +| /v1/redemptions/{parentRedemptionId}/rollbacks | post | Rollback Stackable Redemptions | supported | | ## Vouchers -### /v1/vouchers -#### List Vouchers (get) - **Not supported ❌** -#### Generate Random Code (post) - **Not supported ❌** -### /v1/vouchers/{code} -#### Get Voucher (get) - **Supported ✅** -#### Update Voucher (put) - **Not supported ❌** -#### Delete Voucher (delete) - **Supported ✅** -#### Create Voucher (post) - **Not supported ❌** -### /v1/vouchers/{code}/enable -#### Enable Voucher (post) - **Supported ✅** -### /v1/vouchers/{code}/disable -#### Disable Voucher (post) - **Supported ✅** -### /v1/vouchers/{code}/balance -#### Add or Remove Voucher Balance (post) - **Supported ✅** -### /v1/vouchers/{code}/transactions -#### List Voucher Transactions (get) - **Supported ✅** -### /v1/vouchers/{code}/transactions/export -#### Export Voucher Transactions (post) - **Supported ✅** -### /v1/vouchers/import -#### Import Vouchers (post) - **Not supported ❌** -### /v1/vouchers/importCSV -#### Import Vouchers using CSV (post) - **Supported ✅** -### /v1/vouchers/bulk/async -#### Update Vouchers in bulk (post) - **Not supported ❌** -### /v1/vouchers/metadata/async -#### Update Vouchers' metadata in bulk (post) - **Not supported ❌** -### /v1/vouchers/{code}/sessions/{sessionKey} -#### Release Validation Session (delete) - **Supported ✅** -### ~~❗/v1/vouchers/qualification [Deprecated]❗~~ -#### ~~❗Examine Qualification [Deprecated] (post)❗~~ +| endpoint | method | summary | is supported | is deprecated | +| ----------------------------------------- | ------ | ---------------------------------- | ------------------------------------ | ------------------------------------ | +| /v1/vouchers | get | List Vouchers | | | +| /v1/vouchers | post | Generate Random Code | | | +| /v1/vouchers/{code} | get | Get Voucher | supported | | +| /v1/vouchers/{code} | put | Update Voucher | | | +| /v1/vouchers/{code} | delete | Delete Voucher | supported | | +| /v1/vouchers/{code} | post | Create Voucher | | | +| /v1/vouchers/{code}/enable | post | Enable Voucher | supported | | +| /v1/vouchers/{code}/disable | post | Disable Voucher | supported | | +| /v1/vouchers/{code}/balance | post | Add or Remove Voucher Balance | supported | | +| /v1/vouchers/{code}/transactions | get | List Voucher Transactions | supported | | +| /v1/vouchers/{code}/transactions/export | post | Export Voucher Transactions | supported | | +| /v1/vouchers/import | post | Import Vouchers | | | +| /v1/vouchers/importCSV | post | Import Vouchers using CSV | supported | | +| /v1/vouchers/bulk/async | post | Update Vouchers in bulk | | | +| /v1/vouchers/metadata/async | post | Update Vouchers' metadata in bulk | | | +| /v1/vouchers/{code}/sessions/{sessionKey} | delete | Release Validation Session | supported | | +| /v1/vouchers/qualification | post | Examine Qualification [Deprecated] | | deprecated | ## Campaigns -### /v1/campaigns -#### Create Campaign (post) - **Supported ✅** -#### List Campaigns (get) - **Supported ✅** -### /v1/campaigns/{campaignId} -#### Get Campaign (get) - **Supported ✅** -#### Update Campaign (put) - **Supported ✅** -#### Delete Campaign (delete) - **Supported ✅** -### /v1/campaigns/{campaignId}/vouchers -#### Add Vouchers to Campaign (post) - **Supported ✅** -### /v1/campaigns/{campaignId}/vouchers/{code} -#### Add Voucher with Specific Code to Campaign (post) - **Supported ✅** -### /v1/campaigns/{campaignId}/import -#### Import Vouchers to Campaign (post) - **Supported ✅** -### /v1/campaigns/{campaignId}/importCSV -#### Import Vouchers to Campaign by CSV (post) - **Supported ✅** -### ~~❗/v1/campaigns/qualification [Deprecated]❗~~ -#### ~~❗Examine Qualification [Deprecated] (post)❗~~ -### /v1/campaigns/{campaignId}/enable -#### Enable Campaign (post) - **Supported ✅** -### /v1/campaigns/{campaignId}/disable -#### Disable Campaign (post) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| ------------------------------------------ | ------ | ------------------------------------------ | ------------------------------------ | ------------------------------------ | +| /v1/campaigns | post | Create Campaign | supported | | +| /v1/campaigns | get | List Campaigns | supported | | +| /v1/campaigns/{campaignId} | get | Get Campaign | supported | | +| /v1/campaigns/{campaignId} | put | Update Campaign | supported | | +| /v1/campaigns/{campaignId} | delete | Delete Campaign | supported | | +| /v1/campaigns/{campaignId}/vouchers | post | Add Vouchers to Campaign | supported | | +| /v1/campaigns/{campaignId}/vouchers/{code} | post | Add Voucher with Specific Code to Campaign | supported | | +| /v1/campaigns/{campaignId}/import | post | Import Vouchers to Campaign | supported | | +| /v1/campaigns/{campaignId}/importCSV | post | Import Vouchers to Campaign by CSV | supported | | +| /v1/campaigns/qualification | post | Examine Qualification [Deprecated] | | deprecated | +| /v1/campaigns/{campaignId}/enable | post | Enable Campaign | supported | | +| /v1/campaigns/{campaignId}/disable | post | Disable Campaign | supported | | ## Promotions -### /v1/promotions/tiers -#### List Promotion Tiers (get) - **Not supported ❌** -### /v1/promotions/{campaignId}/tiers -#### List Promotion Tiers from Campaign (get) - **Supported ✅** -#### Add Promotion Tier to Campaign (post) - **Not supported ❌** -### /v1/promotions/tiers/{promotionTierId} -#### Get Promotion Tier (get) - **Supported ✅** -#### Update Promotion Tier (put) - **Not supported ❌** -#### Delete Promotion Tier (delete) - **Supported ✅** -### /v1/promotions/tiers/{promotionTierId}/enable -#### Enable Promotion Tier (post) - **Supported ✅** -### /v1/promotions/tiers/{promotionTierId}/disable -#### Disable Promotion Tier (post) - **Supported ✅** -### /v1/promotions/stacks -#### List Promotion Stacks (get) - **Supported ✅** -### /v1/promotions/{campaignId}/stacks -#### List Promotion Stacks in Campaign (get) - **Supported ✅** -#### Create Promotion Stack (post) - **Supported ✅** -### /v1/promotions/{campaignId}/stacks/{stackId} -#### Get Promotion Stack (get) - **Supported ✅** -#### Update Promotion Stack (put) - **Supported ✅** -#### Delete Promotion Stack (delete) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| ---------------------------------------------- | ------ | ---------------------------------- | ------------------------------------ | ------------- | +| /v1/promotions/tiers | get | List Promotion Tiers | | | +| /v1/promotions/{campaignId}/tiers | get | List Promotion Tiers from Campaign | supported | | +| /v1/promotions/{campaignId}/tiers | post | Add Promotion Tier to Campaign | | | +| /v1/promotions/tiers/{promotionTierId} | get | Get Promotion Tier | supported | | +| /v1/promotions/tiers/{promotionTierId} | put | Update Promotion Tier | | | +| /v1/promotions/tiers/{promotionTierId} | delete | Delete Promotion Tier | supported | | +| /v1/promotions/tiers/{promotionTierId}/enable | post | Enable Promotion Tier | supported | | +| /v1/promotions/tiers/{promotionTierId}/disable | post | Disable Promotion Tier | supported | | +| /v1/promotions/stacks | get | List Promotion Stacks | supported | | +| /v1/promotions/{campaignId}/stacks | get | List Promotion Stacks in Campaign | supported | | +| /v1/promotions/{campaignId}/stacks | post | Create Promotion Stack | supported | | +| /v1/promotions/{campaignId}/stacks/{stackId} | get | Get Promotion Stack | supported | | +| /v1/promotions/{campaignId}/stacks/{stackId} | put | Update Promotion Stack | supported | | +| /v1/promotions/{campaignId}/stacks/{stackId} | delete | Delete Promotion Stack | supported | | ## Rewards -### /v1/rewards -#### List Rewards (get) - **Not supported ❌** -#### Create Reward (post) - **Not supported ❌** -### /v1/rewards/{rewardId} -#### Get Reward (get) - **Not supported ❌** -#### Update Reward (put) - **Not supported ❌** -#### Delete Reward (delete) - **Supported ✅** -### /v1/rewards/{rewardId}/assignments -#### List Reward Assignments (get) - **Supported ✅** -#### Create Reward Assignment (post) - **Supported ✅** -### /v1/rewards/{rewardId}/assignments/{assignmentId} -#### Update Reward Assignment (put) - **Supported ✅** -#### Delete Reward Assignment (delete) - **Supported ✅** -#### Get Reward Assignment (get) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| ------------------------------------------------- | ------ | ------------------------ | ------------------------------------ | ------------- | +| /v1/rewards | get | List Rewards | | | +| /v1/rewards | post | Create Reward | | | +| /v1/rewards/{rewardId} | get | Get Reward | | | +| /v1/rewards/{rewardId} | put | Update Reward | | | +| /v1/rewards/{rewardId} | delete | Delete Reward | supported | | +| /v1/rewards/{rewardId}/assignments | get | List Reward Assignments | supported | | +| /v1/rewards/{rewardId}/assignments | post | Create Reward Assignment | supported | | +| /v1/rewards/{rewardId}/assignments/{assignmentId} | put | Update Reward Assignment | supported | | +| /v1/rewards/{rewardId}/assignments/{assignmentId} | delete | Delete Reward Assignment | supported | | +| /v1/rewards/{rewardId}/assignments/{assignmentId} | get | Get Reward Assignment | supported | | ## Loyalties -### /v1/loyalties -#### List Loyalty Campaigns (get) - **Not supported ❌** -#### Create Loyalty Campaign (post) - **Not supported ❌** -### /v1/loyalties/{campaignId} -#### Get Loyalty Campaign (get) - **Not supported ❌** -#### Update Loyalty Campaign (put) - **Not supported ❌** -#### Delete Loyalty Campaign (delete) - **Supported ✅** -### /v1/loyalties/{campaignId}/members -#### List Members (get) - **Not supported ❌** -#### Add Member (post) - **Not supported ❌** -### /v1/loyalties/{campaignId}/members/{memberId} -#### Get Member (get) - **Not supported ❌** -### /v1/loyalties/members/{memberId} -#### Get Member (get) - **Not supported ❌** -### /v1/loyalties/{campaignId}/members/{memberId}/activity -#### List Member Activity (get) - **Not supported ❌** -### /v1/loyalties/members/{memberId}/activity -#### List Member Activity (get) - **Not supported ❌** -### /v1/loyalties/{campaignId}/members/{memberId}/balance -#### Add or Remove Loyalty Card Balance (post) - **Supported ✅** -### /v1/loyalties/members/{memberId}/balance -#### Add or Remove Loyalty Card Balance (post) - **Supported ✅** -### /v1/loyalties/{campaignId}/members/{memberId}/transfers -#### Transfer Loyalty Points (post) - **Supported ✅** -### /v1/loyalties/{campaignId}/members/{memberId}/transactions -#### List Loyalty Card Transactions (get) - **Supported ✅** -### /v1/loyalties/members/{memberId}/transactions -#### List Loyalty Card Transactions (get) - **Supported ✅** -### /v1/loyalties/members/{memberId}/transactions/export -#### Export Loyalty Card Transactions (post) - **Supported ✅** -### /v1/loyalties/{campaignId}/members/{memberId}/transactions/export -#### Export Loyalty Card Transactions (post) - **Supported ✅** -### /v1/loyalties/{campaignId}/members/{memberId}/points-expiration -#### Get Points Expiration (get) - **Supported ✅** -### /v1/loyalties/{campaignId}/points-expiration/export -#### Create Points Expiration Export (post) - **Not supported ❌** -### /v1/loyalties/{campaignId}/earning-rules -#### List Earning Rules (get) - **Not supported ❌** -#### Create Earning Rule (post) - **Not supported ❌** -### /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} -#### Get Earning Rule (get) - **Supported ✅** -#### Update Earning Rule (put) - **Not supported ❌** -#### Delete Earning Rule (delete) - **Supported ✅** -### /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable -#### Enable Earning Rule (post) - **Supported ✅** -### /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable -#### Disable Earning Rule (post) - **Supported ✅** -### /v1/loyalties/members/{memberId}/rewards -#### List Member Rewards (get) - **Supported ✅** -### /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward -#### Get Reward Details (get) - **Supported ✅** -### /v1/loyalties/{campaignId}/reward-assignments -#### List Reward Assignments (get) - **Not supported ❌** -### /v1/loyalties/{campaignId}/rewards -#### List Reward Assignments (get) - **Not supported ❌** -#### Create Reward Assignment (post) - **Not supported ❌** -### /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} -#### Get Reward Assignment (get) - **Supported ✅** -### /v1/loyalties/{campaignId}/rewards/{assignmentId} -#### Get Reward Assignment (get) - **Supported ✅** -#### Update Reward Assignment (put) - **Not supported ❌** -#### Delete Reward Assignment (delete) - **Supported ✅** -### /v1/loyalties/{campaignId}/members/{memberId}/redemption -#### Redeem Reward (post) - **Supported ✅** -### /v1/loyalties/members/{memberId}/redemption -#### Redeem Reward (post) - **Supported ✅** -### /v1/loyalties/{campaignId}/tiers -#### List Loyalty Tiers (get) - **Supported ✅** -#### Create loyalty tiers (post) - **Supported ✅** -### /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} -#### Get Loyalty Tier (get) - **Supported ✅** -### /v1/loyalties/members/{memberId}/tiers -#### List Member's Loyalty Tiers (get) - **Supported ✅** -### /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules -#### List Loyalty Tier Earning Rules (get) - **Supported ✅** -### /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards -#### List Loyalty Tier Rewards (get) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| ------------------------------------------------------------------- | ------ | ---------------------------------- | ------------------------------------ | ------------- | +| /v1/loyalties | get | List Loyalty Campaigns | | | +| /v1/loyalties | post | Create Loyalty Campaign | | | +| /v1/loyalties/{campaignId} | get | Get Loyalty Campaign | | | +| /v1/loyalties/{campaignId} | put | Update Loyalty Campaign | | | +| /v1/loyalties/{campaignId} | delete | Delete Loyalty Campaign | supported | | +| /v1/loyalties/{campaignId}/members | get | List Members | | | +| /v1/loyalties/{campaignId}/members | post | Add Member | | | +| /v1/loyalties/{campaignId}/members/{memberId} | get | Get Member | | | +| /v1/loyalties/members/{memberId} | get | Get Member | | | +| /v1/loyalties/{campaignId}/members/{memberId}/activity | get | List Member Activity | | | +| /v1/loyalties/members/{memberId}/activity | get | List Member Activity | | | +| /v1/loyalties/{campaignId}/members/{memberId}/balance | post | Add or Remove Loyalty Card Balance | supported | | +| /v1/loyalties/members/{memberId}/balance | post | Add or Remove Loyalty Card Balance | supported | | +| /v1/loyalties/{campaignId}/members/{memberId}/transfers | post | Transfer Loyalty Points | supported | | +| /v1/loyalties/{campaignId}/members/{memberId}/transactions | get | List Loyalty Card Transactions | supported | | +| /v1/loyalties/members/{memberId}/transactions | get | List Loyalty Card Transactions | supported | | +| /v1/loyalties/members/{memberId}/transactions/export | post | Export Loyalty Card Transactions | supported | | +| /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | post | Export Loyalty Card Transactions | supported | | +| /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | get | Get Points Expiration | supported | | +| /v1/loyalties/{campaignId}/points-expiration/export | post | Create Points Expiration Export | | | +| /v1/loyalties/{campaignId}/earning-rules | get | List Earning Rules | | | +| /v1/loyalties/{campaignId}/earning-rules | post | Create Earning Rule | | | +| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | get | Get Earning Rule | supported | | +| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | put | Update Earning Rule | | | +| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | delete | Delete Earning Rule | supported | | +| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable | post | Enable Earning Rule | supported | | +| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable | post | Disable Earning Rule | supported | | +| /v1/loyalties/members/{memberId}/rewards | get | List Member Rewards | supported | | +| /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | get | Get Reward Details | supported | | +| /v1/loyalties/{campaignId}/reward-assignments | get | List Reward Assignments | | | +| /v1/loyalties/{campaignId}/rewards | get | List Reward Assignments | | | +| /v1/loyalties/{campaignId}/rewards | post | Create Reward Assignment | | | +| /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | get | Get Reward Assignment | supported | | +| /v1/loyalties/{campaignId}/rewards/{assignmentId} | get | Get Reward Assignment | supported | | +| /v1/loyalties/{campaignId}/rewards/{assignmentId} | put | Update Reward Assignment | | | +| /v1/loyalties/{campaignId}/rewards/{assignmentId} | delete | Delete Reward Assignment | supported | | +| /v1/loyalties/{campaignId}/members/{memberId}/redemption | post | Redeem Reward | supported | | +| /v1/loyalties/members/{memberId}/redemption | post | Redeem Reward | supported | | +| /v1/loyalties/{campaignId}/tiers | get | List Loyalty Tiers | supported | | +| /v1/loyalties/{campaignId}/tiers | post | Create loyalty tiers | supported | | +| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | get | Get Loyalty Tier | supported | | +| /v1/loyalties/members/{memberId}/tiers | get | List Member's Loyalty Tiers | supported | | +| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules | get | List Loyalty Tier Earning Rules | supported | | +| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards | get | List Loyalty Tier Rewards | supported | | ## Customers -### /v1/customers -#### List Customers (get) - **Supported ✅** -#### Create Customer (post) - **Supported ✅** -### /v1/customers/{customerId} -#### Get Customer (get) - **Supported ✅** -#### Delete Customer (delete) - **Supported ✅** -#### Update Customer (put) - **Supported ✅** -### /v1/customers/{customerId}/permanent-deletion -#### Delete Customer Permanently (post) - **Supported ✅** -### /v1/customers/importCSV -#### Import and Update Customers using CSV (post) - **Supported ✅** -### /v1/customers/bulk/async -#### Update Customers in bulk (post) - **Supported ✅** -### /v1/customers/metadata/async -#### Update Customers' Metadata in bulk (post) - **Supported ✅** -### /v1/customers/{customerId}/consents -#### Update Customer's consents (put) - **Supported ✅** -### /v1/customers/{customerId}/activity -#### List Customer Activity (get) - **Not supported ❌** -### /v1/customers/{customerId}/activities -#### List Customer Activities (get) - **Supported ✅** -### /v1/customers/{customerId}/segments -#### List Customer's Segments (get) - **Supported ✅** -### /v1/customers/{customerId}/redeemables -#### List Customer's Redeemables [Beta] (get) - **Not supported ❌** +| endpoint | method | summary | is supported | is deprecated | +| --------------------------------------------- | ------ | ------------------------------------- | ------------------------------------ | ------------- | +| /v1/customers | get | List Customers | supported | | +| /v1/customers | post | Create Customer | supported | | +| /v1/customers/{customerId} | get | Get Customer | supported | | +| /v1/customers/{customerId} | delete | Delete Customer | supported | | +| /v1/customers/{customerId} | put | Update Customer | supported | | +| /v1/customers/{customerId}/permanent-deletion | post | Delete Customer Permanently | supported | | +| /v1/customers/importCSV | post | Import and Update Customers using CSV | supported | | +| /v1/customers/bulk/async | post | Update Customers in bulk | supported | | +| /v1/customers/metadata/async | post | Update Customers' Metadata in bulk | supported | | +| /v1/customers/{customerId}/consents | put | Update Customer's consents | supported | | +| /v1/customers/{customerId}/activity | get | List Customer Activity | | | +| /v1/customers/{customerId}/activities | get | List Customer Activities | supported | | +| /v1/customers/{customerId}/segments | get | List Customer's Segments | supported | | +| /v1/customers/{customerId}/redeemables | get | List Customer's Redeemables [Beta] | | | ## Orders -### /v1/orders -#### List Orders (get) - **Supported ✅** -#### Create Order (post) - **Supported ✅** -### /v1/orders/{orderId} -#### Get Order (get) - **Supported ✅** -#### Update Order (put) - **Supported ✅** -### /v1/orders/import -#### Import Orders (post) - **Supported ✅** -### /v1/orders/export -#### Create Orders Export (post) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| -------------------- | ------ | -------------------- | ------------------------------------ | ------------- | +| /v1/orders | get | List Orders | supported | | +| /v1/orders | post | Create Order | supported | | +| /v1/orders/{orderId} | get | Get Order | supported | | +| /v1/orders/{orderId} | put | Update Order | supported | | +| /v1/orders/import | post | Import Orders | supported | | +| /v1/orders/export | post | Create Orders Export | supported | | ## Products -### /v1/products -#### List Products (get) - **Supported ✅** -#### Create Product (post) - **Supported ✅** -### /v1/products/{productId} -#### Get Product (get) - **Supported ✅** -#### Update Product (put) - **Supported ✅** -#### Delete Product (delete) - **Supported ✅** -### /v1/products/bulk/async -#### Update Products in bulk (post) - **Supported ✅** -### /v1/products/metadata/async -#### Update Products' Metadata in bulk (post) - **Supported ✅** -### /v1/skus/{skuId} -#### Get SKU (get) - **Supported ✅** -### /v1/products/{productId}/skus -#### List SKUs in Product (get) - **Supported ✅** -#### Create SKU (post) - **Supported ✅** -### /v1/products/{productId}/skus/{skuId} -#### Update SKU (put) - **Supported ✅** -#### Delete SKU (delete) - **Supported ✅** -### /v1/products/importCSV -#### Import Products using CSV (post) - **Supported ✅** -### /v1/skus/importCSV -#### Import SKUs using CSV (post) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| ------------------------------------- | ------ | --------------------------------- | ------------------------------------ | ------------- | +| /v1/products | get | List Products | supported | | +| /v1/products | post | Create Product | supported | | +| /v1/products/{productId} | get | Get Product | supported | | +| /v1/products/{productId} | put | Update Product | supported | | +| /v1/products/{productId} | delete | Delete Product | supported | | +| /v1/products/bulk/async | post | Update Products in bulk | supported | | +| /v1/products/metadata/async | post | Update Products' Metadata in bulk | supported | | +| /v1/skus/{skuId} | get | Get SKU | supported | | +| /v1/products/{productId}/skus | get | List SKUs in Product | supported | | +| /v1/products/{productId}/skus | post | Create SKU | supported | | +| /v1/products/{productId}/skus/{skuId} | put | Update SKU | supported | | +| /v1/products/{productId}/skus/{skuId} | delete | Delete SKU | supported | | +| /v1/products/importCSV | post | Import Products using CSV | supported | | +| /v1/skus/importCSV | post | Import SKUs using CSV | supported | | ## Product Collections -### /v1/product-collections -#### List Product Collections (get) - **Supported ✅** -#### Create Product Collection (post) - **Supported ✅** -### /v1/product-collections/{productCollectionId} -#### Get Product Collection (get) - **Supported ✅** -#### Delete Product Collection (delete) - **Supported ✅** -### /v1/product-collections/{productCollectionId}/products -#### List Products in Collection (get) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| ------------------------------------------------------ | ------ | --------------------------- | ------------------------------------ | ------------- | +| /v1/product-collections | get | List Product Collections | supported | | +| /v1/product-collections | post | Create Product Collection | supported | | +| /v1/product-collections/{productCollectionId} | get | Get Product Collection | supported | | +| /v1/product-collections/{productCollectionId} | delete | Delete Product Collection | supported | | +| /v1/product-collections/{productCollectionId}/products | get | List Products in Collection | supported | | ## Validation Rules -### /v1/validation-rules -#### List Validation Rules (get) - **Supported ✅** -#### Create Validation Rules (post) - **Supported ✅** -### /v1/validation-rules/{validationRuleId} -#### Get Validation Rule (get) - **Supported ✅** -#### Update Validation Rule (put) - **Supported ✅** -#### Delete Validation Rule (delete) - **Supported ✅** -### /v1/validation-rules-assignments -#### List Validation Rules' Assignment(s) (get) - **Supported ✅** -### /v1/validation-rules/{validationRuleId}/assignments -#### List Validation Rule Assignments (get) - **Supported ✅** -#### Create Validation Rules Assignments (post) - **Supported ✅** -### /v1/validation-rules/{validationRuleId}/assignments/{assignmentId} -#### Delete Validation Rule Assignment (delete) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| ------------------------------------------------------------------ | ------ | ------------------------------------ | ------------------------------------ | ------------- | +| /v1/validation-rules | get | List Validation Rules | supported | | +| /v1/validation-rules | post | Create Validation Rules | supported | | +| /v1/validation-rules/{validationRuleId} | get | Get Validation Rule | supported | | +| /v1/validation-rules/{validationRuleId} | put | Update Validation Rule | supported | | +| /v1/validation-rules/{validationRuleId} | delete | Delete Validation Rule | supported | | +| /v1/validation-rules-assignments | get | List Validation Rules' Assignment(s) | supported | | +| /v1/validation-rules/{validationRuleId}/assignments | get | List Validation Rule Assignments | supported | | +| /v1/validation-rules/{validationRuleId}/assignments | post | Create Validation Rules Assignments | supported | | +| /v1/validation-rules/{validationRuleId}/assignments/{assignmentId} | delete | Delete Validation Rule Assignment | supported | | ## Segments -### /v1/segments/{segmentId} -#### Get Segment (get) - **Not supported ❌** -#### Delete Segment (delete) - **Supported ✅** -### /v1/segments -#### Create Segment (post) - **Not supported ❌** +| endpoint | method | summary | is supported | is deprecated | +| ------------------------ | ------ | -------------- | ------------------------------------ | ------------- | +| /v1/segments/{segmentId} | get | Get Segment | | | +| /v1/segments/{segmentId} | delete | Delete Segment | supported | | +| /v1/segments | post | Create Segment | | | ## Events -### /v1/events -#### Track Custom Event (post) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| ---------- | ------ | ------------------ | ------------------------------------ | ------------- | +| /v1/events | post | Track Custom Event | supported | | ## Consents -### /v1/consents -#### List Consents (get) - **Not supported ❌** +| endpoint | method | summary | is supported | is deprecated | +| ------------ | ------ | ------------- | ------------ | ------------- | +| /v1/consents | get | List Consents | | | ## Async Actions -### /v1/async-actions -#### List Async Actions (get) - **Not supported ❌** -### /v1/async-actions/{asyncActionId} -#### Get Async Action (get) - **Not supported ❌** +| endpoint | method | summary | is supported | is deprecated | +| --------------------------------- | ------ | ------------------ | ------------ | ------------- | +| /v1/async-actions | get | List Async Actions | | | +| /v1/async-actions/{asyncActionId} | get | Get Async Action | | | ## Exports -### /v1/exports -#### Create Export (post) - **Supported ✅** -#### List Exports (get) - **Supported ✅** -### /v1/exports/{exportId} -#### Get Export (get) - **Supported ✅** -#### Delete Export (delete) - **Supported ✅** -### /v1/exports/{export_Id} -#### Download Export (get) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| ----------------------- | ------ | --------------- | ------------------------------------ | ------------- | +| /v1/exports | post | Create Export | supported | | +| /v1/exports | get | List Exports | supported | | +| /v1/exports/{exportId} | get | Get Export | supported | | +| /v1/exports/{exportId} | delete | Delete Export | supported | | +| /v1/exports/{export_Id} | get | Download Export | supported | | ## Categories -### /v1/categories -#### List Categories (get) - **Supported ✅** -#### Create Category (post) - **Supported ✅** -### /v1/categories/{categoryId} -#### Get Category (get) - **Supported ✅** -#### Delete Category (delete) - **Supported ✅** -#### Update Category (put) - **Supported ✅** +| endpoint | method | summary | is supported | is deprecated | +| --------------------------- | ------ | --------------- | ------------------------------------ | ------------- | +| /v1/categories | get | List Categories | supported | | +| /v1/categories | post | Create Category | supported | | +| /v1/categories/{categoryId} | get | Get Category | supported | | +| /v1/categories/{categoryId} | delete | Delete Category | supported | | +| /v1/categories/{categoryId} | put | Update Category | supported | | ## Metadata Schemas -### /v1/metadata-schemas -#### List Metadata Schemas (get) - **Not supported ❌** -### /v1/metadata-schemas/{resource} -#### Get Metadata Schema (get) - **Not supported ❌** +| endpoint | method | summary | is supported | is deprecated | +| ------------------------------- | ------ | --------------------- | ------------ | ------------- | +| /v1/metadata-schemas | get | List Metadata Schemas | | | +| /v1/metadata-schemas/{resource} | get | Get Metadata Schema | | | ## Locations -### /v1/locations -#### List Locations (get) - **Not supported ❌** -### /v1/locations/{locationId} -#### Get Location (get) - **Not supported ❌** +| endpoint | method | summary | is supported | is deprecated | +| -------------------------- | ------ | -------------- | ------------ | ------------- | +| /v1/locations | get | List Locations | | | +| /v1/locations/{locationId} | get | Get Location | | | ## Referrals -### /v1/referrals/{campaignId}/members/{memberId}/holders -#### List Referral Code Holders [Beta] (get) - **Not supported ❌** -### /v1/referrals/members/{memberId}/holders -#### List Referral Code Holders [Beta] (get) - **Not supported ❌** +| endpoint | method | summary | is supported | is deprecated | +| ----------------------------------------------------- | ------ | --------------------------------- | ------------ | ------------- | +| /v1/referrals/{campaignId}/members/{memberId}/holders | get | List Referral Code Holders [Beta] | | | +| /v1/referrals/members/{memberId}/holders | get | List Referral Code Holders [Beta] | | | ## Bin -### /v1/trash-bin -#### List Bin Entries (get) - **Not supported ❌** -### /v1/trash-bin/{binEntryId} -#### Delete Bin Entry (delete) - **Not supported ❌** +| endpoint | method | summary | is supported | is deprecated | +| -------------------------- | ------ | ---------------- | ------------ | ------------- | +| /v1/trash-bin | get | List Bin Entries | | | +| /v1/trash-bin/{binEntryId} | delete | Delete Bin Entry | | | ## Management -### /management/v1/projects -#### Create Project (post) - **Not supported ❌** -#### List Projects (get) - **Not supported ❌** -### /management/v1/projects/{projectId} -#### Get Project (get) - **Not supported ❌** -#### Update Project (put) - **Not supported ❌** -#### Delete Project (delete) - **Not supported ❌** -### /management/v1/projects/{projectId}/users -#### Assign User (post) - **Not supported ❌** -#### List Users (get) - **Not supported ❌** -### /management/v1/projects/{projectId}/users/{userId} -#### Get User (get) - **Not supported ❌** -#### Update User (put) - **Not supported ❌** -#### Unassign User (delete) - **Not supported ❌** -### /management/v1/projects/{projectId}/stacking-rules -#### Create Stacking Rules (post) - **Not supported ❌** -#### List Stacking Rules (get) - **Not supported ❌** -### /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} -#### Get Stacking Rules (get) - **Not supported ❌** -#### Update Stacking Rules (put) - **Not supported ❌** -#### Delete Stacking Rules (delete) - **Not supported ❌** -### /management/v1/projects/{projectId}/metadata-schemas -#### Create Metadata Schema (post) - **Not supported ❌** -#### List Metadata Schemas (get) - **Not supported ❌** -### /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} -#### Get Metadata Schema (get) - **Not supported ❌** -#### Update Metadata Schema (put) - **Not supported ❌** -#### Delete Metadata Schema (delete) - **Not supported ❌** -### /management/v1/projects/{projectId}/custom-event-schemas -#### Create Custom Event Schema (post) - **Not supported ❌** -#### List Custom Event Schemas (get) - **Not supported ❌** -### /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} -#### Get Custom Event Schema (get) - **Not supported ❌** -#### Update Custom Event Schema (put) - **Not supported ❌** -#### Delete Custom Event Schema (delete) - **Not supported ❌** -### /management/v1/projects/{projectId}/webhooks -#### Create Webhook (post) - **Not supported ❌** -#### List Webhooks (get) - **Not supported ❌** -### /management/v1/projects/{projectId}/webhooks/{webhookId} -#### Get Webhook (get) - **Not supported ❌** -#### Update Webhook (put) - **Not supported ❌** -#### Delete Webhook (delete) - **Not supported ❌** -### /management/v1/projects/{projectId}/branding -#### Create Brand (post) - **Not supported ❌** -#### List Brands (get) - **Not supported ❌** -### /management/v1/projects/{projectId}/branding/{brandingId} -#### Get Brand (get) - **Not supported ❌** -#### Update Brand (put) - **Not supported ❌** -#### Delete Brand (delete) - **Not supported ❌** +| endpoint | method | summary | is supported | is deprecated | +| ------------------------------------------------------------------------------ | ------ | -------------------------- | ------------ | ------------- | +| /management/v1/projects | post | Create Project | | | +| /management/v1/projects | get | List Projects | | | +| /management/v1/projects/{projectId} | get | Get Project | | | +| /management/v1/projects/{projectId} | put | Update Project | | | +| /management/v1/projects/{projectId} | delete | Delete Project | | | +| /management/v1/projects/{projectId}/users | post | Assign User | | | +| /management/v1/projects/{projectId}/users | get | List Users | | | +| /management/v1/projects/{projectId}/users/{userId} | get | Get User | | | +| /management/v1/projects/{projectId}/users/{userId} | put | Update User | | | +| /management/v1/projects/{projectId}/users/{userId} | delete | Unassign User | | | +| /management/v1/projects/{projectId}/stacking-rules | post | Create Stacking Rules | | | +| /management/v1/projects/{projectId}/stacking-rules | get | List Stacking Rules | | | +| /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | get | Get Stacking Rules | | | +| /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | put | Update Stacking Rules | | | +| /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | delete | Delete Stacking Rules | | | +| /management/v1/projects/{projectId}/metadata-schemas | post | Create Metadata Schema | | | +| /management/v1/projects/{projectId}/metadata-schemas | get | List Metadata Schemas | | | +| /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | get | Get Metadata Schema | | | +| /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | put | Update Metadata Schema | | | +| /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | delete | Delete Metadata Schema | | | +| /management/v1/projects/{projectId}/custom-event-schemas | post | Create Custom Event Schema | | | +| /management/v1/projects/{projectId}/custom-event-schemas | get | List Custom Event Schemas | | | +| /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | get | Get Custom Event Schema | | | +| /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | put | Update Custom Event Schema | | | +| /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | delete | Delete Custom Event Schema | | | +| /management/v1/projects/{projectId}/webhooks | post | Create Webhook | | | +| /management/v1/projects/{projectId}/webhooks | get | List Webhooks | | | +| /management/v1/projects/{projectId}/webhooks/{webhookId} | get | Get Webhook | | | +| /management/v1/projects/{projectId}/webhooks/{webhookId} | put | Update Webhook | | | +| /management/v1/projects/{projectId}/webhooks/{webhookId} | delete | Delete Webhook | | | +| /management/v1/projects/{projectId}/branding | post | Create Brand | | | +| /management/v1/projects/{projectId}/branding | get | List Brands | | | +| /management/v1/projects/{projectId}/branding/{brandingId} | get | Get Brand | | | +| /management/v1/projects/{projectId}/branding/{brandingId} | put | Update Brand | | | +| /management/v1/projects/{projectId}/branding/{brandingId} | delete | Delete Brand | | | ## Client-side -### /client/v1/qualifications -#### Check Eligibility (client-side) (post) - **Supported ✅** -### /client/v1/promotions/tiers -#### List Promotion Tiers (client-side) (get) - **Not supported ❌** -### /client/v1/redemptions -#### Redeem Stackable Discounts (client-side) (post) - **Supported ✅** -### /client/v1/validations -#### Validate Stackable Discounts (client-side) (post) - **Supported ✅** -### /client/v1/customers/{customerId}/consents -#### Update Customer's consents (client-side) (put) - **Supported ✅** -### /client/v1/events -#### Track Custom Event (client-side) (post) - **Supported ✅** -### /client/v1/consents -#### List Consents (client-side) (get) - **Not supported ❌** -### ~~❗/client/v1/validate [Deprecated]❗~~ -#### ~~❗Validate Voucher (client-side) [Deprecated] (get)❗~~ -### ~~❗/client/v1/redeem [Deprecated]❗~~ -#### ~~❗Redeem Voucher (client-side) [Deprecated] (post)❗~~ -### /client/v1/publish -#### Create Publication (client-side) (post) - **Not supported ❌** \ No newline at end of file +| endpoint | method | summary | is supported | is deprecated | +| ------------------------------------------ | ------ | ------------------------------------------- | ------------------------------------ | ------------------------------------ | +| /client/v1/qualifications | post | Check Eligibility (client-side) | supported | | +| /client/v1/promotions/tiers | get | List Promotion Tiers (client-side) | | | +| /client/v1/redemptions | post | Redeem Stackable Discounts (client-side) | supported | | +| /client/v1/validations | post | Validate Stackable Discounts (client-side) | supported | | +| /client/v1/customers/{customerId}/consents | put | Update Customer's consents (client-side) | supported | | +| /client/v1/events | post | Track Custom Event (client-side) | supported | | +| /client/v1/consents | get | List Consents (client-side) | | | +| /client/v1/validate | get | Validate Voucher (client-side) [Deprecated] | | deprecated | +| /client/v1/redeem | post | Redeem Voucher (client-side) [Deprecated] | | deprecated | +| /client/v1/publish | post | Create Publication (client-side) | | | \ No newline at end of file diff --git a/README.md b/README.md index 577dde1a..4ae38cea 100644 --- a/README.md +++ b/README.md @@ -287,9 +287,11 @@ Class | Method | HTTP request | Description ## 📚 Documentation for Models + - [VoucherifySdk::AccessSettingsCampaignAssignmentsList](docs/AccessSettingsCampaignAssignmentsList.md) - [VoucherifySdk::ApplicableTo](docs/ApplicableTo.md) - [VoucherifySdk::ApplicableToEffect](docs/ApplicableToEffect.md) - [VoucherifySdk::ApplicableToResultList](docs/ApplicableToResultList.md) + - [VoucherifySdk::AreaStoreCampaignAssignment](docs/AreaStoreCampaignAssignment.md) - [VoucherifySdk::AsyncActions](docs/AsyncActions.md) - [VoucherifySdk::BusValRuleAssignment](docs/BusValRuleAssignment.md) - [VoucherifySdk::Campaign](docs/Campaign.md) diff --git a/docs/AccessSettingsCampaignAssignmentsList.md b/docs/AccessSettingsCampaignAssignmentsList.md new file mode 100644 index 00000000..32b7fa82 --- /dev/null +++ b/docs/AccessSettingsCampaignAssignmentsList.md @@ -0,0 +1,11 @@ +# VoucherifySdk::AccessSettingsCampaignAssignmentsList + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **object** | **String** | The type of the object represented by JSON. Default is `list`. This object stores information about campaign assignments to areas and stores | [optional][default to 'list'] | +| **data_ref** | **String** | Identifies the name of the attribute that contains the array of campaign assignments. | [optional][default to 'data'] | +| **data** | [**Array<AreaStoreCampaignAssignment>**](AreaStoreCampaignAssignment.md) | Contains an array of campaign assignments. | [optional] | +| **total** | **Integer** | Total number of areas and stores to which the campaign is assigned. | [optional] | + diff --git a/docs/AreaStoreCampaignAssignment.md b/docs/AreaStoreCampaignAssignment.md new file mode 100644 index 00000000..4aae6d1a --- /dev/null +++ b/docs/AreaStoreCampaignAssignment.md @@ -0,0 +1,12 @@ +# VoucherifySdk::AreaStoreCampaignAssignment + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **id** | **String** | Unique identifier of the campaign assignment. | [optional] | +| **area_id** | **String** | Unique identifier of the area to which the campaign is assigned. | [optional] | +| **area_store_id** | **String** | Unique identifier of the store to which the campaign is assigned. | [optional] | +| **created_at** | **Time** | Date and time when the assignment was made. The value is shown in the ISO 8601 format. | [optional] | +| **object** | **String** | The type of the object represented by JSON. This object stores information about the campaign assignment to areas or stores. | [optional][default to 'area_store_campaign_assignment'] | + diff --git a/docs/Campaign.md b/docs/Campaign.md index 20ad9b19..c10fd3c0 100644 --- a/docs/Campaign.md +++ b/docs/Campaign.md @@ -35,4 +35,5 @@ | **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) | | [optional] | | **promotion** | [**PromotionTiersList**](PromotionTiersList.md) | | [optional] | | **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) | | [optional] | +| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) | | [optional] | diff --git a/docs/CampaignsCreateResponseBody.md b/docs/CampaignsCreateResponseBody.md index 4df14a81..0adb3b1b 100644 --- a/docs/CampaignsCreateResponseBody.md +++ b/docs/CampaignsCreateResponseBody.md @@ -35,4 +35,5 @@ | **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) | | [optional] | | **promotion** | [**PromotionTiersList**](PromotionTiersList.md) | | [optional] | | **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) | | [optional] | +| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) | | [optional] | diff --git a/docs/CampaignsGetResponseBody.md b/docs/CampaignsGetResponseBody.md index 4558b150..4406b63a 100644 --- a/docs/CampaignsGetResponseBody.md +++ b/docs/CampaignsGetResponseBody.md @@ -35,4 +35,5 @@ | **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) | | [optional] | | **promotion** | [**PromotionTiersList**](PromotionTiersList.md) | | [optional] | | **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) | | [optional] | +| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) | | [optional] | diff --git a/docs/CampaignsUpdateResponseBody.md b/docs/CampaignsUpdateResponseBody.md index 28af13e4..71089a1a 100644 --- a/docs/CampaignsUpdateResponseBody.md +++ b/docs/CampaignsUpdateResponseBody.md @@ -35,4 +35,5 @@ | **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) | | [optional] | | **promotion** | [**PromotionTiersList**](PromotionTiersList.md) | | [optional] | | **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) | | [optional] | +| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) | | [optional] | diff --git a/lib/VoucherifySdk.rb b/lib/VoucherifySdk.rb index 6c60e653..70cd7158 100644 --- a/lib/VoucherifySdk.rb +++ b/lib/VoucherifySdk.rb @@ -17,9 +17,11 @@ require 'VoucherifySdk/configuration' # Models +require 'VoucherifySdk/models/access_settings_campaign_assignments_list' require 'VoucherifySdk/models/applicable_to' require 'VoucherifySdk/models/applicable_to_effect' require 'VoucherifySdk/models/applicable_to_result_list' +require 'VoucherifySdk/models/area_store_campaign_assignment' require 'VoucherifySdk/models/async_actions' require 'VoucherifySdk/models/bus_val_rule_assignment' require 'VoucherifySdk/models/campaign' diff --git a/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb b/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb new file mode 100644 index 00000000..0e9b36c9 --- /dev/null +++ b/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb @@ -0,0 +1,317 @@ +=begin +#Voucherify API + +#Voucherify promotion engine REST API. Please see https://docs.voucherify.io/docs for more details. + +The version of the OpenAPI document: v2018-08-01 +Contact: support@voucherify.io +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 7.0.1 + +=end + +require 'date' +require 'time' + +module VoucherifySdk + # Lists all assignments of the campaign to areas and stores if the Areas and Stores feature is enabled (Enterprise feature). + class AccessSettingsCampaignAssignmentsList + # The type of the object represented by JSON. Default is `list`. This object stores information about campaign assignments to areas and stores + attr_accessor :object + + # Identifies the name of the attribute that contains the array of campaign assignments. + attr_accessor :data_ref + + # Contains an array of campaign assignments. + attr_accessor :data + + # Total number of areas and stores to which the campaign is assigned. + attr_accessor :total + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'object' => :'object', + :'data_ref' => :'data_ref', + :'data' => :'data', + :'total' => :'total' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'object' => :'String', + :'data_ref' => :'String', + :'data' => :'Array', + :'total' => :'Integer' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + :'object', + :'data_ref', + :'data', + :'total' + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `VoucherifySdk::AccessSettingsCampaignAssignmentsList` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `VoucherifySdk::AccessSettingsCampaignAssignmentsList`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'object') + self.object = attributes[:'object'] + else + self.object = 'list' + end + + if attributes.key?(:'data_ref') + self.data_ref = attributes[:'data_ref'] + else + self.data_ref = 'data' + end + + if attributes.key?(:'data') + if (value = attributes[:'data']).is_a?(Array) + self.data = value + end + end + + if attributes.key?(:'total') + self.total = attributes[:'total'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' + invalid_properties = Array.new + if !@total.nil? && @total < 0 + invalid_properties.push('invalid value for "total", must be greater than or equal to 0.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + warn '[DEPRECATED] the `valid?` method is obsolete' + object_validator = EnumAttributeValidator.new('String', ["list"]) + return false unless object_validator.valid?(@object) + data_ref_validator = EnumAttributeValidator.new('String', ["data"]) + return false unless data_ref_validator.valid?(@data_ref) + return false if !@total.nil? && @total < 0 + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] object Object to be assigned + def object=(object) + validator = EnumAttributeValidator.new('String', ["list"]) + unless validator.valid?(object) + fail ArgumentError, "invalid value for \"object\", must be one of #{validator.allowable_values}." + end + @object = object + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] data_ref Object to be assigned + def data_ref=(data_ref) + validator = EnumAttributeValidator.new('String', ["data"]) + unless validator.valid?(data_ref) + fail ArgumentError, "invalid value for \"data_ref\", must be one of #{validator.allowable_values}." + end + @data_ref = data_ref + end + + # Custom attribute writer method with validation + # @param [Object] total Value to be assigned + def total=(total) + if !total.nil? && total < 0 + fail ArgumentError, 'invalid value for "total", must be greater than or equal to 0.' + end + + @total = total + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + object == o.object && + data_ref == o.data_ref && + data == o.data && + total == o.total + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [object, data_ref, data, total].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + transformed_hash = {} + openapi_types.each_pair do |key, type| + if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = nil + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } + end + elsif !attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) + end + end + new(transformed_hash) + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def self._deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = VoucherifySdk.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/VoucherifySdk/models/area_store_campaign_assignment.rb b/lib/VoucherifySdk/models/area_store_campaign_assignment.rb new file mode 100644 index 00000000..7a5122f7 --- /dev/null +++ b/lib/VoucherifySdk/models/area_store_campaign_assignment.rb @@ -0,0 +1,297 @@ +=begin +#Voucherify API + +#Voucherify promotion engine REST API. Please see https://docs.voucherify.io/docs for more details. + +The version of the OpenAPI document: v2018-08-01 +Contact: support@voucherify.io +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 7.0.1 + +=end + +require 'date' +require 'time' + +module VoucherifySdk + # An object representing an assignment of a campaign to an area or store. + class AreaStoreCampaignAssignment + # Unique identifier of the campaign assignment. + attr_accessor :id + + # Unique identifier of the area to which the campaign is assigned. + attr_accessor :area_id + + # Unique identifier of the store to which the campaign is assigned. + attr_accessor :area_store_id + + # Date and time when the assignment was made. The value is shown in the ISO 8601 format. + attr_accessor :created_at + + # The type of the object represented by JSON. This object stores information about the campaign assignment to areas or stores. + attr_accessor :object + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'id' => :'id', + :'area_id' => :'area_id', + :'area_store_id' => :'area_store_id', + :'created_at' => :'created_at', + :'object' => :'object' + } + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'id' => :'String', + :'area_id' => :'String', + :'area_store_id' => :'String', + :'created_at' => :'Time', + :'object' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + :'id', + :'area_id', + :'area_store_id', + :'created_at', + :'object' + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `VoucherifySdk::AreaStoreCampaignAssignment` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `VoucherifySdk::AreaStoreCampaignAssignment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'area_id') + self.area_id = attributes[:'area_id'] + end + + if attributes.key?(:'area_store_id') + self.area_store_id = attributes[:'area_store_id'] + end + + if attributes.key?(:'created_at') + self.created_at = attributes[:'created_at'] + end + + if attributes.key?(:'object') + self.object = attributes[:'object'] + else + self.object = 'area_store_campaign_assignment' + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + warn '[DEPRECATED] the `valid?` method is obsolete' + object_validator = EnumAttributeValidator.new('String', ["area_store_campaign_assignment"]) + return false unless object_validator.valid?(@object) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] object Object to be assigned + def object=(object) + validator = EnumAttributeValidator.new('String', ["area_store_campaign_assignment"]) + unless validator.valid?(object) + fail ArgumentError, "invalid value for \"object\", must be one of #{validator.allowable_values}." + end + @object = object + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + id == o.id && + area_id == o.area_id && + area_store_id == o.area_store_id && + created_at == o.created_at && + object == o.object + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [id, area_id, area_store_id, created_at, object].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attributes = attributes.transform_keys(&:to_sym) + transformed_hash = {} + openapi_types.each_pair do |key, type| + if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = nil + elsif type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } + end + elsif !attributes[attribute_map[key]].nil? + transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) + end + end + new(transformed_hash) + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def self._deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + # models (e.g. Pet) or oneOf + klass = VoucherifySdk.const_get(type) + klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/VoucherifySdk/models/campaign.rb b/lib/VoucherifySdk/models/campaign.rb index efd72a21..e47045b5 100644 --- a/lib/VoucherifySdk/models/campaign.rb +++ b/lib/VoucherifySdk/models/campaign.rb @@ -101,6 +101,8 @@ class Campaign attr_accessor :validation_rules_assignments + attr_accessor :access_settings_assignments + class EnumAttributeValidator attr_reader :datatype attr_reader :allowable_values @@ -156,7 +158,8 @@ def self.attribute_map :'referral_program' => :'referral_program', :'loyalty_tiers_expiration' => :'loyalty_tiers_expiration', :'promotion' => :'promotion', - :'validation_rules_assignments' => :'validation_rules_assignments' + :'validation_rules_assignments' => :'validation_rules_assignments', + :'access_settings_assignments' => :'access_settings_assignments' } end @@ -198,7 +201,8 @@ def self.openapi_types :'referral_program' => :'ReferralProgram', :'loyalty_tiers_expiration' => :'LoyaltyTiersExpirationAll', :'promotion' => :'PromotionTiersList', - :'validation_rules_assignments' => :'ValidationRulesAssignmentsList' + :'validation_rules_assignments' => :'ValidationRulesAssignmentsList', + :'access_settings_assignments' => :'AccessSettingsCampaignAssignmentsList' } end @@ -384,6 +388,10 @@ def initialize(attributes = {}) if attributes.key?(:'validation_rules_assignments') self.validation_rules_assignments = attributes[:'validation_rules_assignments'] end + + if attributes.key?(:'access_settings_assignments') + self.access_settings_assignments = attributes[:'access_settings_assignments'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -484,7 +492,8 @@ def ==(o) referral_program == o.referral_program && loyalty_tiers_expiration == o.loyalty_tiers_expiration && promotion == o.promotion && - validation_rules_assignments == o.validation_rules_assignments + validation_rules_assignments == o.validation_rules_assignments && + access_settings_assignments == o.access_settings_assignments end # @see the `==` method @@ -496,7 +505,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [id, name, description, campaign_type, type, voucher, auto_join, join_once, use_voucher_metadata_schema, validity_timeframe, validity_day_of_week, validity_hours, activity_duration_after_publishing, vouchers_count, start_date, expiration_date, active, metadata, created_at, updated_at, category, creation_status, vouchers_generation_status, protected, category_id, categories, object, referral_program, loyalty_tiers_expiration, promotion, validation_rules_assignments].hash + [id, name, description, campaign_type, type, voucher, auto_join, join_once, use_voucher_metadata_schema, validity_timeframe, validity_day_of_week, validity_hours, activity_duration_after_publishing, vouchers_count, start_date, expiration_date, active, metadata, created_at, updated_at, category, creation_status, vouchers_generation_status, protected, category_id, categories, object, referral_program, loyalty_tiers_expiration, promotion, validation_rules_assignments, access_settings_assignments].hash end # Builds the object from hash diff --git a/lib/VoucherifySdk/models/campaigns_create_response_body.rb b/lib/VoucherifySdk/models/campaigns_create_response_body.rb index 7b6caa9b..acc5c9b6 100644 --- a/lib/VoucherifySdk/models/campaigns_create_response_body.rb +++ b/lib/VoucherifySdk/models/campaigns_create_response_body.rb @@ -102,6 +102,8 @@ class CampaignsCreateResponseBody attr_accessor :validation_rules_assignments + attr_accessor :access_settings_assignments + class EnumAttributeValidator attr_reader :datatype attr_reader :allowable_values @@ -157,7 +159,8 @@ def self.attribute_map :'referral_program' => :'referral_program', :'loyalty_tiers_expiration' => :'loyalty_tiers_expiration', :'promotion' => :'promotion', - :'validation_rules_assignments' => :'validation_rules_assignments' + :'validation_rules_assignments' => :'validation_rules_assignments', + :'access_settings_assignments' => :'access_settings_assignments' } end @@ -199,7 +202,8 @@ def self.openapi_types :'referral_program' => :'ReferralProgram', :'loyalty_tiers_expiration' => :'LoyaltyTiersExpirationAll', :'promotion' => :'PromotionTiersList', - :'validation_rules_assignments' => :'ValidationRulesAssignmentsList' + :'validation_rules_assignments' => :'ValidationRulesAssignmentsList', + :'access_settings_assignments' => :'AccessSettingsCampaignAssignmentsList' } end @@ -385,6 +389,10 @@ def initialize(attributes = {}) if attributes.key?(:'validation_rules_assignments') self.validation_rules_assignments = attributes[:'validation_rules_assignments'] end + + if attributes.key?(:'access_settings_assignments') + self.access_settings_assignments = attributes[:'access_settings_assignments'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -485,7 +493,8 @@ def ==(o) referral_program == o.referral_program && loyalty_tiers_expiration == o.loyalty_tiers_expiration && promotion == o.promotion && - validation_rules_assignments == o.validation_rules_assignments + validation_rules_assignments == o.validation_rules_assignments && + access_settings_assignments == o.access_settings_assignments end # @see the `==` method @@ -497,7 +506,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [id, name, description, campaign_type, type, voucher, auto_join, join_once, use_voucher_metadata_schema, validity_timeframe, validity_day_of_week, validity_hours, activity_duration_after_publishing, vouchers_count, start_date, expiration_date, active, metadata, created_at, updated_at, category, creation_status, vouchers_generation_status, protected, category_id, categories, object, referral_program, loyalty_tiers_expiration, promotion, validation_rules_assignments].hash + [id, name, description, campaign_type, type, voucher, auto_join, join_once, use_voucher_metadata_schema, validity_timeframe, validity_day_of_week, validity_hours, activity_duration_after_publishing, vouchers_count, start_date, expiration_date, active, metadata, created_at, updated_at, category, creation_status, vouchers_generation_status, protected, category_id, categories, object, referral_program, loyalty_tiers_expiration, promotion, validation_rules_assignments, access_settings_assignments].hash end # Builds the object from hash diff --git a/lib/VoucherifySdk/models/campaigns_get_response_body.rb b/lib/VoucherifySdk/models/campaigns_get_response_body.rb index 484165a3..45f1c351 100644 --- a/lib/VoucherifySdk/models/campaigns_get_response_body.rb +++ b/lib/VoucherifySdk/models/campaigns_get_response_body.rb @@ -102,6 +102,8 @@ class CampaignsGetResponseBody attr_accessor :validation_rules_assignments + attr_accessor :access_settings_assignments + class EnumAttributeValidator attr_reader :datatype attr_reader :allowable_values @@ -157,7 +159,8 @@ def self.attribute_map :'referral_program' => :'referral_program', :'loyalty_tiers_expiration' => :'loyalty_tiers_expiration', :'promotion' => :'promotion', - :'validation_rules_assignments' => :'validation_rules_assignments' + :'validation_rules_assignments' => :'validation_rules_assignments', + :'access_settings_assignments' => :'access_settings_assignments' } end @@ -199,7 +202,8 @@ def self.openapi_types :'referral_program' => :'ReferralProgram', :'loyalty_tiers_expiration' => :'LoyaltyTiersExpirationAll', :'promotion' => :'PromotionTiersList', - :'validation_rules_assignments' => :'ValidationRulesAssignmentsList' + :'validation_rules_assignments' => :'ValidationRulesAssignmentsList', + :'access_settings_assignments' => :'AccessSettingsCampaignAssignmentsList' } end @@ -385,6 +389,10 @@ def initialize(attributes = {}) if attributes.key?(:'validation_rules_assignments') self.validation_rules_assignments = attributes[:'validation_rules_assignments'] end + + if attributes.key?(:'access_settings_assignments') + self.access_settings_assignments = attributes[:'access_settings_assignments'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -485,7 +493,8 @@ def ==(o) referral_program == o.referral_program && loyalty_tiers_expiration == o.loyalty_tiers_expiration && promotion == o.promotion && - validation_rules_assignments == o.validation_rules_assignments + validation_rules_assignments == o.validation_rules_assignments && + access_settings_assignments == o.access_settings_assignments end # @see the `==` method @@ -497,7 +506,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [id, name, description, campaign_type, type, voucher, auto_join, join_once, use_voucher_metadata_schema, validity_timeframe, validity_day_of_week, validity_hours, activity_duration_after_publishing, vouchers_count, start_date, expiration_date, active, metadata, created_at, updated_at, category, creation_status, vouchers_generation_status, protected, category_id, categories, object, referral_program, loyalty_tiers_expiration, promotion, validation_rules_assignments].hash + [id, name, description, campaign_type, type, voucher, auto_join, join_once, use_voucher_metadata_schema, validity_timeframe, validity_day_of_week, validity_hours, activity_duration_after_publishing, vouchers_count, start_date, expiration_date, active, metadata, created_at, updated_at, category, creation_status, vouchers_generation_status, protected, category_id, categories, object, referral_program, loyalty_tiers_expiration, promotion, validation_rules_assignments, access_settings_assignments].hash end # Builds the object from hash diff --git a/lib/VoucherifySdk/models/campaigns_update_response_body.rb b/lib/VoucherifySdk/models/campaigns_update_response_body.rb index 0ba9d4be..a7ead20e 100644 --- a/lib/VoucherifySdk/models/campaigns_update_response_body.rb +++ b/lib/VoucherifySdk/models/campaigns_update_response_body.rb @@ -102,6 +102,8 @@ class CampaignsUpdateResponseBody attr_accessor :validation_rules_assignments + attr_accessor :access_settings_assignments + class EnumAttributeValidator attr_reader :datatype attr_reader :allowable_values @@ -157,7 +159,8 @@ def self.attribute_map :'referral_program' => :'referral_program', :'loyalty_tiers_expiration' => :'loyalty_tiers_expiration', :'promotion' => :'promotion', - :'validation_rules_assignments' => :'validation_rules_assignments' + :'validation_rules_assignments' => :'validation_rules_assignments', + :'access_settings_assignments' => :'access_settings_assignments' } end @@ -199,7 +202,8 @@ def self.openapi_types :'referral_program' => :'ReferralProgram', :'loyalty_tiers_expiration' => :'LoyaltyTiersExpirationAll', :'promotion' => :'PromotionTiersList', - :'validation_rules_assignments' => :'ValidationRulesAssignmentsList' + :'validation_rules_assignments' => :'ValidationRulesAssignmentsList', + :'access_settings_assignments' => :'AccessSettingsCampaignAssignmentsList' } end @@ -385,6 +389,10 @@ def initialize(attributes = {}) if attributes.key?(:'validation_rules_assignments') self.validation_rules_assignments = attributes[:'validation_rules_assignments'] end + + if attributes.key?(:'access_settings_assignments') + self.access_settings_assignments = attributes[:'access_settings_assignments'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -485,7 +493,8 @@ def ==(o) referral_program == o.referral_program && loyalty_tiers_expiration == o.loyalty_tiers_expiration && promotion == o.promotion && - validation_rules_assignments == o.validation_rules_assignments + validation_rules_assignments == o.validation_rules_assignments && + access_settings_assignments == o.access_settings_assignments end # @see the `==` method @@ -497,7 +506,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [id, name, description, campaign_type, type, voucher, auto_join, join_once, use_voucher_metadata_schema, validity_timeframe, validity_day_of_week, validity_hours, activity_duration_after_publishing, vouchers_count, start_date, expiration_date, active, metadata, created_at, updated_at, category, creation_status, vouchers_generation_status, protected, category_id, categories, object, referral_program, loyalty_tiers_expiration, promotion, validation_rules_assignments].hash + [id, name, description, campaign_type, type, voucher, auto_join, join_once, use_voucher_metadata_schema, validity_timeframe, validity_day_of_week, validity_hours, activity_duration_after_publishing, vouchers_count, start_date, expiration_date, active, metadata, created_at, updated_at, category, creation_status, vouchers_generation_status, protected, category_id, categories, object, referral_program, loyalty_tiers_expiration, promotion, validation_rules_assignments, access_settings_assignments].hash end # Builds the object from hash