diff --git a/.github/workflows/dotnet-tests.yml b/.github/workflows/dotnet-tests.yml new file mode 100644 index 00000000..556c2711 --- /dev/null +++ b/.github/workflows/dotnet-tests.yml @@ -0,0 +1,39 @@ +name: .NET Tests + +on: + pull_request: + branches: [ master ] + +jobs: + test: + runs-on: ubuntu-latest + defaults: + run: + shell: bash + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup .NET + uses: actions/setup-dotnet@v4 + with: + dotnet-version: "9.0.x" + + - name: Restore + run: dotnet restore src/Voucherify.Test/Voucherify.Test.csproj + + - name: Create test .env (from GitHub Secrets) + run: | + cat > src/Voucherify.Test/.env << 'EOF' + VOUCHERIFY_HOST=${{ vars.VOUCHERIFY_HOST }} + X_APP_ID=${{ secrets.X_APP_ID }} + X_APP_TOKEN=${{ secrets.X_APP_TOKEN }} + X_MANAGEMENT_ID=${{ secrets.X_MANAGEMENT_ID }} + X_MANAGEMENT_TOKEN=${{ secrets.X_MANAGEMENT_TOKEN }} + PROJECT_ID=${{ vars.PROJECT_ID }} + EOF + + - name: Run tests (detailed) + run: | + dotnet test src/Voucherify.Test/Voucherify.Test.csproj diff --git a/ENDPOINTS-COVERAGE.md b/ENDPOINTS-COVERAGE.md index 360f2450..b83e5ae8 100644 --- a/ENDPOINTS-COVERAGE.md +++ b/ENDPOINTS-COVERAGE.md @@ -42,61 +42,61 @@ | ------------------ | ------ | ----------------- | ------------------------------------ | ------------- | | /v1/qualifications | post | Check Eligibility | supported | | ## Validations -| endpoint | method | summary | is supported | is deprecated | -| ---------------------------------------- | ------ | ---------------------------- | ------------------------------------ | ------------- | -| /v1/validations | post | Validate Stackable Discounts | supported | | -| /v1/vouchers/{code}/validate | post | Validate Voucher | | | -| /v1/promotions/validation | post | Validate Promotions | | | -| /v1/promotions/tiers/{tierId}/validation | post | Validate Promotion Tier | | | +| endpoint | method | summary | is supported | is deprecated | +| ---------------------------------------- | ------ | ---------------------------- | ------------------------------------ | ------------------------------------ | +| /v1/validations | post | Validate Stackable Discounts | supported | | +| /v1/vouchers/{code}/validate | post | Validate Voucher | | deprecated | +| /v1/promotions/validation | post | Validate Promotions | | deprecated | +| /v1/promotions/tiers/{tierId}/validation | post | Validate Promotion Tier | | deprecated | ## Redemptions -| 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 | | | -| /v1/redemptions/{redemptionId}/rollback | post | Rollback Redemption | supported | | -| /v1/promotions/tiers/{promotionTierId}/redemption | post | Redeem Promotion | | | -| /v1/redemptions/{parentRedemptionId}/rollbacks | post | Rollback Stackable Redemptions | 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 | +| /v1/redemptions/{redemptionId}/rollback | post | Rollback Redemption | supported | | +| /v1/promotions/tiers/{promotionTierId}/redemption | post | Redeem Promotion | | deprecated | +| /v1/redemptions/{parentRedemptionId}/rollbacks | post | Rollback Stackable Redemptions | supported | | ## Vouchers -| endpoint | method | summary | is supported | is deprecated | -| ----------------------------------------- | ------ | --------------------------------- | ------------------------------------ | ------------- | -| /v1/vouchers | get | List Vouchers | supported | | -| /v1/vouchers | post | Generate Random Code | supported | | -| /v1/vouchers/{code} | get | Get Voucher | supported | | -| /v1/vouchers/{code} | put | Update Voucher | supported | | -| /v1/vouchers/{code} | delete | Delete Voucher | supported | | -| /v1/vouchers/{code} | post | Create Voucher | supported | | -| /v1/vouchers/{code}/enable | post | Enable Voucher | supported | | -| /v1/vouchers/{code}/disable | post | Disable Voucher | supported | | -| /v1/vouchers/{code}/balance | post | Adjust 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 | supported | | -| /v1/vouchers/importCSV | post | Import Vouchers using CSV | supported | | -| /v1/vouchers/bulk/async | post | Update Vouchers in Bulk | supported | | -| /v1/vouchers/metadata/async | post | Update Vouchers' Metadata in Bulk | supported | | -| /v1/vouchers/{code}/sessions/{sessionKey} | delete | Release Validation Session | supported | | -| /v1/vouchers/qualification | post | Examine Voucher Qualification | | | +| endpoint | method | summary | is supported | is deprecated | +| ----------------------------------------- | ------ | --------------------------------- | ------------------------------------ | ------------------------------------ | +| /v1/vouchers | get | List Vouchers | supported | | +| /v1/vouchers | post | Generate Random Code | supported | | +| /v1/vouchers/{code} | get | Get Voucher | supported | | +| /v1/vouchers/{code} | put | Update Voucher | supported | | +| /v1/vouchers/{code} | delete | Delete Voucher | supported | | +| /v1/vouchers/{code} | post | Create Voucher | supported | | +| /v1/vouchers/{code}/enable | post | Enable Voucher | supported | | +| /v1/vouchers/{code}/disable | post | Disable Voucher | supported | | +| /v1/vouchers/{code}/balance | post | Adjust 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 | supported | | +| /v1/vouchers/importCSV | post | Import Vouchers using CSV | supported | | +| /v1/vouchers/bulk/async | post | Update Vouchers in Bulk | supported | | +| /v1/vouchers/metadata/async | post | Update Vouchers' Metadata in Bulk | supported | | +| /v1/vouchers/{code}/sessions/{sessionKey} | delete | Release Validation Session | supported | | +| /v1/vouchers/qualification | post | Examine Voucher Qualification | | deprecated | ## Campaigns -| 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 Campaign Qualification | | | -| /v1/campaigns/{campaignId}/enable | post | Enable Campaign | supported | | -| /v1/campaigns/{campaignId}/disable | post | Disable Campaign | supported | | -| /v1/campaigns/{campaignId}/transactions | get | List Campaign Transactions | supported | | -| /v1/campaigns/{campaignId}/transactions/export | post | Export Campaign Transactions | supported | | -| /v1/campaigns/{campaignId}/summary | get | Get Campaign Summary | 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 Campaign Qualification | | deprecated | +| /v1/campaigns/{campaignId}/enable | post | Enable Campaign | supported | | +| /v1/campaigns/{campaignId}/disable | post | Disable Campaign | supported | | +| /v1/campaigns/{campaignId}/transactions | get | List Campaign Transactions | supported | | +| /v1/campaigns/{campaignId}/transactions/export | post | Export Campaign Transactions | supported | | +| /v1/campaigns/{campaignId}/summary | get | Get Campaign Summary | supported | | ## Promotions | endpoint | method | summary | is supported | is deprecated | | ---------------------------------------------- | ------ | ---------------------------------- | ------------------------------------ | ------------- | @@ -182,22 +182,23 @@ | /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 | | +| /v1/loyalties/{campaignId}/qualifications | post | Estimate loyalty points | | | ## Customers -| 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}/activity | get | List Customer Activity | supported | | -| /v1/customers/{customerId}/activities | get | List Customer Activities | | | -| /v1/customers/{customerId}/segments | get | List Customer's Segments | supported | | -| /v1/customers/{customerId}/redeemables | get | List Customer's Redeemables | 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}/activity | get | List Customer Activity | supported | | +| /v1/customers/{customerId}/activities | get | List Customer Activities | | deprecated | +| /v1/customers/{customerId}/segments | get | List Customer's Segments | supported | | +| /v1/customers/{customerId}/redeemables | get | List Customer's Redeemables | supported | | ## Orders | endpoint | method | summary | is supported | is deprecated | | -------------------- | ------ | -------------------- | ------------------------------------ | ------------- | @@ -357,13 +358,13 @@ | /v1/oauth/introspect | post | Introspect OAuth 2.0 Token | supported | | | /v1/oauth/token/revoke | post | Revoke OAuth 2.0 Token | supported | | ## Client-side -| 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) | supported | | -| /client/v1/redemptions | post | Redeem Stackable Discounts (client-side) | supported | | -| /client/v1/validations | post | Validate Stackable Discounts (client-side) | supported | | -| /client/v1/events | post | Track Custom Event (client-side) | supported | | -| /client/v1/validate | get | Validate Voucher (client-side) | | | -| /client/v1/redeem | post | Redeem Voucher (client-side) | | | -| /client/v1/publish | post | Create Publication (client-side) | | | \ 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) | supported | | +| /client/v1/redemptions | post | Redeem Stackable Discounts (client-side) | supported | | +| /client/v1/validations | post | Validate Stackable Discounts (client-side) | supported | | +| /client/v1/events | post | Track Custom Event (client-side) | supported | | +| /client/v1/validate | get | Validate Voucher (client-side) | | deprecated | +| /client/v1/redeem | post | Redeem Voucher (client-side) | | deprecated | +| /client/v1/publish | post | Create Publication (client-side) | | | \ No newline at end of file diff --git a/api/openapi.yaml b/api/openapi.yaml index 1aeebf76..a084be8e 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -277,9 +277,19 @@ paths: requestBody: content: application/json: + examples: + ALL scenario with options: + value: + scenario: ALL + options: + limit: 10 + expand: + - redeemable + sorting_rule: DEFAULT schema: $ref: '#/components/schemas/QualificationsCheckEligibilityRequestBody' description: Define order and customer context. + required: true responses: "200": content: @@ -555,6 +565,7 @@ paths: quantity: 1 schema: $ref: '#/components/schemas/ValidationsValidateRequestBody' + required: true responses: "200": content: @@ -1503,9 +1514,7 @@ paths: \ \n πŸ“˜ Also available on client-side\n This method is also accessible\ \ through public keys which you can use in client-side​ apps: mobile and web\ \ browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side)\ - \ to learn more.\n - Use X-Client-Application-Id as the application ID header.\n\ - \ - Use X-Client-Token as the appliction secret key header.\n - Use client-side\ - \ base URL.\n - Use an origin header for your custom domain." + \ to learn more." operationId: redeem-stacked-discounts parameters: [] requestBody: @@ -1558,6 +1567,7 @@ paths: key: value schema: $ref: '#/components/schemas/RedemptionsRedeemRequestBody' + required: true responses: "200": content: @@ -1681,6 +1691,16 @@ paths: schema: $ref: '#/components/schemas/ParameterIds' style: form + - description: "Object for setting voucher filters. Read [Advanced filters for\ + \ fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources)\ + \ for filter examples." + explode: true + in: query + name: filters + required: false + schema: + type: object + style: deepObject responses: "200": content: @@ -1954,6 +1974,7 @@ paths: schema: $ref: '#/components/schemas/VouchersCreateRequestBody' description: Specify the details of the voucher that you would like to create. + required: true responses: "200": content: @@ -2851,6 +2872,7 @@ paths: schema: $ref: '#/components/schemas/VouchersCreateWithSpecificCodeRequestBody' description: Specify the details of the voucher that you would like to create. + required: true responses: "200": content: @@ -4080,6 +4102,7 @@ paths: schema: $ref: '#/components/schemas/VouchersTransactionsExportCreateRequestBody' description: Specify the parameters for the camapign transaction export. + required: true responses: "200": content: @@ -4146,8 +4169,10 @@ paths: /v1/vouchers/import: post: description: "Import generic (standalone) vouchers and gift cards into the repository.\n\ - \ πŸ“˜ Important notes\n - **Start and expiration dates** need to be provided\ - \ in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z.\n\ + You can upload up to 100,000 codes to a campaign, as a campaign can have up\ + \ to 100,000 codes by default. \n Also, the request can include up to **10\ + \ MB** of data.\n πŸ“˜ Important notes\n - **Start and expiration dates** need\ + \ to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z.\n\ \ - Custom code attributes (not supported by-default) need to be added as\ \ code **metadata**.\n - You **cannot import the same codes** to a single\ \ Voucherify Project.\nAny parameters not provided in the payload will be\ @@ -4376,8 +4401,10 @@ paths: description: "Import generic (standalone) vouchers into the repository using\ \ a CSV file.\nThe CSV file has to include headers in the first line. All\ \ properties listed in the file headers that cannot be mapped to standard\ - \ voucher fields will be added to the metadata object. \nYou can find an\ - \ example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons).\n\ + \ voucher fields will be added to the metadata object.\nYou can upload up\ + \ to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes\ + \ by default. \n Also, the request can include a max. **10 MB** CSV file.\n\ + You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons).\n\ ___\n πŸ“˜ Standard voucher fields mapping\n - Go to the [import vouchers](/api-reference/vouchers/import-vouchers)\ \ endpoint to see all standard CSV fields description (body params section).\n\ \ - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start\ @@ -4420,6 +4447,7 @@ paths: schema: $ref: '#/components/schemas/VouchersImportCSVRequestBody' description: The file path is stored in the form file header. + required: true responses: "202": content: @@ -5137,6 +5165,7 @@ paths: schema: $ref: '#/components/schemas/CampaignsCreateRequestBody' description: Specify the details of the campaign that you would like to create. + required: true responses: "200": content: @@ -5703,6 +5732,7 @@ paths: schema: $ref: '#/components/schemas/CampaignsUpdateRequestBody' description: Specify the campaign parameters to be updated. + required: true responses: "200": content: @@ -5827,6 +5857,7 @@ paths: schema: $ref: '#/components/schemas/CampaignsVouchersCreateInBulkRequestBody' description: Specify the voucher parameters that you would like to overwrite. + required: true responses: "200": content: @@ -5889,6 +5920,7 @@ paths: schema: $ref: '#/components/schemas/CampaignsVouchersCreateRequestBody' description: Specify the voucher parameters that you would like to overwrite. + required: true responses: "200": content: @@ -6077,6 +6109,7 @@ paths: description: "Discount type, expiration date and the remaining attributes\ \ will be taken from the [Campaign](/api-reference/campaigns/get-campaign)\ \ settings." + required: true responses: "202": content: @@ -6128,6 +6161,7 @@ paths: schema: $ref: '#/components/schemas/CampaignsVouchersImportCSVRequestBody' description: The file path is stored in the form file header. + required: true responses: "200": content: @@ -6406,6 +6440,7 @@ paths: schema: $ref: '#/components/schemas/CampaignsTransactionsExportCreateRequestBody' description: Specify the parameters for the transaction export. + required: true responses: "200": content: @@ -6902,6 +6937,7 @@ paths: schema: $ref: '#/components/schemas/PromotionsTiersCreateRequestBody' description: Specify the promotion tier parameters. + required: true responses: "200": content: @@ -7069,6 +7105,7 @@ paths: $ref: '#/components/schemas/PromotionsTiersUpdateRequestBody' description: Specify the promotion tier parameters that you would like to update. + required: true responses: "200": content: @@ -7559,6 +7596,7 @@ paths: schema: $ref: '#/components/schemas/PromotionsStacksCreateRequestBody' description: Specify the order of promotion tiers for the promotion stack. + required: true responses: "200": content: @@ -7716,6 +7754,7 @@ paths: $ref: '#/components/schemas/PromotionsStacksUpdateRequestBody' description: Specify the promotion stack parameters that you would like to update. + required: true responses: "200": content: @@ -7941,6 +7980,7 @@ paths: schema: $ref: '#/components/schemas/RewardsCreateRequestBody' description: Define parameters of the new reward. + required: true responses: "200": content: @@ -8097,6 +8137,7 @@ paths: schema: $ref: '#/components/schemas/RewardsUpdateRequestBody' description: Define the parameters to be updated for the reward. + required: true responses: "200": content: @@ -8234,6 +8275,7 @@ paths: $ref: '#/components/schemas/RewardsAssignmentsCreateRequestBody' description: Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. + required: true responses: "200": content: @@ -8364,6 +8406,7 @@ paths: schema: $ref: '#/components/schemas/RewardsAssignmentsUpdateRequestBody' description: Define the number of points required to exchange for the reward. + required: true responses: "200": content: @@ -8695,6 +8738,7 @@ paths: schema: $ref: '#/components/schemas/PublicationsCreateRequestBody' description: Specify the publication parameters. + required: true responses: "200": content: @@ -10467,6 +10511,7 @@ paths: description: Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. + required: true responses: "200": content: @@ -11033,6 +11078,7 @@ paths: description: Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. + required: true responses: "200": content: @@ -11309,6 +11355,7 @@ paths: schema: $ref: '#/components/schemas/LoyaltiesCreateCampaignRequestBody' description: Specify the loyalty campaign details. + required: true responses: "200": content: @@ -11617,6 +11664,7 @@ paths: $ref: '#/components/schemas/LoyaltiesUpdateCampaignRequestBody' description: Specify the new values for the parameters that you would like to update for the given loyalty campaign. + required: true responses: "200": content: @@ -11973,6 +12021,7 @@ paths: \ (assignments of particular codes to customers) and publication metadata,\ \ use the [List Publications](/api-reference/publications/list-publications)\ \ endpoint." + required: true responses: "200": content: @@ -12790,6 +12839,7 @@ paths: schema: $ref: '#/components/schemas/LoyaltiesMembersPendingPointsBalanceRequestBody' description: Define the number of pending points to be added or subtracted. + required: true responses: "200": content: @@ -13023,6 +13073,7 @@ paths: schema: $ref: '#/components/schemas/LoyaltiesMembersBalanceUpdateRequestBody' description: Specify the point adjustment along with the expiration mechanism. + required: true responses: "200": content: @@ -13096,6 +13147,7 @@ paths: schema: $ref: '#/components/schemas/LoyaltiesMembersBalanceUpdateRequestBody' description: Specify the point adjustment along with the expiration mechanism. + required: true responses: "200": content: @@ -13164,6 +13216,7 @@ paths: $ref: '#/components/schemas/LoyaltiesMembersTransfersCreateRequestBody' description: Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. + required: true responses: "200": content: @@ -13406,6 +13459,7 @@ paths: schema: $ref: '#/components/schemas/LoyaltiesTransactionsExportCreateRequestBody' description: Specify the parameters for the transaction export. + required: true responses: "200": content: @@ -14110,6 +14164,7 @@ paths: schema: $ref: '#/components/schemas/LoyaltiesMembersTransactionsExportCreateRequestBody' description: Specify the parameters and filters for the transaction export. + required: true responses: "200": content: @@ -14221,6 +14276,7 @@ paths: schema: $ref: '#/components/schemas/LoyaltiesMembersTransactionsExportCreateRequestBody' description: Specify the parameters and filters for the transaction export. + required: true responses: "200": content: @@ -14445,6 +14501,7 @@ paths: $ref: '#/components/schemas/LoyaltiesPointsExpirationExportCreateRequestBody' description: "Specify the data filters, types of data to return and order\ \ in which the results should be returned." + required: true responses: "200": content: @@ -15394,6 +15451,7 @@ paths: \ requires a custom_event object\n- a customer.loyalty.tier.joined, customer.loyalty.tier.left,\ \ customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged\ \ requires a loyalty_tier object" + required: true responses: "200": content: @@ -16220,6 +16278,7 @@ paths: $ref: '#/components/schemas/LoyaltiesEarningRulesUpdateRequestBody' description: Specify the parameters that you would like to update for the given earning rule. + required: true responses: "200": content: @@ -16956,6 +17015,7 @@ paths: schema: $ref: '#/components/schemas/LoyaltiesRewardsCreateAssignmentRequestBody' description: Define the cost of the rewards in loyalty points. + required: true responses: "200": content: @@ -17170,6 +17230,7 @@ paths: schema: $ref: '#/components/schemas/LoyaltiesRewardsUpdateAssignmentRequestBody' description: Update the points cost for the reward assignment. + required: true responses: "200": content: @@ -17248,6 +17309,7 @@ paths: \ remainder of the order. If the limit of available points on the card is\ \ reached, then only the available points on the card will be applied to\ \ the order." + required: true responses: "200": content: @@ -18453,6 +18515,7 @@ paths: \ remainder of the order. If the limit of available points on the card is\ \ reached, then only the available points on the card will be applied to\ \ the order." + required: true responses: "200": content: @@ -18788,6 +18851,7 @@ paths: $ref: '#/components/schemas/LoyaltiesTiersCreateInBulkRequestBody' description: Provide tier definitions you want to add to existing loyalty campaign. + required: true responses: "200": content: @@ -19871,6 +19935,7 @@ paths: schema: $ref: '#/components/schemas/CustomersCreateRequestBody' description: Create a customer with specified parameters. + required: true responses: "200": content: @@ -20072,6 +20137,7 @@ paths: schema: $ref: '#/components/schemas/CustomersUpdateRequestBody' description: Specify the parameters to be updated. + required: true responses: "200": content: @@ -20232,6 +20298,7 @@ paths: schema: $ref: '#/components/schemas/CustomersImportCSVRequestBody' description: The file path is stored in the form file header. + required: true responses: "202": content: @@ -20330,6 +20397,7 @@ paths: title: Update Customers in bulk Request Body type: array description: List the customer fields to be updated in each customer object. + required: true responses: "202": content: @@ -20380,6 +20448,7 @@ paths: $ref: '#/components/schemas/CustomersMetadataUpdateInBulkRequestBody' description: List the source_ids of the customers you would like to update with the metadata key/value pairs. + required: true responses: "202": content: @@ -21421,6 +21490,7 @@ paths: schema: $ref: '#/components/schemas/OrdersCreateRequestBody' description: Specify the order parameters. + required: true responses: "200": content: @@ -21558,6 +21628,7 @@ paths: schema: $ref: '#/components/schemas/OrdersUpdateRequestBody' description: Specify the parameters of the order that are to be updated. + required: true responses: "200": content: @@ -21647,41 +21718,42 @@ paths: post: description: "\n 🚧 Historical orders\n This endpoint should only be used to\ \ import historical orders into Voucherify. For on-going synchronization,\ - \ the [update order](/api-reference/orders/update-order) endpoints should\ - \ be used. This is critical because this endpoint does not store events or\ - \ launch distributions.\n# Limitations\n## Import volume\nThere can be only\ + \ the [update order](/api-reference/orders/update-order) endpoint should be\ + \ used. This is critical because this endpoint does not store events or launch\ + \ distributions.\nThe orders will also have a created_at date thats assigned\ + \ when theyve been imported to Voucherify. To keep track of the actual order\ + \ creation date, add an order metadata in ISO 8601 date or date time format\ + \ to each imported order.\n# Limitations\n## Import volume\nThere can be only\ \ a single on-going order import per tenant per project at a given time. The\ \ user can schedule more imports but those extra imports will be scheduled\ \ to run in sequence one by one. \n## Maximum count of orders in single import\n\ - There is a 2000 limit but we might decide to change it to a lower / higher\ - \ value at any given time depending if we find this value is too high or too\ - \ low with time.\n# Notifications\nThere are no notifications on the Dashboard\ - \ because this import is launched via the API.\n# Triggered actions\n \n\ - If you import orders with customers, then a logic will be scheduled responsible\ - \ for placing these customers into segments and refreshing the segments summary.\ - \ Consequently, this update will trigger \n- **customers entering into segments**\ - \ \n- **distributions** based on any rules tied to customer entering segment(s)\n\ - - **earning rules** based on the customer entering segment(s)\n# What is not\ - \ triggered\n1. No webhooks are triggered during the import of orders - for\ - \ both orders and upserted products / SKUs. \n2. Distributions based on Order\ - \ Update, Order Paid, Order Created and Order Cancelled. In other words if\ - \ you have a distribution based on Order Paid and you import an order with\ - \ a PAID status, the distribution is not going to be triggered. \n3. No\ - \ events are created during the import of orders - for both orders and upserted\ - \ products / SKUs. In other words you wont see any events in the Activity\ - \ tab in the Dashboard such as Order created or Order paid. If you are additionally\ - \ upserting products / SKUs, then you wont see the Product created events\ - \ listed, etc. \n4. Earning rules based on Order Paid wont be triggered.\n\ - This API request starts a process that affects Voucherify data in bulk. \n\ - In case of small jobs (like bulk update) the request is put into a queue and\ - \ processed once every other bulk request placed in the queue prior to this\ - \ request is finished. However, when the job takes a longer time (like vouchers\ - \ generation) then it is processed in small portions in a round-robin fashion.\ - \ When there is a list of vouchers generation scheduled, then they will all\ - \ have the IN_PROGRESS status shortly. This way, small jobs added just after\ - \ scheduling big jobs of the same type will be processed in a short time window.\ - \ \nThe result will return the async ID. You can verify the status of your\ - \ request with [GET Async Action](/api-reference/async-actions/get-async-action)\ + There is a 2000 limit of orders per one request.\n# Notifications\nThere are\ + \ no notifications on the Dashboard because this import is launched via the\ + \ API.\n# Triggered actions\n \nIf you import orders with customers, then\ + \ a logic will be scheduled responsible for placing these customers into segments\ + \ and refreshing the segments summary. Consequently, this update will trigger\ + \ \n- Customers entering into segments\n- Distributions based on any rules\ + \ tied to customer entering segment(s)\n- Earning rules based on the customer\ + \ entering segment(s)\n# What is not triggered\n1. No webhooks are triggered\ + \ during the import of orders - for both orders and upserted products / SKUs.\ + \ \n2. Distributions based on Order Update, Order Paid, Order Created and\ + \ Order Cancelled. In other words if you have a distribution based on Order\ + \ Paid and you import an order with a PAID status, the distribution is not\ + \ going to be triggered. \n3. No events are created during the import of\ + \ orders - for both orders and upserted products / SKUs. In other words you\ + \ wont see any events in the Activity tab in the Dashboard such as Order created\ + \ or Order paid. If you are additionally upserting products / SKUs, then you\ + \ wont see the Product created events listed, etc. \n4. Earning rules based\ + \ on Order Paid wont be triggered.\nThis API request starts a process that\ + \ affects Voucherify data in bulk. \nIn case of small jobs (like bulk update)\ + \ the request is put into a queue and processed once every other bulk request\ + \ placed in the queue prior to this request is finished. However, when the\ + \ job takes a longer time (like vouchers generation) then it is processed\ + \ in small portions in a round-robin fashion. When there is a list of vouchers\ + \ generation scheduled, then they will all have the IN_PROGRESS status shortly.\ + \ This way, small jobs added just after scheduling big jobs of the same type\ + \ will be processed in a short time window. \nThe result will return the async\ + \ ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action)\ \ endpoint." operationId: import-orders parameters: [] @@ -21852,6 +21924,7 @@ paths: schema: $ref: '#/components/schemas/OrdersImportCreateRequestBody' description: The request body is sent in the form of an array of order objects. + required: true responses: "200": content: @@ -21935,6 +22008,7 @@ paths: schema: $ref: '#/components/schemas/OrdersExportCreateRequestBody' description: Specify which order parameters you would like to export. + required: true responses: "200": content: @@ -22174,6 +22248,7 @@ paths: schema: $ref: '#/components/schemas/ProductsCreateRequestBody' description: Specify the product parameters. + required: true responses: "200": content: @@ -22349,6 +22424,7 @@ paths: schema: $ref: '#/components/schemas/ProductsUpdateRequestBody' description: Specify the parameters of the product that are to be updated. + required: true responses: "200": content: @@ -22429,6 +22505,7 @@ paths: $ref: '#/components/schemas/ProductsUpdateInBulkRequestBody' type: array description: List the product fields to be updated in each product object. + required: true responses: "202": content: @@ -22483,6 +22560,7 @@ paths: $ref: '#/components/schemas/ProductsMetadataUpdateInBulkRequestBody' description: List the source_ids of the products you would like to update with the metadata key/value pairs. + required: true responses: "202": content: @@ -22732,6 +22810,7 @@ paths: schema: $ref: '#/components/schemas/ProductsSkusCreateRequestBody' description: Specify the SKU parameters to be created. + required: true responses: "200": content: @@ -22850,6 +22929,7 @@ paths: schema: $ref: '#/components/schemas/ProductsSkusUpdateRequestBody' description: Specify the parameters to be updated. + required: true responses: "200": content: @@ -22930,6 +23010,7 @@ paths: schema: $ref: '#/components/schemas/ProductsImportCSVRequestBody' description: The file path is stored in the form file header. + required: true responses: "200": content: @@ -22990,6 +23071,7 @@ paths: schema: $ref: '#/components/schemas/SkusImportCSVRequestBody' description: The file path is stored in the form file header. + required: true responses: "200": content: @@ -23174,8 +23256,31 @@ paths: requestBody: content: application/json: + examples: + Create static collection: + value: + type: STATIC + name: Static collection example + products: + - id: prod_0a41dd45dc85fcab40 + object: product + Create dynamic collection: + value: + type: AUTO_UPDATE + name: Voucherify example collection + filter: + junction: and + metadata.brand: + conditions: + $is: + - Voucherify + price: + conditions: + $more_than: + - 5000 schema: $ref: '#/components/schemas/ProductCollectionsCreateRequestBody' + required: true responses: "200": content: @@ -23709,6 +23814,7 @@ paths: schema: $ref: '#/components/schemas/ValidationRulesCreateRequestBody' description: Specify the validation rules parameters. + required: true responses: "200": content: @@ -23923,6 +24029,7 @@ paths: schema: $ref: '#/components/schemas/ValidationRulesUpdateRequestBody' description: Specify the parameters to be updated. + required: true responses: "200": content: @@ -24254,6 +24361,7 @@ paths: $ref: '#/components/schemas/ValidationRulesAssignmentsCreateRequestBody' description: Specify the resource that you would like to assign the validation rule to. + required: true responses: "200": content: @@ -24432,6 +24540,7 @@ paths: schema: $ref: '#/components/schemas/SegmentsCreateRequestBody' description: Specify the boundary conditions for the customer segment. + required: true responses: "200": content: @@ -24519,6 +24628,7 @@ paths: schema: $ref: '#/components/schemas/EventsCreateRequestBody' description: Specify the details of the custom event. + required: true responses: "200": content: @@ -25199,6 +25309,7 @@ paths: schema: $ref: '#/components/schemas/ExportsCreateRequestBody' description: Specify the details of the export that you would like to create. + required: true responses: "200": content: @@ -25419,6 +25530,7 @@ paths: schema: $ref: '#/components/schemas/CategoriesCreateRequestBody' description: Specify the details of the category that you would like to create. + required: true responses: "200": content: @@ -25527,6 +25639,7 @@ paths: schema: $ref: '#/components/schemas/CategoriesUpdateRequestBody' description: Specify the details of the category that you would like to update. + required: true responses: "200": content: @@ -26706,6 +26819,7 @@ paths: schema: $ref: '#/components/schemas/ReferralsMembersHoldersCreateInBulkRequestBody' description: Specify the customer data to be upserted as redeemable holders. + required: true responses: "200": content: @@ -26934,6 +27048,7 @@ paths: schema: $ref: '#/components/schemas/ReferralsMembersHoldersCreateInBulkRequestBody' description: Specify the customer data to be upserted as redeemable holders. + required: true responses: "200": content: @@ -27259,6 +27374,7 @@ paths: schema: $ref: '#/components/schemas/TemplatesCampaignsCreateRequestBody' description: Provide details for a campaign template + required: true responses: "200": content: @@ -27374,6 +27490,7 @@ paths: schema: $ref: '#/components/schemas/TemplatesCampaignsUpdateRequestBody' description: Provide the new name or description for the campaign template + required: true responses: "200": content: @@ -27440,6 +27557,7 @@ paths: $ref: '#/components/schemas/TemplatesCampaignsCampaignSetupCreateRequestBody' description: Only name is required. The rest of the fields will overwrite the template configuration. + required: true responses: "200": content: @@ -27571,6 +27689,7 @@ paths: $ref: '#/components/schemas/TemplatesCampaignsTierSetupCreateRequestBody' description: Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. + required: true responses: "200": content: @@ -27877,6 +27996,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsCreateRequestBody' description: Define project details. + required: true responses: "200": content: @@ -28096,6 +28216,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsUpdateRequestBody' description: Define the project details to be updated. + required: true responses: "200": content: @@ -28250,6 +28371,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsUsersAssignRequestBody' description: Defines the user details. + required: true responses: "200": content: @@ -28385,6 +28507,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsUsersUpdateRoleRequestBody' description: Defines the users new role. + required: true responses: "200": content: @@ -28426,6 +28549,7 @@ paths: $ref: '#/components/schemas/ManagementProjectsUsersInviteCreateRequestBody' description: "Defines the details of the invitation, the project, and roles\ \ to which the user will be assigned." + required: true responses: "204": description: Returns no content if the invitation has been sent successfully. @@ -28565,6 +28689,7 @@ paths: $ref: '#/components/schemas/ManagementProjectsTemplatesCampaignsCopyCreateRequestBody' description: Determines the details about the template in the destination project as well as the destination project itself. + required: true responses: "200": content: @@ -28679,6 +28804,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsStackingRulesCreateRequestBody' description: Defines the stacking rule parameters. + required: true responses: "200": content: @@ -28859,6 +28985,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsStackingRulesUpdateRequestBody' description: Defines the stacking rules to be updated. + required: true responses: "200": content: @@ -29177,6 +29304,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsMetadataSchemasCreateRequestBody' description: Defines the metadata schema. + required: true responses: "200": content: @@ -29390,6 +29518,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsMetadataSchemasUpdateRequestBody' description: Defines the metadata schema to be updated. + required: true responses: "200": content: @@ -29503,6 +29632,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsCustomEventSchemasCreateRequestBody' description: Defines the custom event schema. + required: true responses: "200": content: @@ -29648,6 +29778,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsCustomEventSchemasUpdateRequestBody' description: Defines the custom event schema to be updated. + required: true responses: "200": content: @@ -29790,6 +29921,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsWebhooksCreateRequestBody' description: Defines a webhook configuration. + required: true responses: "200": content: @@ -29923,6 +30055,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsWebhooksUpdateRequestBody' description: Defines the webhook configuration to be updated. + required: true responses: "200": content: @@ -30058,6 +30191,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsBrandingCreateRequestBody' description: Defines a brand configuration. + required: true responses: "200": content: @@ -30223,6 +30357,7 @@ paths: schema: $ref: '#/components/schemas/ManagementProjectsBrandingUpdateRequestBody' description: Defines the brand configuration to be updated. + required: true responses: "200": content: @@ -30287,6 +30422,7 @@ paths: $ref: '#/components/schemas/OAuthTokenGenerateRequestBody' description: "Send the request as x-www-form-urlencoded. Separate scope values\ \ with spaces, not commas." + required: true responses: "200": content: @@ -30325,6 +30461,7 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenIntrospectRequestBody' description: Send the request as x-www-form-urlencoded. + required: true responses: "200": content: @@ -30369,6 +30506,7 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenRevokeRequestBody' description: Send the request as x-www-form-urlencoded. + required: true responses: "204": description: Returns no content if the OAuth 2.0 token is revoked successfully. @@ -30411,6 +30549,7 @@ paths: schema: $ref: '#/components/schemas/ClientQualificationsCheckEligibilityRequestBody' description: Define order and customer context. + required: true responses: "200": content: @@ -30690,6 +30829,7 @@ paths: key: value schema: $ref: '#/components/schemas/ClientRedemptionsRedeemRequestBody' + required: true responses: "200": content: @@ -30797,6 +30937,7 @@ paths: quantity: 1 schema: $ref: '#/components/schemas/ClientValidationsValidateRequestBody' + required: true responses: "200": content: @@ -30862,6 +31003,7 @@ paths: schema: $ref: '#/components/schemas/ClientEventsCreateRequestBody' description: Specify the details of the custom event. + required: true responses: "200": content: @@ -31336,7 +31478,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -31790,7 +31932,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -31851,7 +31993,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -32523,7 +32665,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -32584,7 +32726,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -33126,7 +33268,7 @@ components: CampaignsListResponseBody: description: Schema model for **GET** `v1/campaigns`. example: - total: 7 + total: 1 campaigns: - metadata: "{}" voucher: @@ -33247,7 +33389,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -33308,7 +33450,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -33437,7 +33579,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -33498,7 +33640,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -33693,7 +33835,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -33754,7 +33896,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -34800,7 +34942,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -34838,7 +34980,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -35117,7 +35259,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -35178,7 +35320,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -42435,7 +42577,7 @@ components: title: ClientRedemptionsRedeemResponseBody type: object ClientValidationsValidateRequestBody: - description: Response body schema for **POST** `v1/validations`. + description: Request body schema for **POST** `v1/validations`. example: redeemables: - gift: @@ -45823,7 +45965,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -47772,7 +47914,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -48110,7 +48252,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -48256,7 +48398,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -50731,7 +50873,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -53282,7 +53424,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -58640,7 +58782,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -58886,7 +59028,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -65742,17 +65884,17 @@ components: type: STATIC products: - product_id: product_id - id: prod_0a41bcf807c5fcaaf6 + id: id object: sku - product_id: product_id - id: prod_0a41bcf807c5fcaaf6 + id: id object: sku properties: type: - description: Show that the product collection is static (manually selected - products). enum: - STATIC + - AUTO_UPDATE + nullable: true type: string name: description: Unique user-defined product collection name. @@ -81763,7 +81905,6 @@ components: description: Response body schema for **POST** `v1/segments`. example: filter: "{}" - initial_sync_status: IN_PROGRESS name: name created_at: 2022-05-12T13:01:56.896Z id: seg_1wc52c5z6r1kQ81brO8j9Hk2 @@ -81804,12 +81945,6 @@ components: nullable: true title: SegmentsCreateResponseBodyFilter type: object - initial_sync_status: - enum: - - IN_PROGRESS - - DONE - nullable: true - type: string object: description: The type of the object represented by JSON. This object stores information about the customer segment. @@ -81823,7 +81958,6 @@ components: description: "Response body schema for **GET** `v1/v1/segments/{segmentId}`." example: filter: "{}" - initial_sync_status: IN_PROGRESS name: name created_at: 2022-05-12T13:01:56.896Z id: seg_1wc52c5z6r1kQ81brO8j9Hk2 @@ -81864,12 +81998,6 @@ components: nullable: true title: SegmentsGetResponseBodyFilter type: object - initial_sync_status: - enum: - - IN_PROGRESS - - DONE - nullable: true - type: string object: description: The type of the object represented by JSON. This object stores information about the customer segment. @@ -82323,7 +82451,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -82384,7 +82512,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -85115,7 +85243,7 @@ components: title: ValidationRulesUpdateResponseBody type: object ValidationsValidateRequestBody: - description: Response body schema for **POST** `v1/validations`. + description: Request body schema for **POST** `v1/validations`. example: redeemables: - gift: @@ -91805,7 +91933,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -91866,7 +91994,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -92497,7 +92625,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -92558,7 +92686,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -95483,7 +95611,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -96142,8 +96270,8 @@ components: type: string source: description: "The channel through which the transaction took place, whether\ - \ through the API or the the Dashboard. In case of a redemption, this\ - \ value is null." + \ through the API or the Dashboard. In case of a redemption, this value\ + \ is null." nullable: true type: string reason: @@ -96501,7 +96629,7 @@ components: bucket: $ref: '#/components/schemas/LoyaltyPointsBucketBucket' status: - description: Loyalty point point bucket status. + description: Loyalty point bucket status. nullable: true type: string expires_at: @@ -96718,7 +96846,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD start_date: type: IMMEDIATE @@ -99832,7 +99960,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -107439,7 +107567,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -109001,7 +109129,7 @@ components: expiration_time: 14:00 properties: daily: - description: Defines the reccuring period(s) when the resource is active. + description: Defines the recurring period(s) when the resource is active. The periods should not overlap. items: $ref: '#/components/schemas/ValidityHoursDailyItem' @@ -109670,8 +109798,8 @@ components: type: string source: description: "The channel through which the transaction took place, whether\ - \ through the API or the the Dashboard. In case of a redemption, this\ - \ value is null." + \ through the API or the Dashboard. In case of a redemption, this value\ + \ is null." nullable: true type: string reason: @@ -113071,7 +113199,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -116377,7 +116505,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -130704,12 +130832,6 @@ components: - $ref: '#/components/schemas/Order' - description: Order information. properties: - created_at: - description: Timestamp representing the date and time when the order was - created. The value is shown in the ISO 8601 format. - example: 2021-12-22T10:13:06.487Z - format: date-time - type: string referrer_id: description: Unique referrer ID. example: cust_nM4jqPiaXUvQdVSA6vTRUnix @@ -130742,7 +130864,6 @@ components: metadata: "{}" referrer_id: cust_nM4jqPiaXUvQdVSA6vTRUnix discount_amount: 1 - created_at: 2021-12-22T10:13:06.487Z initial_amount: 6 id: id source_id: source_id @@ -132095,12 +132216,11 @@ components: ProductCollectionsCreateRequestBodyProductsItem: example: product_id: product_id - id: prod_0a41bcf807c5fcaaf6 + id: id object: sku properties: id: description: The product ID. - example: prod_0a41bcf807c5fcaaf6 type: string product_id: description: Product ID for SKUs. @@ -139251,7 +139371,7 @@ components: type: string balance: description: The incremental points to be added to the current balance on - the loyalty card. and The incremental amout to be added to the current + the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. nullable: true @@ -144914,7 +145034,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 properties: type: description: This mechanism describes a custom rounding for the expiration @@ -144958,7 +145078,7 @@ components: unit: MONTH type: MONTH strategy: START - value: 2 + value: 4 type: END_OF_PERIOD nullable: true properties: @@ -147602,7 +147722,7 @@ components: name: name id: ms_Ll9enAm2BCN0M1s4VxWobLFM referee_reward: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -151922,7 +152042,7 @@ components: ReferralProgramRefereeReward: description: Defines the referee reward. example: - amount: amount + amount: 2 related_object_parent: name: name id: camp_kdxp3vf1clQ9CFs1jpqv3tZe @@ -151945,7 +152065,7 @@ components: \ value is multiplied by 100 to precisely represent 2 decimal places.\ \ For example, $100 amount is written as 10000." nullable: true - type: string + type: integer title: ReferralProgramRefereeReward type: object ReferrerAddress: @@ -152343,7 +152463,7 @@ components: title: ValidationsRedeemableSkippedResult type: object ValidityHoursDailyItem: - description: Defines the reccuring period(s) when the resource will be active. + description: Defines the recurring period(s) when the resource will be active. example: days_of_week: - 5 @@ -159520,8 +159640,8 @@ components: type: string source: description: "The channel through which the transaction took place, whether\ - \ through the API or the the Dashboard. In case of a redemption, this\ - \ value is null." + \ through the API or the Dashboard. In case of a redemption, this value\ + \ is null." nullable: true type: string reason: diff --git a/docs/CampaignsApi.md b/docs/CampaignsApi.md index c86a191a..2fdb9527 100644 --- a/docs/CampaignsApi.md +++ b/docs/CampaignsApi.md @@ -21,7 +21,7 @@ All URIs are relative to *https://api.voucherify.io* # **AddVoucherWithSpecificCodeToCampaign** -> CampaignsVouchersCreateResponseBody AddVoucherWithSpecificCodeToCampaign (string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody = null) +> CampaignsVouchersCreateResponseBody AddVoucherWithSpecificCodeToCampaign (string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody) Add Voucher with Specific Code to Campaign @@ -57,7 +57,7 @@ namespace Example var apiInstance = new CampaignsApi(config); var campaignId = "campaignId_example"; // string | The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. var code = "code_example"; // string | A custom **code** that identifies the voucher. - var campaignsVouchersCreateRequestBody = new CampaignsVouchersCreateRequestBody(); // CampaignsVouchersCreateRequestBody | Specify the voucher parameters that you would like to overwrite. (optional) + var campaignsVouchersCreateRequestBody = new CampaignsVouchersCreateRequestBody(); // CampaignsVouchersCreateRequestBody | Specify the voucher parameters that you would like to overwrite. try { @@ -102,7 +102,7 @@ catch (ApiException e) |------|------|-------------|-------| | **campaignId** | **string** | The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. | | | **code** | **string** | A custom **code** that identifies the voucher. | | -| **campaignsVouchersCreateRequestBody** | [**CampaignsVouchersCreateRequestBody**](CampaignsVouchersCreateRequestBody.md) | Specify the voucher parameters that you would like to overwrite. | [optional] | +| **campaignsVouchersCreateRequestBody** | [**CampaignsVouchersCreateRequestBody**](CampaignsVouchersCreateRequestBody.md) | Specify the voucher parameters that you would like to overwrite. | | ### Return type @@ -127,7 +127,7 @@ catch (ApiException e) # **AddVouchersToCampaign** -> CampaignsVouchersCreateCombinedResponseBody AddVouchersToCampaign (string campaignId, int? vouchersCount = null, CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody = null) +> CampaignsVouchersCreateCombinedResponseBody AddVouchersToCampaign (string campaignId, CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody, int? vouchersCount = null) Add Vouchers to Campaign @@ -162,13 +162,13 @@ namespace Example var apiInstance = new CampaignsApi(config); var campaignId = "campaignId_example"; // string | The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + var campaignsVouchersCreateInBulkRequestBody = new CampaignsVouchersCreateInBulkRequestBody(); // CampaignsVouchersCreateInBulkRequestBody | Specify the voucher parameters that you would like to overwrite. var vouchersCount = 56; // int? | Number of vouchers that should be added. (optional) - var campaignsVouchersCreateInBulkRequestBody = new CampaignsVouchersCreateInBulkRequestBody(); // CampaignsVouchersCreateInBulkRequestBody | Specify the voucher parameters that you would like to overwrite. (optional) try { // Add Vouchers to Campaign - CampaignsVouchersCreateCombinedResponseBody result = apiInstance.AddVouchersToCampaign(campaignId, vouchersCount, campaignsVouchersCreateInBulkRequestBody); + CampaignsVouchersCreateCombinedResponseBody result = apiInstance.AddVouchersToCampaign(campaignId, campaignsVouchersCreateInBulkRequestBody, vouchersCount); Debug.WriteLine(result); } catch (ApiException e) @@ -189,7 +189,7 @@ This returns an ApiResponse object which contains the response data, status code try { // Add Vouchers to Campaign - ApiResponse response = apiInstance.AddVouchersToCampaignWithHttpInfo(campaignId, vouchersCount, campaignsVouchersCreateInBulkRequestBody); + ApiResponse response = apiInstance.AddVouchersToCampaignWithHttpInfo(campaignId, campaignsVouchersCreateInBulkRequestBody, vouchersCount); Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Response Headers: " + response.Headers); Debug.Write("Response Body: " + response.Data); @@ -207,8 +207,8 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignId** | **string** | The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. | | +| **campaignsVouchersCreateInBulkRequestBody** | [**CampaignsVouchersCreateInBulkRequestBody**](CampaignsVouchersCreateInBulkRequestBody.md) | Specify the voucher parameters that you would like to overwrite. | | | **vouchersCount** | **int?** | Number of vouchers that should be added. | [optional] | -| **campaignsVouchersCreateInBulkRequestBody** | [**CampaignsVouchersCreateInBulkRequestBody**](CampaignsVouchersCreateInBulkRequestBody.md) | Specify the voucher parameters that you would like to overwrite. | [optional] | ### Return type @@ -233,7 +233,7 @@ catch (ApiException e) # **CreateCampaign** -> CampaignsCreateResponseBody CreateCampaign (CampaignsCreateRequestBody campaignsCreateRequestBody = null) +> CampaignsCreateResponseBody CreateCampaign (CampaignsCreateRequestBody campaignsCreateRequestBody) Create Campaign @@ -267,7 +267,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new CampaignsApi(config); - var campaignsCreateRequestBody = new CampaignsCreateRequestBody(); // CampaignsCreateRequestBody | Specify the details of the campaign that you would like to create. (optional) + var campaignsCreateRequestBody = new CampaignsCreateRequestBody(); // CampaignsCreateRequestBody | Specify the details of the campaign that you would like to create. try { @@ -310,7 +310,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **campaignsCreateRequestBody** | [**CampaignsCreateRequestBody**](CampaignsCreateRequestBody.md) | Specify the details of the campaign that you would like to create. | [optional] | +| **campaignsCreateRequestBody** | [**CampaignsCreateRequestBody**](CampaignsCreateRequestBody.md) | Specify the details of the campaign that you would like to create. | | ### Return type @@ -643,7 +643,7 @@ catch (ApiException e) # **ExportCampaignTransactions** -> CampaignsTransactionsExportCreateResponseBody ExportCampaignTransactions (string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody = null) +> CampaignsTransactionsExportCreateResponseBody ExportCampaignTransactions (string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody) Export Campaign Transactions @@ -678,7 +678,7 @@ namespace Example var apiInstance = new CampaignsApi(config); var campaignId = "campaignId_example"; // string | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - var campaignsTransactionsExportCreateRequestBody = new CampaignsTransactionsExportCreateRequestBody(); // CampaignsTransactionsExportCreateRequestBody | Specify the parameters for the transaction export. (optional) + var campaignsTransactionsExportCreateRequestBody = new CampaignsTransactionsExportCreateRequestBody(); // CampaignsTransactionsExportCreateRequestBody | Specify the parameters for the transaction export. try { @@ -722,7 +722,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignId** | **string** | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. | | -| **campaignsTransactionsExportCreateRequestBody** | [**CampaignsTransactionsExportCreateRequestBody**](CampaignsTransactionsExportCreateRequestBody.md) | Specify the parameters for the transaction export. | [optional] | +| **campaignsTransactionsExportCreateRequestBody** | [**CampaignsTransactionsExportCreateRequestBody**](CampaignsTransactionsExportCreateRequestBody.md) | Specify the parameters for the transaction export. | | ### Return type @@ -955,7 +955,7 @@ catch (ApiException e) # **ImportVouchersToCampaign** -> CampaignsImportCreateResponseBody ImportVouchersToCampaign (string campaignId, List campaignsImportVoucherItem = null) +> CampaignsImportCreateResponseBody ImportVouchersToCampaign (string campaignId, List campaignsImportVoucherItem) Import Vouchers to Campaign @@ -990,7 +990,7 @@ namespace Example var apiInstance = new CampaignsApi(config); var campaignId = "campaignId_example"; // string | The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - var campaignsImportVoucherItem = new List(); // List | Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + var campaignsImportVoucherItem = new List(); // List | Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. try { @@ -1034,7 +1034,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignId** | **string** | The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. | | -| **campaignsImportVoucherItem** | [**List<CampaignsImportVoucherItem>**](CampaignsImportVoucherItem.md) | Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. | [optional] | +| **campaignsImportVoucherItem** | [**List<CampaignsImportVoucherItem>**](CampaignsImportVoucherItem.md) | Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. | | ### Return type @@ -1391,7 +1391,7 @@ catch (ApiException e) # **UpdateCampaign** -> CampaignsUpdateResponseBody UpdateCampaign (string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody = null) +> CampaignsUpdateResponseBody UpdateCampaign (string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody) Update Campaign @@ -1426,7 +1426,7 @@ namespace Example var apiInstance = new CampaignsApi(config); var campaignId = "campaignId_example"; // string | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - var campaignsUpdateRequestBody = new CampaignsUpdateRequestBody(); // CampaignsUpdateRequestBody | Specify the campaign parameters to be updated. (optional) + var campaignsUpdateRequestBody = new CampaignsUpdateRequestBody(); // CampaignsUpdateRequestBody | Specify the campaign parameters to be updated. try { @@ -1470,7 +1470,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignId** | **string** | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. | | -| **campaignsUpdateRequestBody** | [**CampaignsUpdateRequestBody**](CampaignsUpdateRequestBody.md) | Specify the campaign parameters to be updated. | [optional] | +| **campaignsUpdateRequestBody** | [**CampaignsUpdateRequestBody**](CampaignsUpdateRequestBody.md) | Specify the campaign parameters to be updated. | | ### Return type diff --git a/docs/CategoriesApi.md b/docs/CategoriesApi.md index 01ec7102..54499046 100644 --- a/docs/CategoriesApi.md +++ b/docs/CategoriesApi.md @@ -12,7 +12,7 @@ All URIs are relative to *https://api.voucherify.io* # **CreateCategory** -> CategoriesCreateResponseBody CreateCategory (CategoriesCreateRequestBody categoriesCreateRequestBody = null) +> CategoriesCreateResponseBody CreateCategory (CategoriesCreateRequestBody categoriesCreateRequestBody) Create Category @@ -46,7 +46,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new CategoriesApi(config); - var categoriesCreateRequestBody = new CategoriesCreateRequestBody(); // CategoriesCreateRequestBody | Specify the details of the category that you would like to create. (optional) + var categoriesCreateRequestBody = new CategoriesCreateRequestBody(); // CategoriesCreateRequestBody | Specify the details of the category that you would like to create. try { @@ -89,7 +89,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **categoriesCreateRequestBody** | [**CategoriesCreateRequestBody**](CategoriesCreateRequestBody.md) | Specify the details of the category that you would like to create. | [optional] | +| **categoriesCreateRequestBody** | [**CategoriesCreateRequestBody**](CategoriesCreateRequestBody.md) | Specify the details of the category that you would like to create. | | ### Return type @@ -411,7 +411,7 @@ This endpoint does not need any parameter. # **UpdateCategory** -> CategoriesUpdateResponseBody UpdateCategory (string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody = null) +> CategoriesUpdateResponseBody UpdateCategory (string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody) Update Category @@ -446,7 +446,7 @@ namespace Example var apiInstance = new CategoriesApi(config); var categoryId = "categoryId_example"; // string | Unique category ID assigned by Voucherify. - var categoriesUpdateRequestBody = new CategoriesUpdateRequestBody(); // CategoriesUpdateRequestBody | Specify the details of the category that you would like to update. (optional) + var categoriesUpdateRequestBody = new CategoriesUpdateRequestBody(); // CategoriesUpdateRequestBody | Specify the details of the category that you would like to update. try { @@ -490,7 +490,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **categoryId** | **string** | Unique category ID assigned by Voucherify. | | -| **categoriesUpdateRequestBody** | [**CategoriesUpdateRequestBody**](CategoriesUpdateRequestBody.md) | Specify the details of the category that you would like to update. | [optional] | +| **categoriesUpdateRequestBody** | [**CategoriesUpdateRequestBody**](CategoriesUpdateRequestBody.md) | Specify the details of the category that you would like to update. | | ### Return type diff --git a/docs/ClientSideApi.md b/docs/ClientSideApi.md index 7e7d0e0b..ea9a82c1 100644 --- a/docs/ClientSideApi.md +++ b/docs/ClientSideApi.md @@ -12,7 +12,7 @@ All URIs are relative to *https://api.voucherify.io* # **CheckEligibilityClientSide** -> ClientQualificationsCheckEligibilityResponseBody CheckEligibilityClientSide (ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody = null) +> ClientQualificationsCheckEligibilityResponseBody CheckEligibilityClientSide (ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody) Check Eligibility (client-side) @@ -46,7 +46,7 @@ namespace Example // config.AddApiKeyPrefix("X-Client-Token", "Bearer"); var apiInstance = new ClientSideApi(config); - var clientQualificationsCheckEligibilityRequestBody = new ClientQualificationsCheckEligibilityRequestBody(); // ClientQualificationsCheckEligibilityRequestBody | Define order and customer context. (optional) + var clientQualificationsCheckEligibilityRequestBody = new ClientQualificationsCheckEligibilityRequestBody(); // ClientQualificationsCheckEligibilityRequestBody | Define order and customer context. try { @@ -89,7 +89,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **clientQualificationsCheckEligibilityRequestBody** | [**ClientQualificationsCheckEligibilityRequestBody**](ClientQualificationsCheckEligibilityRequestBody.md) | Define order and customer context. | [optional] | +| **clientQualificationsCheckEligibilityRequestBody** | [**ClientQualificationsCheckEligibilityRequestBody**](ClientQualificationsCheckEligibilityRequestBody.md) | Define order and customer context. | | ### Return type @@ -224,7 +224,7 @@ catch (ApiException e) # **RedeemStackedDiscountsClientSide** -> ClientRedemptionsRedeemResponseBody RedeemStackedDiscountsClientSide (string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody = null) +> ClientRedemptionsRedeemResponseBody RedeemStackedDiscountsClientSide (string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody) Redeem Stackable Discounts (client-side) @@ -259,7 +259,7 @@ namespace Example var apiInstance = new ClientSideApi(config); var origin = "origin_example"; // string | Indicates the origin (scheme, hostname, and port). - var clientRedemptionsRedeemRequestBody = new ClientRedemptionsRedeemRequestBody(); // ClientRedemptionsRedeemRequestBody | (optional) + var clientRedemptionsRedeemRequestBody = new ClientRedemptionsRedeemRequestBody(); // ClientRedemptionsRedeemRequestBody | try { @@ -303,7 +303,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **origin** | **string** | Indicates the origin (scheme, hostname, and port). | | -| **clientRedemptionsRedeemRequestBody** | [**ClientRedemptionsRedeemRequestBody**](ClientRedemptionsRedeemRequestBody.md) | | [optional] | +| **clientRedemptionsRedeemRequestBody** | [**ClientRedemptionsRedeemRequestBody**](ClientRedemptionsRedeemRequestBody.md) | | | ### Return type @@ -328,7 +328,7 @@ catch (ApiException e) # **TrackCustomEventClientSide** -> ClientEventsCreateResponseBody TrackCustomEventClientSide (string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody = null) +> ClientEventsCreateResponseBody TrackCustomEventClientSide (string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody) Track Custom Event (client-side) @@ -363,7 +363,7 @@ namespace Example var apiInstance = new ClientSideApi(config); var origin = "origin_example"; // string | Indicates the origin (scheme, hostname, and port). - var clientEventsCreateRequestBody = new ClientEventsCreateRequestBody(); // ClientEventsCreateRequestBody | Specify the details of the custom event. (optional) + var clientEventsCreateRequestBody = new ClientEventsCreateRequestBody(); // ClientEventsCreateRequestBody | Specify the details of the custom event. try { @@ -407,7 +407,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **origin** | **string** | Indicates the origin (scheme, hostname, and port). | | -| **clientEventsCreateRequestBody** | [**ClientEventsCreateRequestBody**](ClientEventsCreateRequestBody.md) | Specify the details of the custom event. | [optional] | +| **clientEventsCreateRequestBody** | [**ClientEventsCreateRequestBody**](ClientEventsCreateRequestBody.md) | Specify the details of the custom event. | | ### Return type @@ -432,7 +432,7 @@ catch (ApiException e) # **ValidateStackedDiscountsClientSide** -> ClientValidationsValidateResponseBody ValidateStackedDiscountsClientSide (string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody = null) +> ClientValidationsValidateResponseBody ValidateStackedDiscountsClientSide (string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody) Validate Stackable Discounts (client-side) @@ -467,7 +467,7 @@ namespace Example var apiInstance = new ClientSideApi(config); var origin = "origin_example"; // string | Indicates the origin (scheme, hostname, and port). - var clientValidationsValidateRequestBody = new ClientValidationsValidateRequestBody(); // ClientValidationsValidateRequestBody | (optional) + var clientValidationsValidateRequestBody = new ClientValidationsValidateRequestBody(); // ClientValidationsValidateRequestBody | try { @@ -511,7 +511,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **origin** | **string** | Indicates the origin (scheme, hostname, and port). | | -| **clientValidationsValidateRequestBody** | [**ClientValidationsValidateRequestBody**](ClientValidationsValidateRequestBody.md) | | [optional] | +| **clientValidationsValidateRequestBody** | [**ClientValidationsValidateRequestBody**](ClientValidationsValidateRequestBody.md) | | | ### Return type diff --git a/docs/ClientValidationsValidateRequestBody.md b/docs/ClientValidationsValidateRequestBody.md index 0b0d2f8a..54aa4693 100644 --- a/docs/ClientValidationsValidateRequestBody.md +++ b/docs/ClientValidationsValidateRequestBody.md @@ -1,5 +1,5 @@ # Voucherify.Model.ClientValidationsValidateRequestBody -Response body schema for **POST** `v1/validations`. +Request body schema for **POST** `v1/validations`. ## Properties diff --git a/docs/CustomersApi.md b/docs/CustomersApi.md index f7048ef8..0ba8db51 100644 --- a/docs/CustomersApi.md +++ b/docs/CustomersApi.md @@ -19,7 +19,7 @@ All URIs are relative to *https://api.voucherify.io* # **CreateCustomer** -> CustomersCreateResponseBody CreateCustomer (CustomersCreateRequestBody customersCreateRequestBody = null) +> CustomersCreateResponseBody CreateCustomer (CustomersCreateRequestBody customersCreateRequestBody) Create Customer @@ -53,7 +53,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new CustomersApi(config); - var customersCreateRequestBody = new CustomersCreateRequestBody(); // CustomersCreateRequestBody | Create a customer with specified parameters. (optional) + var customersCreateRequestBody = new CustomersCreateRequestBody(); // CustomersCreateRequestBody | Create a customer with specified parameters. try { @@ -96,7 +96,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **customersCreateRequestBody** | [**CustomersCreateRequestBody**](CustomersCreateRequestBody.md) | Create a customer with specified parameters. | [optional] | +| **customersCreateRequestBody** | [**CustomersCreateRequestBody**](CustomersCreateRequestBody.md) | Create a customer with specified parameters. | | ### Return type @@ -981,7 +981,7 @@ catch (ApiException e) # **UpdateCustomer** -> CustomersUpdateResponseBody UpdateCustomer (string customerId, CustomersUpdateRequestBody customersUpdateRequestBody = null) +> CustomersUpdateResponseBody UpdateCustomer (string customerId, CustomersUpdateRequestBody customersUpdateRequestBody) Update Customer @@ -1016,7 +1016,7 @@ namespace Example var apiInstance = new CustomersApi(config); var customerId = "customerId_example"; // string | A Voucherify customers id or source_id. - var customersUpdateRequestBody = new CustomersUpdateRequestBody(); // CustomersUpdateRequestBody | Specify the parameters to be updated. (optional) + var customersUpdateRequestBody = new CustomersUpdateRequestBody(); // CustomersUpdateRequestBody | Specify the parameters to be updated. try { @@ -1060,7 +1060,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **customerId** | **string** | A Voucherify customers id or source_id. | | -| **customersUpdateRequestBody** | [**CustomersUpdateRequestBody**](CustomersUpdateRequestBody.md) | Specify the parameters to be updated. | [optional] | +| **customersUpdateRequestBody** | [**CustomersUpdateRequestBody**](CustomersUpdateRequestBody.md) | Specify the parameters to be updated. | | ### Return type @@ -1085,7 +1085,7 @@ catch (ApiException e) # **UpdateCustomersInBulk** -> CustomersUpdateInBulkResponseBody UpdateCustomersInBulk (List customersUpdateInBulkRequestBody = null) +> CustomersUpdateInBulkResponseBody UpdateCustomersInBulk (List customersUpdateInBulkRequestBody) Update Customers in Bulk @@ -1119,7 +1119,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new CustomersApi(config); - var customersUpdateInBulkRequestBody = new List(); // List | List the customer fields to be updated in each customer object. (optional) + var customersUpdateInBulkRequestBody = new List(); // List | List the customer fields to be updated in each customer object. try { @@ -1162,7 +1162,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **customersUpdateInBulkRequestBody** | [**List<CustomersUpdateInBulkRequestBody>**](CustomersUpdateInBulkRequestBody.md) | List the customer fields to be updated in each customer object. | [optional] | +| **customersUpdateInBulkRequestBody** | [**List<CustomersUpdateInBulkRequestBody>**](CustomersUpdateInBulkRequestBody.md) | List the customer fields to be updated in each customer object. | | ### Return type @@ -1187,7 +1187,7 @@ catch (ApiException e) # **UpdateCustomersMetadataInBulk** -> CustomersMetadataUpdateInBulkResponseBody UpdateCustomersMetadataInBulk (CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody = null) +> CustomersMetadataUpdateInBulkResponseBody UpdateCustomersMetadataInBulk (CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody) Update Customers' Metadata in Bulk @@ -1221,7 +1221,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new CustomersApi(config); - var customersMetadataUpdateInBulkRequestBody = new CustomersMetadataUpdateInBulkRequestBody(); // CustomersMetadataUpdateInBulkRequestBody | List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + var customersMetadataUpdateInBulkRequestBody = new CustomersMetadataUpdateInBulkRequestBody(); // CustomersMetadataUpdateInBulkRequestBody | List the source_ids of the customers you would like to update with the metadata key/value pairs. try { @@ -1264,7 +1264,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **customersMetadataUpdateInBulkRequestBody** | [**CustomersMetadataUpdateInBulkRequestBody**](CustomersMetadataUpdateInBulkRequestBody.md) | List the source_ids of the customers you would like to update with the metadata key/value pairs. | [optional] | +| **customersMetadataUpdateInBulkRequestBody** | [**CustomersMetadataUpdateInBulkRequestBody**](CustomersMetadataUpdateInBulkRequestBody.md) | List the source_ids of the customers you would like to update with the metadata key/value pairs. | | ### Return type diff --git a/docs/EventsApi.md b/docs/EventsApi.md index f7036c82..a266c04f 100644 --- a/docs/EventsApi.md +++ b/docs/EventsApi.md @@ -8,7 +8,7 @@ All URIs are relative to *https://api.voucherify.io* # **TrackCustomEvent** -> EventsCreateResponseBody TrackCustomEvent (EventsCreateRequestBody eventsCreateRequestBody = null) +> EventsCreateResponseBody TrackCustomEvent (EventsCreateRequestBody eventsCreateRequestBody) Track Custom Event @@ -42,7 +42,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new EventsApi(config); - var eventsCreateRequestBody = new EventsCreateRequestBody(); // EventsCreateRequestBody | Specify the details of the custom event. (optional) + var eventsCreateRequestBody = new EventsCreateRequestBody(); // EventsCreateRequestBody | Specify the details of the custom event. try { @@ -85,7 +85,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **eventsCreateRequestBody** | [**EventsCreateRequestBody**](EventsCreateRequestBody.md) | Specify the details of the custom event. | [optional] | +| **eventsCreateRequestBody** | [**EventsCreateRequestBody**](EventsCreateRequestBody.md) | Specify the details of the custom event. | | ### Return type diff --git a/docs/ExportsApi.md b/docs/ExportsApi.md index 70b655a4..64baba77 100644 --- a/docs/ExportsApi.md +++ b/docs/ExportsApi.md @@ -12,7 +12,7 @@ All URIs are relative to *https://api.voucherify.io* # **CreateExport** -> ExportsCreateResponseBody CreateExport (ExportsCreateRequestBody exportsCreateRequestBody = null) +> ExportsCreateResponseBody CreateExport (ExportsCreateRequestBody exportsCreateRequestBody) Create Export @@ -46,7 +46,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new ExportsApi(config); - var exportsCreateRequestBody = new ExportsCreateRequestBody(); // ExportsCreateRequestBody | Specify the details of the export that you would like to create. (optional) + var exportsCreateRequestBody = new ExportsCreateRequestBody(); // ExportsCreateRequestBody | Specify the details of the export that you would like to create. try { @@ -89,7 +89,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **exportsCreateRequestBody** | [**ExportsCreateRequestBody**](ExportsCreateRequestBody.md) | Specify the details of the export that you would like to create. | [optional] | +| **exportsCreateRequestBody** | [**ExportsCreateRequestBody**](ExportsCreateRequestBody.md) | Specify the details of the export that you would like to create. | | ### Return type diff --git a/docs/LoyaltiesApi.md b/docs/LoyaltiesApi.md index 706bad03..fea8ada0 100644 --- a/docs/LoyaltiesApi.md +++ b/docs/LoyaltiesApi.md @@ -163,7 +163,7 @@ catch (ApiException e) # **AddMember** -> LoyaltiesMembersCreateResponseBody AddMember (string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody = null) +> LoyaltiesMembersCreateResponseBody AddMember (string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody) Add Member @@ -198,7 +198,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var campaignId = "campaignId_example"; // string | Unique campaign ID of the loyalty program. - var loyaltiesMembersCreateRequestBody = new LoyaltiesMembersCreateRequestBody(); // LoyaltiesMembersCreateRequestBody | Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + var loyaltiesMembersCreateRequestBody = new LoyaltiesMembersCreateRequestBody(); // LoyaltiesMembersCreateRequestBody | Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. try { @@ -242,7 +242,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignId** | **string** | Unique campaign ID of the loyalty program. | | -| **loyaltiesMembersCreateRequestBody** | [**LoyaltiesMembersCreateRequestBody**](LoyaltiesMembersCreateRequestBody.md) | Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. | [optional] | +| **loyaltiesMembersCreateRequestBody** | [**LoyaltiesMembersCreateRequestBody**](LoyaltiesMembersCreateRequestBody.md) | Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. | | ### Return type @@ -267,7 +267,7 @@ catch (ApiException e) # **AdjustMemberPendingPoints** -> LoyaltiesMembersPendingPointsBalanceResponseBody AdjustMemberPendingPoints (string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody = null) +> LoyaltiesMembersPendingPointsBalanceResponseBody AdjustMemberPendingPoints (string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody) Adjust Member Pending Points @@ -303,7 +303,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var memberId = "memberId_example"; // string | Unique loyalty card code assigned to a particular customer. var pendingPointsId = "pendingPointsId_example"; // string | Unique pending point identifier, assigned by Voucherify. - var loyaltiesMembersPendingPointsBalanceRequestBody = new LoyaltiesMembersPendingPointsBalanceRequestBody(); // LoyaltiesMembersPendingPointsBalanceRequestBody | Define the number of pending points to be added or subtracted. (optional) + var loyaltiesMembersPendingPointsBalanceRequestBody = new LoyaltiesMembersPendingPointsBalanceRequestBody(); // LoyaltiesMembersPendingPointsBalanceRequestBody | Define the number of pending points to be added or subtracted. try { @@ -348,7 +348,7 @@ catch (ApiException e) |------|------|-------------|-------| | **memberId** | **string** | Unique loyalty card code assigned to a particular customer. | | | **pendingPointsId** | **string** | Unique pending point identifier, assigned by Voucherify. | | -| **loyaltiesMembersPendingPointsBalanceRequestBody** | [**LoyaltiesMembersPendingPointsBalanceRequestBody**](LoyaltiesMembersPendingPointsBalanceRequestBody.md) | Define the number of pending points to be added or subtracted. | [optional] | +| **loyaltiesMembersPendingPointsBalanceRequestBody** | [**LoyaltiesMembersPendingPointsBalanceRequestBody**](LoyaltiesMembersPendingPointsBalanceRequestBody.md) | Define the number of pending points to be added or subtracted. | | ### Return type @@ -473,7 +473,7 @@ void (empty response body) # **CreateEarningRule** -> List<LoyaltiesEarningRulesCreateResponseBody> CreateEarningRule (string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem = null) +> List<LoyaltiesEarningRulesCreateResponseBody> CreateEarningRule (string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem) Create Earning Rule @@ -508,7 +508,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var campaignId = "campaignId_example"; // string | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - var loyaltiesEarningRulesCreateRequestBodyItem = new List(); // List | Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + var loyaltiesEarningRulesCreateRequestBodyItem = new List(); // List | Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object try { @@ -552,7 +552,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignId** | **string** | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. | | -| **loyaltiesEarningRulesCreateRequestBodyItem** | [**List<LoyaltiesEarningRulesCreateRequestBodyItem>**](LoyaltiesEarningRulesCreateRequestBodyItem.md) | Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object | [optional] | +| **loyaltiesEarningRulesCreateRequestBodyItem** | [**List<LoyaltiesEarningRulesCreateRequestBodyItem>**](LoyaltiesEarningRulesCreateRequestBodyItem.md) | Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object | | ### Return type @@ -577,7 +577,7 @@ catch (ApiException e) # **CreateInBulkLoyaltyTiers** -> List<LoyaltyTier> CreateInBulkLoyaltyTiers (string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem = null) +> List<LoyaltyTier> CreateInBulkLoyaltyTiers (string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem) Create loyalty tiers @@ -612,7 +612,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var campaignId = "campaignId_example"; // string | Unique loyalty campaign ID or name. - var loyaltiesTiersCreateInBulkRequestBodyItem = new List(); // List | Provide tier definitions you want to add to existing loyalty campaign. (optional) + var loyaltiesTiersCreateInBulkRequestBodyItem = new List(); // List | Provide tier definitions you want to add to existing loyalty campaign. try { @@ -656,7 +656,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignId** | **string** | Unique loyalty campaign ID or name. | | -| **loyaltiesTiersCreateInBulkRequestBodyItem** | [**List<LoyaltiesTiersCreateInBulkRequestBodyItem>**](LoyaltiesTiersCreateInBulkRequestBodyItem.md) | Provide tier definitions you want to add to existing loyalty campaign. | [optional] | +| **loyaltiesTiersCreateInBulkRequestBodyItem** | [**List<LoyaltiesTiersCreateInBulkRequestBodyItem>**](LoyaltiesTiersCreateInBulkRequestBodyItem.md) | Provide tier definitions you want to add to existing loyalty campaign. | | ### Return type @@ -681,7 +681,7 @@ catch (ApiException e) # **CreateLoyaltyProgram** -> LoyaltiesCreateCampaignResponseBody CreateLoyaltyProgram (LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody = null) +> LoyaltiesCreateCampaignResponseBody CreateLoyaltyProgram (LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody) Create Loyalty Campaign @@ -715,7 +715,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new LoyaltiesApi(config); - var loyaltiesCreateCampaignRequestBody = new LoyaltiesCreateCampaignRequestBody(); // LoyaltiesCreateCampaignRequestBody | Specify the loyalty campaign details. (optional) + var loyaltiesCreateCampaignRequestBody = new LoyaltiesCreateCampaignRequestBody(); // LoyaltiesCreateCampaignRequestBody | Specify the loyalty campaign details. try { @@ -758,7 +758,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **loyaltiesCreateCampaignRequestBody** | [**LoyaltiesCreateCampaignRequestBody**](LoyaltiesCreateCampaignRequestBody.md) | Specify the loyalty campaign details. | [optional] | +| **loyaltiesCreateCampaignRequestBody** | [**LoyaltiesCreateCampaignRequestBody**](LoyaltiesCreateCampaignRequestBody.md) | Specify the loyalty campaign details. | | ### Return type @@ -783,7 +783,7 @@ catch (ApiException e) # **CreatePointsExpirationExport** -> LoyaltiesPointsExpirationExportCreateResponseBody CreatePointsExpirationExport (string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody = null) +> LoyaltiesPointsExpirationExportCreateResponseBody CreatePointsExpirationExport (string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody) Export Loyalty Campaign Point Expiration @@ -818,7 +818,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var campaignId = "campaignId_example"; // string | Unique campaign ID or name. - var loyaltiesPointsExpirationExportCreateRequestBody = new LoyaltiesPointsExpirationExportCreateRequestBody(); // LoyaltiesPointsExpirationExportCreateRequestBody | Specify the data filters, types of data to return and order in which the results should be returned. (optional) + var loyaltiesPointsExpirationExportCreateRequestBody = new LoyaltiesPointsExpirationExportCreateRequestBody(); // LoyaltiesPointsExpirationExportCreateRequestBody | Specify the data filters, types of data to return and order in which the results should be returned. try { @@ -862,7 +862,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignId** | **string** | Unique campaign ID or name. | | -| **loyaltiesPointsExpirationExportCreateRequestBody** | [**LoyaltiesPointsExpirationExportCreateRequestBody**](LoyaltiesPointsExpirationExportCreateRequestBody.md) | Specify the data filters, types of data to return and order in which the results should be returned. | [optional] | +| **loyaltiesPointsExpirationExportCreateRequestBody** | [**LoyaltiesPointsExpirationExportCreateRequestBody**](LoyaltiesPointsExpirationExportCreateRequestBody.md) | Specify the data filters, types of data to return and order in which the results should be returned. | | ### Return type @@ -887,7 +887,7 @@ catch (ApiException e) # **CreateRewardAssignment1** -> LoyaltiesRewardsCreateAssignmentResponseBody CreateRewardAssignment1 (string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody = null) +> LoyaltiesRewardsCreateAssignmentResponseBody CreateRewardAssignment1 (string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody) Create Loyalty Campaign Reward Assignment @@ -922,7 +922,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var campaignId = "campaignId_example"; // string | Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - var loyaltiesRewardsCreateAssignmentItemRequestBody = new List(); // List | Define the cost of the rewards in loyalty points. (optional) + var loyaltiesRewardsCreateAssignmentItemRequestBody = new List(); // List | Define the cost of the rewards in loyalty points. try { @@ -966,7 +966,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignId** | **string** | Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. | | -| **loyaltiesRewardsCreateAssignmentItemRequestBody** | [**List<LoyaltiesRewardsCreateAssignmentItemRequestBody>**](LoyaltiesRewardsCreateAssignmentItemRequestBody.md) | Define the cost of the rewards in loyalty points. | [optional] | +| **loyaltiesRewardsCreateAssignmentItemRequestBody** | [**List<LoyaltiesRewardsCreateAssignmentItemRequestBody>**](LoyaltiesRewardsCreateAssignmentItemRequestBody.md) | Define the cost of the rewards in loyalty points. | | ### Return type @@ -1503,7 +1503,7 @@ catch (ApiException e) # **ExportLoyaltyCampaignTransactions** -> CampaignsTransactionsExportCreateResponseBody ExportLoyaltyCampaignTransactions (string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody = null) +> CampaignsTransactionsExportCreateResponseBody ExportLoyaltyCampaignTransactions (string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody) Export Loyalty Campaign Transactions @@ -1538,7 +1538,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var campaignId = "campaignId_example"; // string | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - var loyaltiesTransactionsExportCreateRequestBody = new LoyaltiesTransactionsExportCreateRequestBody(); // LoyaltiesTransactionsExportCreateRequestBody | Specify the parameters for the transaction export. (optional) + var loyaltiesTransactionsExportCreateRequestBody = new LoyaltiesTransactionsExportCreateRequestBody(); // LoyaltiesTransactionsExportCreateRequestBody | Specify the parameters for the transaction export. try { @@ -1582,7 +1582,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignId** | **string** | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. | | -| **loyaltiesTransactionsExportCreateRequestBody** | [**LoyaltiesTransactionsExportCreateRequestBody**](LoyaltiesTransactionsExportCreateRequestBody.md) | Specify the parameters for the transaction export. | [optional] | +| **loyaltiesTransactionsExportCreateRequestBody** | [**LoyaltiesTransactionsExportCreateRequestBody**](LoyaltiesTransactionsExportCreateRequestBody.md) | Specify the parameters for the transaction export. | | ### Return type @@ -1607,7 +1607,7 @@ catch (ApiException e) # **ExportLoyaltyCardTransactions** -> LoyaltiesMembersTransactionsExportCreateResponseBody ExportLoyaltyCardTransactions (string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = null) +> LoyaltiesMembersTransactionsExportCreateResponseBody ExportLoyaltyCardTransactions (string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody) Export Loyalty Card Transactions @@ -1642,7 +1642,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var memberId = "memberId_example"; // string | A unique code identifying the loyalty card that you are looking to export transaction data for. - var loyaltiesMembersTransactionsExportCreateRequestBody = new LoyaltiesMembersTransactionsExportCreateRequestBody(); // LoyaltiesMembersTransactionsExportCreateRequestBody | Specify the parameters and filters for the transaction export. (optional) + var loyaltiesMembersTransactionsExportCreateRequestBody = new LoyaltiesMembersTransactionsExportCreateRequestBody(); // LoyaltiesMembersTransactionsExportCreateRequestBody | Specify the parameters and filters for the transaction export. try { @@ -1686,7 +1686,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **memberId** | **string** | A unique code identifying the loyalty card that you are looking to export transaction data for. | | -| **loyaltiesMembersTransactionsExportCreateRequestBody** | [**LoyaltiesMembersTransactionsExportCreateRequestBody**](LoyaltiesMembersTransactionsExportCreateRequestBody.md) | Specify the parameters and filters for the transaction export. | [optional] | +| **loyaltiesMembersTransactionsExportCreateRequestBody** | [**LoyaltiesMembersTransactionsExportCreateRequestBody**](LoyaltiesMembersTransactionsExportCreateRequestBody.md) | Specify the parameters and filters for the transaction export. | | ### Return type @@ -1711,7 +1711,7 @@ catch (ApiException e) # **ExportLoyaltyCardTransactions1** -> LoyaltiesMembersTransactionsExportCreateResponseBody ExportLoyaltyCardTransactions1 (string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = null) +> LoyaltiesMembersTransactionsExportCreateResponseBody ExportLoyaltyCardTransactions1 (string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody) Export Loyalty Card Transactions with campaign ID @@ -1747,7 +1747,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var campaignId = "campaignId_example"; // string | A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. var memberId = "memberId_example"; // string | A unique code identifying the loyalty card that you are looking to export transaction data for. - var loyaltiesMembersTransactionsExportCreateRequestBody = new LoyaltiesMembersTransactionsExportCreateRequestBody(); // LoyaltiesMembersTransactionsExportCreateRequestBody | Specify the parameters and filters for the transaction export. (optional) + var loyaltiesMembersTransactionsExportCreateRequestBody = new LoyaltiesMembersTransactionsExportCreateRequestBody(); // LoyaltiesMembersTransactionsExportCreateRequestBody | Specify the parameters and filters for the transaction export. try { @@ -1792,7 +1792,7 @@ catch (ApiException e) |------|------|-------------|-------| | **campaignId** | **string** | A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. | | | **memberId** | **string** | A unique code identifying the loyalty card that you are looking to export transaction data for. | | -| **loyaltiesMembersTransactionsExportCreateRequestBody** | [**LoyaltiesMembersTransactionsExportCreateRequestBody**](LoyaltiesMembersTransactionsExportCreateRequestBody.md) | Specify the parameters and filters for the transaction export. | [optional] | +| **loyaltiesMembersTransactionsExportCreateRequestBody** | [**LoyaltiesMembersTransactionsExportCreateRequestBody**](LoyaltiesMembersTransactionsExportCreateRequestBody.md) | Specify the parameters and filters for the transaction export. | | ### Return type @@ -4703,7 +4703,7 @@ catch (ApiException e) # **RedeemReward** -> LoyaltiesMembersRedemptionRedeemResponseBody RedeemReward (string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = null) +> LoyaltiesMembersRedemptionRedeemResponseBody RedeemReward (string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody) Redeem Reward @@ -4738,7 +4738,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var memberId = "memberId_example"; // string | Unique loyalty card assigned to a particular customer. - var loyaltiesMembersRedemptionRedeemRequestBody = new LoyaltiesMembersRedemptionRedeemRequestBody(); // LoyaltiesMembersRedemptionRedeemRequestBody | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + var loyaltiesMembersRedemptionRedeemRequestBody = new LoyaltiesMembersRedemptionRedeemRequestBody(); // LoyaltiesMembersRedemptionRedeemRequestBody | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. try { @@ -4782,7 +4782,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **memberId** | **string** | Unique loyalty card assigned to a particular customer. | | -| **loyaltiesMembersRedemptionRedeemRequestBody** | [**LoyaltiesMembersRedemptionRedeemRequestBody**](LoyaltiesMembersRedemptionRedeemRequestBody.md) | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. | [optional] | +| **loyaltiesMembersRedemptionRedeemRequestBody** | [**LoyaltiesMembersRedemptionRedeemRequestBody**](LoyaltiesMembersRedemptionRedeemRequestBody.md) | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. | | ### Return type @@ -4807,7 +4807,7 @@ catch (ApiException e) # **RedeemReward1** -> LoyaltiesMembersRedemptionRedeemResponseBody RedeemReward1 (string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = null) +> LoyaltiesMembersRedemptionRedeemResponseBody RedeemReward1 (string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody) Redeem Reward with campaign ID @@ -4843,7 +4843,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var campaignId = "campaignId_example"; // string | Unique campaign ID. var memberId = "memberId_example"; // string | A code that identifies the loyalty card. - var loyaltiesMembersRedemptionRedeemRequestBody = new LoyaltiesMembersRedemptionRedeemRequestBody(); // LoyaltiesMembersRedemptionRedeemRequestBody | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + var loyaltiesMembersRedemptionRedeemRequestBody = new LoyaltiesMembersRedemptionRedeemRequestBody(); // LoyaltiesMembersRedemptionRedeemRequestBody | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. try { @@ -4888,7 +4888,7 @@ catch (ApiException e) |------|------|-------------|-------| | **campaignId** | **string** | Unique campaign ID. | | | **memberId** | **string** | A code that identifies the loyalty card. | | -| **loyaltiesMembersRedemptionRedeemRequestBody** | [**LoyaltiesMembersRedemptionRedeemRequestBody**](LoyaltiesMembersRedemptionRedeemRequestBody.md) | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. | [optional] | +| **loyaltiesMembersRedemptionRedeemRequestBody** | [**LoyaltiesMembersRedemptionRedeemRequestBody**](LoyaltiesMembersRedemptionRedeemRequestBody.md) | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. | | ### Return type @@ -4913,7 +4913,7 @@ catch (ApiException e) # **TransferPoints** -> LoyaltiesMembersTransfersCreateResponseBody TransferPoints (string campaignId, string memberId, List loyaltiesTransferPoints = null) +> LoyaltiesMembersTransfersCreateResponseBody TransferPoints (string campaignId, string memberId, List loyaltiesTransferPoints) Transfer Loyalty Points @@ -4949,7 +4949,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var campaignId = "campaignId_example"; // string | A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). var memberId = "memberId_example"; // string | A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - var loyaltiesTransferPoints = new List(); // List | Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + var loyaltiesTransferPoints = new List(); // List | Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. try { @@ -4994,7 +4994,7 @@ catch (ApiException e) |------|------|-------------|-------| | **campaignId** | **string** | A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). | | | **memberId** | **string** | A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). | | -| **loyaltiesTransferPoints** | [**List<LoyaltiesTransferPoints>**](LoyaltiesTransferPoints.md) | Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. | [optional] | +| **loyaltiesTransferPoints** | [**List<LoyaltiesTransferPoints>**](LoyaltiesTransferPoints.md) | Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. | | ### Return type @@ -5019,7 +5019,7 @@ catch (ApiException e) # **UpdateEarningRule** -> LoyaltiesEarningRulesUpdateResponseBody UpdateEarningRule (string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody = null) +> LoyaltiesEarningRulesUpdateResponseBody UpdateEarningRule (string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody) Update Earning Rule @@ -5055,7 +5055,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var campaignId = "campaignId_example"; // string | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. var earningRuleId = "earningRuleId_example"; // string | A unique earning rule ID. - var loyaltiesEarningRulesUpdateRequestBody = new LoyaltiesEarningRulesUpdateRequestBody(); // LoyaltiesEarningRulesUpdateRequestBody | Specify the parameters that you would like to update for the given earning rule. (optional) + var loyaltiesEarningRulesUpdateRequestBody = new LoyaltiesEarningRulesUpdateRequestBody(); // LoyaltiesEarningRulesUpdateRequestBody | Specify the parameters that you would like to update for the given earning rule. try { @@ -5100,7 +5100,7 @@ catch (ApiException e) |------|------|-------------|-------| | **campaignId** | **string** | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. | | | **earningRuleId** | **string** | A unique earning rule ID. | | -| **loyaltiesEarningRulesUpdateRequestBody** | [**LoyaltiesEarningRulesUpdateRequestBody**](LoyaltiesEarningRulesUpdateRequestBody.md) | Specify the parameters that you would like to update for the given earning rule. | [optional] | +| **loyaltiesEarningRulesUpdateRequestBody** | [**LoyaltiesEarningRulesUpdateRequestBody**](LoyaltiesEarningRulesUpdateRequestBody.md) | Specify the parameters that you would like to update for the given earning rule. | | ### Return type @@ -5125,7 +5125,7 @@ catch (ApiException e) # **UpdateLoyaltyCardBalance** -> LoyaltiesMembersBalanceUpdateResponseBody UpdateLoyaltyCardBalance (string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = null) +> LoyaltiesMembersBalanceUpdateResponseBody UpdateLoyaltyCardBalance (string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody) Adjust Loyalty Card Balance @@ -5160,7 +5160,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var memberId = "memberId_example"; // string | Unique loyalty card assigned to a particular customer. - var loyaltiesMembersBalanceUpdateRequestBody = new LoyaltiesMembersBalanceUpdateRequestBody(); // LoyaltiesMembersBalanceUpdateRequestBody | Specify the point adjustment along with the expiration mechanism. (optional) + var loyaltiesMembersBalanceUpdateRequestBody = new LoyaltiesMembersBalanceUpdateRequestBody(); // LoyaltiesMembersBalanceUpdateRequestBody | Specify the point adjustment along with the expiration mechanism. try { @@ -5204,7 +5204,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **memberId** | **string** | Unique loyalty card assigned to a particular customer. | | -| **loyaltiesMembersBalanceUpdateRequestBody** | [**LoyaltiesMembersBalanceUpdateRequestBody**](LoyaltiesMembersBalanceUpdateRequestBody.md) | Specify the point adjustment along with the expiration mechanism. | [optional] | +| **loyaltiesMembersBalanceUpdateRequestBody** | [**LoyaltiesMembersBalanceUpdateRequestBody**](LoyaltiesMembersBalanceUpdateRequestBody.md) | Specify the point adjustment along with the expiration mechanism. | | ### Return type @@ -5229,7 +5229,7 @@ catch (ApiException e) # **UpdateLoyaltyCardBalance1** -> LoyaltiesMembersBalanceUpdateResponseBody UpdateLoyaltyCardBalance1 (string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = null) +> LoyaltiesMembersBalanceUpdateResponseBody UpdateLoyaltyCardBalance1 (string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody) Adjust Loyalty Card Balance with campaign ID @@ -5265,7 +5265,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var campaignId = "campaignId_example"; // string | Unique campaign ID. var memberId = "memberId_example"; // string | A code that identifies the loyalty card. - var loyaltiesMembersBalanceUpdateRequestBody = new LoyaltiesMembersBalanceUpdateRequestBody(); // LoyaltiesMembersBalanceUpdateRequestBody | Specify the point adjustment along with the expiration mechanism. (optional) + var loyaltiesMembersBalanceUpdateRequestBody = new LoyaltiesMembersBalanceUpdateRequestBody(); // LoyaltiesMembersBalanceUpdateRequestBody | Specify the point adjustment along with the expiration mechanism. try { @@ -5310,7 +5310,7 @@ catch (ApiException e) |------|------|-------------|-------| | **campaignId** | **string** | Unique campaign ID. | | | **memberId** | **string** | A code that identifies the loyalty card. | | -| **loyaltiesMembersBalanceUpdateRequestBody** | [**LoyaltiesMembersBalanceUpdateRequestBody**](LoyaltiesMembersBalanceUpdateRequestBody.md) | Specify the point adjustment along with the expiration mechanism. | [optional] | +| **loyaltiesMembersBalanceUpdateRequestBody** | [**LoyaltiesMembersBalanceUpdateRequestBody**](LoyaltiesMembersBalanceUpdateRequestBody.md) | Specify the point adjustment along with the expiration mechanism. | | ### Return type @@ -5335,7 +5335,7 @@ catch (ApiException e) # **UpdateLoyaltyProgram** -> LoyaltiesUpdateCampaignResponseBody UpdateLoyaltyProgram (string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody = null) +> LoyaltiesUpdateCampaignResponseBody UpdateLoyaltyProgram (string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody) Update Loyalty Campaign @@ -5370,7 +5370,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var campaignId = "campaignId_example"; // string | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - var loyaltiesUpdateCampaignRequestBody = new LoyaltiesUpdateCampaignRequestBody(); // LoyaltiesUpdateCampaignRequestBody | Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + var loyaltiesUpdateCampaignRequestBody = new LoyaltiesUpdateCampaignRequestBody(); // LoyaltiesUpdateCampaignRequestBody | Specify the new values for the parameters that you would like to update for the given loyalty campaign. try { @@ -5414,7 +5414,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignId** | **string** | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. | | -| **loyaltiesUpdateCampaignRequestBody** | [**LoyaltiesUpdateCampaignRequestBody**](LoyaltiesUpdateCampaignRequestBody.md) | Specify the new values for the parameters that you would like to update for the given loyalty campaign. | [optional] | +| **loyaltiesUpdateCampaignRequestBody** | [**LoyaltiesUpdateCampaignRequestBody**](LoyaltiesUpdateCampaignRequestBody.md) | Specify the new values for the parameters that you would like to update for the given loyalty campaign. | | ### Return type @@ -5439,7 +5439,7 @@ catch (ApiException e) # **UpdateRewardAssignment1** -> LoyaltiesRewardsUpdateAssignmentResponseBody UpdateRewardAssignment1 (string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody = null) +> LoyaltiesRewardsUpdateAssignmentResponseBody UpdateRewardAssignment1 (string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody) Update Campaign Reward Assignment @@ -5475,7 +5475,7 @@ namespace Example var apiInstance = new LoyaltiesApi(config); var campaignId = "campaignId_example"; // string | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. var assignmentId = "assignmentId_example"; // string | A unique reward assignment ID. - var loyaltiesRewardsUpdateAssignmentRequestBody = new LoyaltiesRewardsUpdateAssignmentRequestBody(); // LoyaltiesRewardsUpdateAssignmentRequestBody | Update the points cost for the reward assignment. (optional) + var loyaltiesRewardsUpdateAssignmentRequestBody = new LoyaltiesRewardsUpdateAssignmentRequestBody(); // LoyaltiesRewardsUpdateAssignmentRequestBody | Update the points cost for the reward assignment. try { @@ -5520,7 +5520,7 @@ catch (ApiException e) |------|------|-------------|-------| | **campaignId** | **string** | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. | | | **assignmentId** | **string** | A unique reward assignment ID. | | -| **loyaltiesRewardsUpdateAssignmentRequestBody** | [**LoyaltiesRewardsUpdateAssignmentRequestBody**](LoyaltiesRewardsUpdateAssignmentRequestBody.md) | Update the points cost for the reward assignment. | [optional] | +| **loyaltiesRewardsUpdateAssignmentRequestBody** | [**LoyaltiesRewardsUpdateAssignmentRequestBody**](LoyaltiesRewardsUpdateAssignmentRequestBody.md) | Update the points cost for the reward assignment. | | ### Return type diff --git a/docs/LoyaltyCardTransaction.md b/docs/LoyaltyCardTransaction.md index 5f796ca3..984a79e7 100644 --- a/docs/LoyaltyCardTransaction.md +++ b/docs/LoyaltyCardTransaction.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **SourceId** | **string** | The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null. | [optional] **VoucherId** | **string** | Unique voucher ID. | [optional] **CampaignId** | **string** | Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes. | [optional] -**Source** | **string** | The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. | [optional] +**Source** | **string** | The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. | [optional] **Reason** | **string** | Reason why the transaction occurred. In case of a redemption, this value is null. | [optional] **RelatedTransactionId** | **string** | The related transaction ID on the receiving card. | [optional] **CreatedAt** | **DateTimeOffset?** | Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format. | [optional] diff --git a/docs/LoyaltyPointsBucket.md b/docs/LoyaltyPointsBucket.md index a953d1bd..54264a69 100644 --- a/docs/LoyaltyPointsBucket.md +++ b/docs/LoyaltyPointsBucket.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **VoucherId** | **string** | Unique identifier of the parent loyalty card. | [optional] **CampaignId** | **string** | Unique identifier of the parent campaign. | [optional] **Bucket** | [**LoyaltyPointsBucketBucket**](LoyaltyPointsBucketBucket.md) | | [optional] -**Status** | **string** | Loyalty point point bucket status. | [optional] +**Status** | **string** | Loyalty point bucket status. | [optional] **ExpiresAt** | **DateTime?** | Date when the number of points defined in the bucket object are due to expire. | [optional] **CreatedAt** | **DateTimeOffset?** | Timestamp representing the date and time when the loyalty point bucket object was created in ISO 8601 format. | [optional] **UpdatedAt** | **DateTimeOffset?** | Timestamp representing the date and time when the loyalty point bucket object was updated in ISO 8601 format. | [optional] diff --git a/docs/ManagementApi.md b/docs/ManagementApi.md index df8a71c9..48bdc8e7 100644 --- a/docs/ManagementApi.md +++ b/docs/ManagementApi.md @@ -45,7 +45,7 @@ All URIs are relative to *https://api.voucherify.io* # **AssignUser** -> ManagementProjectsUsersAssignResponseBody AssignUser (string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody = null) +> ManagementProjectsUsersAssignResponseBody AssignUser (string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody) Assign User @@ -78,7 +78,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. - var managementProjectsUsersAssignRequestBody = new ManagementProjectsUsersAssignRequestBody(); // ManagementProjectsUsersAssignRequestBody | Defines the user details. (optional) + var managementProjectsUsersAssignRequestBody = new ManagementProjectsUsersAssignRequestBody(); // ManagementProjectsUsersAssignRequestBody | Defines the user details. try { @@ -122,7 +122,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | -| **managementProjectsUsersAssignRequestBody** | [**ManagementProjectsUsersAssignRequestBody**](ManagementProjectsUsersAssignRequestBody.md) | Defines the user details. | [optional] | +| **managementProjectsUsersAssignRequestBody** | [**ManagementProjectsUsersAssignRequestBody**](ManagementProjectsUsersAssignRequestBody.md) | Defines the user details. | | ### Return type @@ -147,7 +147,7 @@ catch (ApiException e) # **CreateBrand** -> ManagementProjectsBrandingCreateResponseBody CreateBrand (string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody = null) +> ManagementProjectsBrandingCreateResponseBody CreateBrand (string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody) Create Brand @@ -180,7 +180,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. - var managementProjectsBrandingCreateRequestBody = new ManagementProjectsBrandingCreateRequestBody(); // ManagementProjectsBrandingCreateRequestBody | Defines a brand configuration. (optional) + var managementProjectsBrandingCreateRequestBody = new ManagementProjectsBrandingCreateRequestBody(); // ManagementProjectsBrandingCreateRequestBody | Defines a brand configuration. try { @@ -224,7 +224,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | -| **managementProjectsBrandingCreateRequestBody** | [**ManagementProjectsBrandingCreateRequestBody**](ManagementProjectsBrandingCreateRequestBody.md) | Defines a brand configuration. | [optional] | +| **managementProjectsBrandingCreateRequestBody** | [**ManagementProjectsBrandingCreateRequestBody**](ManagementProjectsBrandingCreateRequestBody.md) | Defines a brand configuration. | | ### Return type @@ -249,7 +249,7 @@ catch (ApiException e) # **CreateCustomEventSchema** -> ManagementProjectsCustomEventSchemasCreateResponseBody CreateCustomEventSchema (string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody = null) +> ManagementProjectsCustomEventSchemasCreateResponseBody CreateCustomEventSchema (string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody) Create Custom Event Schema @@ -282,7 +282,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. - var managementProjectsCustomEventSchemasCreateRequestBody = new ManagementProjectsCustomEventSchemasCreateRequestBody(); // ManagementProjectsCustomEventSchemasCreateRequestBody | Defines the custom event schema. (optional) + var managementProjectsCustomEventSchemasCreateRequestBody = new ManagementProjectsCustomEventSchemasCreateRequestBody(); // ManagementProjectsCustomEventSchemasCreateRequestBody | Defines the custom event schema. try { @@ -326,7 +326,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | -| **managementProjectsCustomEventSchemasCreateRequestBody** | [**ManagementProjectsCustomEventSchemasCreateRequestBody**](ManagementProjectsCustomEventSchemasCreateRequestBody.md) | Defines the custom event schema. | [optional] | +| **managementProjectsCustomEventSchemasCreateRequestBody** | [**ManagementProjectsCustomEventSchemasCreateRequestBody**](ManagementProjectsCustomEventSchemasCreateRequestBody.md) | Defines the custom event schema. | | ### Return type @@ -351,7 +351,7 @@ catch (ApiException e) # **CreateMetadataSchema** -> ManagementProjectsMetadataSchemasCreateResponseBody CreateMetadataSchema (string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody = null) +> ManagementProjectsMetadataSchemasCreateResponseBody CreateMetadataSchema (string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody) Create Metadata Schema @@ -384,7 +384,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. - var managementProjectsMetadataSchemasCreateRequestBody = new ManagementProjectsMetadataSchemasCreateRequestBody(); // ManagementProjectsMetadataSchemasCreateRequestBody | Defines the metadata schema. (optional) + var managementProjectsMetadataSchemasCreateRequestBody = new ManagementProjectsMetadataSchemasCreateRequestBody(); // ManagementProjectsMetadataSchemasCreateRequestBody | Defines the metadata schema. try { @@ -428,7 +428,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | -| **managementProjectsMetadataSchemasCreateRequestBody** | [**ManagementProjectsMetadataSchemasCreateRequestBody**](ManagementProjectsMetadataSchemasCreateRequestBody.md) | Defines the metadata schema. | [optional] | +| **managementProjectsMetadataSchemasCreateRequestBody** | [**ManagementProjectsMetadataSchemasCreateRequestBody**](ManagementProjectsMetadataSchemasCreateRequestBody.md) | Defines the metadata schema. | | ### Return type @@ -453,7 +453,7 @@ catch (ApiException e) # **CreateProject** -> ManagementProjectsCreateResponseBody CreateProject (ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody = null) +> ManagementProjectsCreateResponseBody CreateProject (ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody) Create Project @@ -485,7 +485,7 @@ namespace Example // config.AddApiKeyPrefix("X-Management-Id", "Bearer"); var apiInstance = new ManagementApi(config); - var managementProjectsCreateRequestBody = new ManagementProjectsCreateRequestBody(); // ManagementProjectsCreateRequestBody | Define project details. (optional) + var managementProjectsCreateRequestBody = new ManagementProjectsCreateRequestBody(); // ManagementProjectsCreateRequestBody | Define project details. try { @@ -528,7 +528,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **managementProjectsCreateRequestBody** | [**ManagementProjectsCreateRequestBody**](ManagementProjectsCreateRequestBody.md) | Define project details. | [optional] | +| **managementProjectsCreateRequestBody** | [**ManagementProjectsCreateRequestBody**](ManagementProjectsCreateRequestBody.md) | Define project details. | | ### Return type @@ -553,7 +553,7 @@ catch (ApiException e) # **CreateStackingRules** -> ManagementProjectsStackingRulesCreateResponseBody CreateStackingRules (string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody = null) +> ManagementProjectsStackingRulesCreateResponseBody CreateStackingRules (string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody) Create Stacking Rules @@ -586,7 +586,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. - var managementProjectsStackingRulesCreateRequestBody = new ManagementProjectsStackingRulesCreateRequestBody(); // ManagementProjectsStackingRulesCreateRequestBody | Defines the stacking rule parameters. (optional) + var managementProjectsStackingRulesCreateRequestBody = new ManagementProjectsStackingRulesCreateRequestBody(); // ManagementProjectsStackingRulesCreateRequestBody | Defines the stacking rule parameters. try { @@ -630,7 +630,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | -| **managementProjectsStackingRulesCreateRequestBody** | [**ManagementProjectsStackingRulesCreateRequestBody**](ManagementProjectsStackingRulesCreateRequestBody.md) | Defines the stacking rule parameters. | [optional] | +| **managementProjectsStackingRulesCreateRequestBody** | [**ManagementProjectsStackingRulesCreateRequestBody**](ManagementProjectsStackingRulesCreateRequestBody.md) | Defines the stacking rule parameters. | | ### Return type @@ -655,7 +655,7 @@ catch (ApiException e) # **CreateWebhook** -> ManagementProjectsWebhooksCreateResponseBody CreateWebhook (string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody = null) +> ManagementProjectsWebhooksCreateResponseBody CreateWebhook (string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody) Create Webhook @@ -688,7 +688,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. - var managementProjectsWebhooksCreateRequestBody = new ManagementProjectsWebhooksCreateRequestBody(); // ManagementProjectsWebhooksCreateRequestBody | Defines a webhook configuration. (optional) + var managementProjectsWebhooksCreateRequestBody = new ManagementProjectsWebhooksCreateRequestBody(); // ManagementProjectsWebhooksCreateRequestBody | Defines a webhook configuration. try { @@ -732,7 +732,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | -| **managementProjectsWebhooksCreateRequestBody** | [**ManagementProjectsWebhooksCreateRequestBody**](ManagementProjectsWebhooksCreateRequestBody.md) | Defines a webhook configuration. | [optional] | +| **managementProjectsWebhooksCreateRequestBody** | [**ManagementProjectsWebhooksCreateRequestBody**](ManagementProjectsWebhooksCreateRequestBody.md) | Defines a webhook configuration. | | ### Return type @@ -2055,7 +2055,7 @@ catch (ApiException e) # **InviteUser** -> void InviteUser (ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody = null) +> void InviteUser (ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody) Invite a New User @@ -2087,7 +2087,7 @@ namespace Example // config.AddApiKeyPrefix("X-Management-Id", "Bearer"); var apiInstance = new ManagementApi(config); - var managementProjectsUsersInviteCreateRequestBody = new ManagementProjectsUsersInviteCreateRequestBody(); // ManagementProjectsUsersInviteCreateRequestBody | Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + var managementProjectsUsersInviteCreateRequestBody = new ManagementProjectsUsersInviteCreateRequestBody(); // ManagementProjectsUsersInviteCreateRequestBody | Defines the details of the invitation, the project, and roles to which the user will be assigned. try { @@ -2126,7 +2126,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **managementProjectsUsersInviteCreateRequestBody** | [**ManagementProjectsUsersInviteCreateRequestBody**](ManagementProjectsUsersInviteCreateRequestBody.md) | Defines the details of the invitation, the project, and roles to which the user will be assigned. | [optional] | +| **managementProjectsUsersInviteCreateRequestBody** | [**ManagementProjectsUsersInviteCreateRequestBody**](ManagementProjectsUsersInviteCreateRequestBody.md) | Defines the details of the invitation, the project, and roles to which the user will be assigned. | | ### Return type @@ -2846,7 +2846,7 @@ catch (ApiException e) # **ManagementCopyCampaignTemplate** -> ManagementProjectsTemplatesCampaignsCopyCreateResponseBody ManagementCopyCampaignTemplate (string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody = null) +> ManagementProjectsTemplatesCampaignsCopyCreateResponseBody ManagementCopyCampaignTemplate (string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody) Copy Campaign Template to a Project @@ -2880,7 +2880,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. var campaignTemplateId = "campaignTemplateId_example"; // string | Provide the unique identifier of the campaign template. - var managementProjectsTemplatesCampaignsCopyCreateRequestBody = new ManagementProjectsTemplatesCampaignsCopyCreateRequestBody(); // ManagementProjectsTemplatesCampaignsCopyCreateRequestBody | Determines the details about the template in the destination project as well as the destination project itself. (optional) + var managementProjectsTemplatesCampaignsCopyCreateRequestBody = new ManagementProjectsTemplatesCampaignsCopyCreateRequestBody(); // ManagementProjectsTemplatesCampaignsCopyCreateRequestBody | Determines the details about the template in the destination project as well as the destination project itself. try { @@ -2925,7 +2925,7 @@ catch (ApiException e) |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | | **campaignTemplateId** | **string** | Provide the unique identifier of the campaign template. | | -| **managementProjectsTemplatesCampaignsCopyCreateRequestBody** | [**ManagementProjectsTemplatesCampaignsCopyCreateRequestBody**](ManagementProjectsTemplatesCampaignsCopyCreateRequestBody.md) | Determines the details about the template in the destination project as well as the destination project itself. | [optional] | +| **managementProjectsTemplatesCampaignsCopyCreateRequestBody** | [**ManagementProjectsTemplatesCampaignsCopyCreateRequestBody**](ManagementProjectsTemplatesCampaignsCopyCreateRequestBody.md) | Determines the details about the template in the destination project as well as the destination project itself. | | ### Return type @@ -3158,7 +3158,7 @@ void (empty response body) # **UpdateBrand** -> ManagementProjectsBrandingUpdateResponseBody UpdateBrand (string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody = null) +> ManagementProjectsBrandingUpdateResponseBody UpdateBrand (string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody) Update Brand @@ -3192,7 +3192,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. var brandingId = "brandingId_example"; // string | Provide the unique identifier of the brand configuration. - var managementProjectsBrandingUpdateRequestBody = new ManagementProjectsBrandingUpdateRequestBody(); // ManagementProjectsBrandingUpdateRequestBody | Defines the brand configuration to be updated. (optional) + var managementProjectsBrandingUpdateRequestBody = new ManagementProjectsBrandingUpdateRequestBody(); // ManagementProjectsBrandingUpdateRequestBody | Defines the brand configuration to be updated. try { @@ -3237,7 +3237,7 @@ catch (ApiException e) |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | | **brandingId** | **string** | Provide the unique identifier of the brand configuration. | | -| **managementProjectsBrandingUpdateRequestBody** | [**ManagementProjectsBrandingUpdateRequestBody**](ManagementProjectsBrandingUpdateRequestBody.md) | Defines the brand configuration to be updated. | [optional] | +| **managementProjectsBrandingUpdateRequestBody** | [**ManagementProjectsBrandingUpdateRequestBody**](ManagementProjectsBrandingUpdateRequestBody.md) | Defines the brand configuration to be updated. | | ### Return type @@ -3262,7 +3262,7 @@ catch (ApiException e) # **UpdateCustomEventSchema** -> ManagementProjectsCustomEventSchemasUpdateResponseBody UpdateCustomEventSchema (string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody = null) +> ManagementProjectsCustomEventSchemasUpdateResponseBody UpdateCustomEventSchema (string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody) Update Custom Event Schema @@ -3296,7 +3296,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. var customEventSchemaId = "customEventSchemaId_example"; // string | Provide the unique identifier of the custom event schema. - var managementProjectsCustomEventSchemasUpdateRequestBody = new ManagementProjectsCustomEventSchemasUpdateRequestBody(); // ManagementProjectsCustomEventSchemasUpdateRequestBody | Defines the custom event schema to be updated. (optional) + var managementProjectsCustomEventSchemasUpdateRequestBody = new ManagementProjectsCustomEventSchemasUpdateRequestBody(); // ManagementProjectsCustomEventSchemasUpdateRequestBody | Defines the custom event schema to be updated. try { @@ -3341,7 +3341,7 @@ catch (ApiException e) |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | | **customEventSchemaId** | **string** | Provide the unique identifier of the custom event schema. | | -| **managementProjectsCustomEventSchemasUpdateRequestBody** | [**ManagementProjectsCustomEventSchemasUpdateRequestBody**](ManagementProjectsCustomEventSchemasUpdateRequestBody.md) | Defines the custom event schema to be updated. | [optional] | +| **managementProjectsCustomEventSchemasUpdateRequestBody** | [**ManagementProjectsCustomEventSchemasUpdateRequestBody**](ManagementProjectsCustomEventSchemasUpdateRequestBody.md) | Defines the custom event schema to be updated. | | ### Return type @@ -3366,7 +3366,7 @@ catch (ApiException e) # **UpdateMetadataSchema** -> ManagementProjectsMetadataSchemasUpdateResponseBody UpdateMetadataSchema (string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody = null) +> ManagementProjectsMetadataSchemasUpdateResponseBody UpdateMetadataSchema (string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody) Update Metadata Schema @@ -3400,7 +3400,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. var metadataSchemaId = "metadataSchemaId_example"; // string | Provide the unique identifier of the metadata schema. - var managementProjectsMetadataSchemasUpdateRequestBody = new ManagementProjectsMetadataSchemasUpdateRequestBody(); // ManagementProjectsMetadataSchemasUpdateRequestBody | Defines the metadata schema to be updated. (optional) + var managementProjectsMetadataSchemasUpdateRequestBody = new ManagementProjectsMetadataSchemasUpdateRequestBody(); // ManagementProjectsMetadataSchemasUpdateRequestBody | Defines the metadata schema to be updated. try { @@ -3445,7 +3445,7 @@ catch (ApiException e) |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | | **metadataSchemaId** | **string** | Provide the unique identifier of the metadata schema. | | -| **managementProjectsMetadataSchemasUpdateRequestBody** | [**ManagementProjectsMetadataSchemasUpdateRequestBody**](ManagementProjectsMetadataSchemasUpdateRequestBody.md) | Defines the metadata schema to be updated. | [optional] | +| **managementProjectsMetadataSchemasUpdateRequestBody** | [**ManagementProjectsMetadataSchemasUpdateRequestBody**](ManagementProjectsMetadataSchemasUpdateRequestBody.md) | Defines the metadata schema to be updated. | | ### Return type @@ -3470,7 +3470,7 @@ catch (ApiException e) # **UpdateProject** -> ManagementProjectsUpdateResponseBody UpdateProject (string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody = null) +> ManagementProjectsUpdateResponseBody UpdateProject (string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody) Update Project @@ -3503,7 +3503,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. - var managementProjectsUpdateRequestBody = new ManagementProjectsUpdateRequestBody(); // ManagementProjectsUpdateRequestBody | Define the project details to be updated. (optional) + var managementProjectsUpdateRequestBody = new ManagementProjectsUpdateRequestBody(); // ManagementProjectsUpdateRequestBody | Define the project details to be updated. try { @@ -3547,7 +3547,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | -| **managementProjectsUpdateRequestBody** | [**ManagementProjectsUpdateRequestBody**](ManagementProjectsUpdateRequestBody.md) | Define the project details to be updated. | [optional] | +| **managementProjectsUpdateRequestBody** | [**ManagementProjectsUpdateRequestBody**](ManagementProjectsUpdateRequestBody.md) | Define the project details to be updated. | | ### Return type @@ -3572,7 +3572,7 @@ catch (ApiException e) # **UpdateStackingRules** -> ManagementProjectsStackingRulesUpdateResponseBody UpdateStackingRules (string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody = null) +> ManagementProjectsStackingRulesUpdateResponseBody UpdateStackingRules (string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody) Update Stacking Rules @@ -3606,7 +3606,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. var stackingRulesId = "stackingRulesId_example"; // string | Provide the unique identifier of the stacking rules. - var managementProjectsStackingRulesUpdateRequestBody = new ManagementProjectsStackingRulesUpdateRequestBody(); // ManagementProjectsStackingRulesUpdateRequestBody | Defines the stacking rules to be updated. (optional) + var managementProjectsStackingRulesUpdateRequestBody = new ManagementProjectsStackingRulesUpdateRequestBody(); // ManagementProjectsStackingRulesUpdateRequestBody | Defines the stacking rules to be updated. try { @@ -3651,7 +3651,7 @@ catch (ApiException e) |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | | **stackingRulesId** | **string** | Provide the unique identifier of the stacking rules. | | -| **managementProjectsStackingRulesUpdateRequestBody** | [**ManagementProjectsStackingRulesUpdateRequestBody**](ManagementProjectsStackingRulesUpdateRequestBody.md) | Defines the stacking rules to be updated. | [optional] | +| **managementProjectsStackingRulesUpdateRequestBody** | [**ManagementProjectsStackingRulesUpdateRequestBody**](ManagementProjectsStackingRulesUpdateRequestBody.md) | Defines the stacking rules to be updated. | | ### Return type @@ -3676,7 +3676,7 @@ catch (ApiException e) # **UpdateUser** -> ManagementProjectsUsersUpdateRoleResponseBody UpdateUser (string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody = null) +> ManagementProjectsUsersUpdateRoleResponseBody UpdateUser (string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody) Update User @@ -3710,7 +3710,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. var userId = "userId_example"; // string | Provide the unique identifier of the user. Alternatively, provide the users login. - var managementProjectsUsersUpdateRoleRequestBody = new ManagementProjectsUsersUpdateRoleRequestBody(); // ManagementProjectsUsersUpdateRoleRequestBody | Defines the users new role. (optional) + var managementProjectsUsersUpdateRoleRequestBody = new ManagementProjectsUsersUpdateRoleRequestBody(); // ManagementProjectsUsersUpdateRoleRequestBody | Defines the users new role. try { @@ -3755,7 +3755,7 @@ catch (ApiException e) |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | | **userId** | **string** | Provide the unique identifier of the user. Alternatively, provide the users login. | | -| **managementProjectsUsersUpdateRoleRequestBody** | [**ManagementProjectsUsersUpdateRoleRequestBody**](ManagementProjectsUsersUpdateRoleRequestBody.md) | Defines the users new role. | [optional] | +| **managementProjectsUsersUpdateRoleRequestBody** | [**ManagementProjectsUsersUpdateRoleRequestBody**](ManagementProjectsUsersUpdateRoleRequestBody.md) | Defines the users new role. | | ### Return type @@ -3780,7 +3780,7 @@ catch (ApiException e) # **UpdateWebhook** -> ManagementProjectsWebhooksUpdateResponseBody UpdateWebhook (string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody = null) +> ManagementProjectsWebhooksUpdateResponseBody UpdateWebhook (string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody) Update Webhook @@ -3814,7 +3814,7 @@ namespace Example var apiInstance = new ManagementApi(config); var projectId = "projectId_example"; // string | Provide the unique identifier of the project. var webhookId = "webhookId_example"; // string | Provide the unique identifier of the webhook configuration. - var managementProjectsWebhooksUpdateRequestBody = new ManagementProjectsWebhooksUpdateRequestBody(); // ManagementProjectsWebhooksUpdateRequestBody | Defines the webhook configuration to be updated. (optional) + var managementProjectsWebhooksUpdateRequestBody = new ManagementProjectsWebhooksUpdateRequestBody(); // ManagementProjectsWebhooksUpdateRequestBody | Defines the webhook configuration to be updated. try { @@ -3859,7 +3859,7 @@ catch (ApiException e) |------|------|-------------|-------| | **projectId** | **string** | Provide the unique identifier of the project. | | | **webhookId** | **string** | Provide the unique identifier of the webhook configuration. | | -| **managementProjectsWebhooksUpdateRequestBody** | [**ManagementProjectsWebhooksUpdateRequestBody**](ManagementProjectsWebhooksUpdateRequestBody.md) | Defines the webhook configuration to be updated. | [optional] | +| **managementProjectsWebhooksUpdateRequestBody** | [**ManagementProjectsWebhooksUpdateRequestBody**](ManagementProjectsWebhooksUpdateRequestBody.md) | Defines the webhook configuration to be updated. | | ### Return type diff --git a/docs/MemberActivityDataTransaction.md b/docs/MemberActivityDataTransaction.md index 7f3ddad9..d2d43d05 100644 --- a/docs/MemberActivityDataTransaction.md +++ b/docs/MemberActivityDataTransaction.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **SourceId** | **string** | The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null. | [optional] **VoucherId** | **string** | Unique voucher ID. | [optional] **CampaignId** | **string** | Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes. | [optional] -**Source** | **string** | The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. | [optional] +**Source** | **string** | The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. | [optional] **Reason** | **string** | Reason why the transaction occurred. In case of a redemption, this value is null. | [optional] **RelatedTransactionId** | **string** | The related transaction ID on the receiving card. | [optional] **CreatedAt** | **DateTimeOffset?** | Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format. | [optional] diff --git a/docs/OrdersApi.md b/docs/OrdersApi.md index f08e6e26..8207af46 100644 --- a/docs/OrdersApi.md +++ b/docs/OrdersApi.md @@ -13,7 +13,7 @@ All URIs are relative to *https://api.voucherify.io* # **CreateOrder** -> OrdersCreateResponseBody CreateOrder (OrdersCreateRequestBody ordersCreateRequestBody = null) +> OrdersCreateResponseBody CreateOrder (OrdersCreateRequestBody ordersCreateRequestBody) Create Order @@ -47,7 +47,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new OrdersApi(config); - var ordersCreateRequestBody = new OrdersCreateRequestBody(); // OrdersCreateRequestBody | Specify the order parameters. (optional) + var ordersCreateRequestBody = new OrdersCreateRequestBody(); // OrdersCreateRequestBody | Specify the order parameters. try { @@ -90,7 +90,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **ordersCreateRequestBody** | [**OrdersCreateRequestBody**](OrdersCreateRequestBody.md) | Specify the order parameters. | [optional] | +| **ordersCreateRequestBody** | [**OrdersCreateRequestBody**](OrdersCreateRequestBody.md) | Specify the order parameters. | | ### Return type @@ -115,7 +115,7 @@ catch (ApiException e) # **CreateOrderExport** -> OrdersExportCreateResponseBody CreateOrderExport (OrdersExportCreateRequestBody ordersExportCreateRequestBody = null) +> OrdersExportCreateResponseBody CreateOrderExport (OrdersExportCreateRequestBody ordersExportCreateRequestBody) Create Orders Export @@ -149,7 +149,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new OrdersApi(config); - var ordersExportCreateRequestBody = new OrdersExportCreateRequestBody(); // OrdersExportCreateRequestBody | Specify which order parameters you would like to export. (optional) + var ordersExportCreateRequestBody = new OrdersExportCreateRequestBody(); // OrdersExportCreateRequestBody | Specify which order parameters you would like to export. try { @@ -192,7 +192,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **ordersExportCreateRequestBody** | [**OrdersExportCreateRequestBody**](OrdersExportCreateRequestBody.md) | Specify which order parameters you would like to export. | [optional] | +| **ordersExportCreateRequestBody** | [**OrdersExportCreateRequestBody**](OrdersExportCreateRequestBody.md) | Specify which order parameters you would like to export. | | ### Return type @@ -319,11 +319,11 @@ catch (ApiException e) # **ImportOrders** -> OrdersImportCreateResponseBody ImportOrders (List ordersImportCreateRequestBodyItem = null) +> OrdersImportCreateResponseBody ImportOrders (List ordersImportCreateRequestBodyItem) Import Orders - 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. ### Example ```csharp @@ -353,7 +353,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new OrdersApi(config); - var ordersImportCreateRequestBodyItem = new List(); // List | The request body is sent in the form of an array of order objects. (optional) + var ordersImportCreateRequestBodyItem = new List(); // List | The request body is sent in the form of an array of order objects. try { @@ -396,7 +396,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **ordersImportCreateRequestBodyItem** | [**List<OrdersImportCreateRequestBodyItem>**](OrdersImportCreateRequestBodyItem.md) | The request body is sent in the form of an array of order objects. | [optional] | +| **ordersImportCreateRequestBodyItem** | [**List<OrdersImportCreateRequestBodyItem>**](OrdersImportCreateRequestBodyItem.md) | The request body is sent in the form of an array of order objects. | | ### Return type @@ -527,7 +527,7 @@ catch (ApiException e) # **UpdateOrder** -> OrdersUpdateResponseBody UpdateOrder (string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody = null) +> OrdersUpdateResponseBody UpdateOrder (string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody) Update Order @@ -562,7 +562,7 @@ namespace Example var apiInstance = new OrdersApi(config); var orderId = "orderId_example"; // string | Unique Voucherify order ID or order source ID. - var ordersUpdateRequestBody = new OrdersUpdateRequestBody(); // OrdersUpdateRequestBody | Specify the parameters of the order that are to be updated. (optional) + var ordersUpdateRequestBody = new OrdersUpdateRequestBody(); // OrdersUpdateRequestBody | Specify the parameters of the order that are to be updated. try { @@ -606,7 +606,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **orderId** | **string** | Unique Voucherify order ID or order source ID. | | -| **ordersUpdateRequestBody** | [**OrdersUpdateRequestBody**](OrdersUpdateRequestBody.md) | Specify the parameters of the order that are to be updated. | [optional] | +| **ordersUpdateRequestBody** | [**OrdersUpdateRequestBody**](OrdersUpdateRequestBody.md) | Specify the parameters of the order that are to be updated. | | ### Return type diff --git a/docs/OrdersImportCreateRequestBodyItem.md b/docs/OrdersImportCreateRequestBodyItem.md index fc6e14cb..93866e61 100644 --- a/docs/OrdersImportCreateRequestBodyItem.md +++ b/docs/OrdersImportCreateRequestBodyItem.md @@ -12,7 +12,6 @@ Name | Type | Description | Notes **DiscountAmount** | **int?** | Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] **Items** | [**List<OrderItem>**](OrderItem.md) | Array of items applied to the order. It can include up to 500 items. | [optional] **Metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas. | [optional] -**CreatedAt** | **DateTimeOffset** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] **ReferrerId** | **string** | Unique referrer ID. | [optional] **Customer** | [**Customer**](Customer.md) | | [optional] **Referrer** | [**Referrer**](Referrer.md) | | [optional] diff --git a/docs/ProductCollectionsApi.md b/docs/ProductCollectionsApi.md index a228ee28..f024fbf7 100644 --- a/docs/ProductCollectionsApi.md +++ b/docs/ProductCollectionsApi.md @@ -12,7 +12,7 @@ All URIs are relative to *https://api.voucherify.io* # **CreateProductCollection** -> ProductCollectionsCreateResponseBody CreateProductCollection (ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody = null) +> ProductCollectionsCreateResponseBody CreateProductCollection (ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody) Create Product Collection @@ -46,7 +46,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new ProductCollectionsApi(config); - var productCollectionsCreateRequestBody = new ProductCollectionsCreateRequestBody(); // ProductCollectionsCreateRequestBody | (optional) + var productCollectionsCreateRequestBody = new ProductCollectionsCreateRequestBody(); // ProductCollectionsCreateRequestBody | try { @@ -89,7 +89,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **productCollectionsCreateRequestBody** | [**ProductCollectionsCreateRequestBody**](ProductCollectionsCreateRequestBody.md) | | [optional] | +| **productCollectionsCreateRequestBody** | [**ProductCollectionsCreateRequestBody**](ProductCollectionsCreateRequestBody.md) | | | ### Return type diff --git a/docs/ProductCollectionsCreateRequestBody.md b/docs/ProductCollectionsCreateRequestBody.md index 563743fd..e6d1c790 100644 --- a/docs/ProductCollectionsCreateRequestBody.md +++ b/docs/ProductCollectionsCreateRequestBody.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | Show that the product collection is static (manually selected products). | [optional] +**Type** | **string** | | [optional] **Name** | **string** | Unique user-defined product collection name. | [optional] **Products** | [**List<ProductCollectionsCreateRequestBodyProductsItem>**](ProductCollectionsCreateRequestBodyProductsItem.md) | Defines a set of products for a `STATIC` product collection type. | [optional] **Filter** | **Object** | Defines a set of criteria and boundary conditions for an `AUTO_UPDATE` product collection type. | [optional] diff --git a/docs/ProductsApi.md b/docs/ProductsApi.md index 57cf7147..c5850f7b 100644 --- a/docs/ProductsApi.md +++ b/docs/ProductsApi.md @@ -21,7 +21,7 @@ All URIs are relative to *https://api.voucherify.io* # **CreateProduct** -> ProductsCreateResponseBody CreateProduct (ProductsCreateRequestBody productsCreateRequestBody = null) +> ProductsCreateResponseBody CreateProduct (ProductsCreateRequestBody productsCreateRequestBody) Create Product @@ -55,7 +55,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new ProductsApi(config); - var productsCreateRequestBody = new ProductsCreateRequestBody(); // ProductsCreateRequestBody | Specify the product parameters. (optional) + var productsCreateRequestBody = new ProductsCreateRequestBody(); // ProductsCreateRequestBody | Specify the product parameters. try { @@ -98,7 +98,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **productsCreateRequestBody** | [**ProductsCreateRequestBody**](ProductsCreateRequestBody.md) | Specify the product parameters. | [optional] | +| **productsCreateRequestBody** | [**ProductsCreateRequestBody**](ProductsCreateRequestBody.md) | Specify the product parameters. | | ### Return type @@ -123,7 +123,7 @@ catch (ApiException e) # **CreateSku** -> ProductsSkusCreateResponseBody CreateSku (string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody = null) +> ProductsSkusCreateResponseBody CreateSku (string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody) Create SKU @@ -158,7 +158,7 @@ namespace Example var apiInstance = new ProductsApi(config); var productId = "productId_example"; // string | A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - var productsSkusCreateRequestBody = new ProductsSkusCreateRequestBody(); // ProductsSkusCreateRequestBody | Specify the SKU parameters to be created. (optional) + var productsSkusCreateRequestBody = new ProductsSkusCreateRequestBody(); // ProductsSkusCreateRequestBody | Specify the SKU parameters to be created. try { @@ -202,7 +202,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **productId** | **string** | A Voucherify [product](/api-reference/products/get-product) ID or product source ID. | | -| **productsSkusCreateRequestBody** | [**ProductsSkusCreateRequestBody**](ProductsSkusCreateRequestBody.md) | Specify the SKU parameters to be created. | [optional] | +| **productsSkusCreateRequestBody** | [**ProductsSkusCreateRequestBody**](ProductsSkusCreateRequestBody.md) | Specify the SKU parameters to be created. | | ### Return type @@ -1059,7 +1059,7 @@ catch (ApiException e) # **UpdateProduct** -> ProductsUpdateResponseBody UpdateProduct (string productId, ProductsUpdateRequestBody productsUpdateRequestBody = null) +> ProductsUpdateResponseBody UpdateProduct (string productId, ProductsUpdateRequestBody productsUpdateRequestBody) Update Product @@ -1094,7 +1094,7 @@ namespace Example var apiInstance = new ProductsApi(config); var productId = "productId_example"; // string | A Voucherify product ID or source ID. - var productsUpdateRequestBody = new ProductsUpdateRequestBody(); // ProductsUpdateRequestBody | Specify the parameters of the product that are to be updated. (optional) + var productsUpdateRequestBody = new ProductsUpdateRequestBody(); // ProductsUpdateRequestBody | Specify the parameters of the product that are to be updated. try { @@ -1138,7 +1138,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **productId** | **string** | A Voucherify product ID or source ID. | | -| **productsUpdateRequestBody** | [**ProductsUpdateRequestBody**](ProductsUpdateRequestBody.md) | Specify the parameters of the product that are to be updated. | [optional] | +| **productsUpdateRequestBody** | [**ProductsUpdateRequestBody**](ProductsUpdateRequestBody.md) | Specify the parameters of the product that are to be updated. | | ### Return type @@ -1163,7 +1163,7 @@ catch (ApiException e) # **UpdateProductsInBulk** -> ProductsUpdateInBulkResponseBody UpdateProductsInBulk (List productsUpdateInBulkRequestBody = null) +> ProductsUpdateInBulkResponseBody UpdateProductsInBulk (List productsUpdateInBulkRequestBody) Update Products in Bulk @@ -1197,7 +1197,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new ProductsApi(config); - var productsUpdateInBulkRequestBody = new List(); // List | List the product fields to be updated in each product object. (optional) + var productsUpdateInBulkRequestBody = new List(); // List | List the product fields to be updated in each product object. try { @@ -1240,7 +1240,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **productsUpdateInBulkRequestBody** | [**List<ProductsUpdateInBulkRequestBody>**](ProductsUpdateInBulkRequestBody.md) | List the product fields to be updated in each product object. | [optional] | +| **productsUpdateInBulkRequestBody** | [**List<ProductsUpdateInBulkRequestBody>**](ProductsUpdateInBulkRequestBody.md) | List the product fields to be updated in each product object. | | ### Return type @@ -1265,7 +1265,7 @@ catch (ApiException e) # **UpdateProductsMetadataInBulk** -> ProductsMetadataUpdateInBulkResponseBody UpdateProductsMetadataInBulk (ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody = null) +> ProductsMetadataUpdateInBulkResponseBody UpdateProductsMetadataInBulk (ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody) Update Products' Metadata in Bulk @@ -1299,7 +1299,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new ProductsApi(config); - var productsMetadataUpdateInBulkRequestBody = new ProductsMetadataUpdateInBulkRequestBody(); // ProductsMetadataUpdateInBulkRequestBody | List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + var productsMetadataUpdateInBulkRequestBody = new ProductsMetadataUpdateInBulkRequestBody(); // ProductsMetadataUpdateInBulkRequestBody | List the source_ids of the products you would like to update with the metadata key/value pairs. try { @@ -1342,7 +1342,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **productsMetadataUpdateInBulkRequestBody** | [**ProductsMetadataUpdateInBulkRequestBody**](ProductsMetadataUpdateInBulkRequestBody.md) | List the source_ids of the products you would like to update with the metadata key/value pairs. | [optional] | +| **productsMetadataUpdateInBulkRequestBody** | [**ProductsMetadataUpdateInBulkRequestBody**](ProductsMetadataUpdateInBulkRequestBody.md) | List the source_ids of the products you would like to update with the metadata key/value pairs. | | ### Return type @@ -1367,7 +1367,7 @@ catch (ApiException e) # **UpdateSku** -> ProductsSkusUpdateResponseBody UpdateSku (string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody = null) +> ProductsSkusUpdateResponseBody UpdateSku (string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody) Update SKU @@ -1403,7 +1403,7 @@ namespace Example var apiInstance = new ProductsApi(config); var productId = "productId_example"; // string | A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. var skuId = "skuId_example"; // string | A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - var productsSkusUpdateRequestBody = new ProductsSkusUpdateRequestBody(); // ProductsSkusUpdateRequestBody | Specify the parameters to be updated. (optional) + var productsSkusUpdateRequestBody = new ProductsSkusUpdateRequestBody(); // ProductsSkusUpdateRequestBody | Specify the parameters to be updated. try { @@ -1448,7 +1448,7 @@ catch (ApiException e) |------|------|-------------|-------| | **productId** | **string** | A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. | | | **skuId** | **string** | A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. | | -| **productsSkusUpdateRequestBody** | [**ProductsSkusUpdateRequestBody**](ProductsSkusUpdateRequestBody.md) | Specify the parameters to be updated. | [optional] | +| **productsSkusUpdateRequestBody** | [**ProductsSkusUpdateRequestBody**](ProductsSkusUpdateRequestBody.md) | Specify the parameters to be updated. | | ### Return type diff --git a/docs/PromotionsApi.md b/docs/PromotionsApi.md index aaa61368..60c51226 100644 --- a/docs/PromotionsApi.md +++ b/docs/PromotionsApi.md @@ -21,7 +21,7 @@ All URIs are relative to *https://api.voucherify.io* # **AddPromotionTierToCampaign** -> PromotionsTiersCreateResponseBody AddPromotionTierToCampaign (string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody = null) +> PromotionsTiersCreateResponseBody AddPromotionTierToCampaign (string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody) Add Promotion Tier to Campaign @@ -56,7 +56,7 @@ namespace Example var apiInstance = new PromotionsApi(config); var campaignId = "campaignId_example"; // string | Unique campaign ID assigned by Voucherify. - var promotionsTiersCreateRequestBody = new PromotionsTiersCreateRequestBody(); // PromotionsTiersCreateRequestBody | Specify the promotion tier parameters. (optional) + var promotionsTiersCreateRequestBody = new PromotionsTiersCreateRequestBody(); // PromotionsTiersCreateRequestBody | Specify the promotion tier parameters. try { @@ -100,7 +100,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignId** | **string** | Unique campaign ID assigned by Voucherify. | | -| **promotionsTiersCreateRequestBody** | [**PromotionsTiersCreateRequestBody**](PromotionsTiersCreateRequestBody.md) | Specify the promotion tier parameters. | [optional] | +| **promotionsTiersCreateRequestBody** | [**PromotionsTiersCreateRequestBody**](PromotionsTiersCreateRequestBody.md) | Specify the promotion tier parameters. | | ### Return type @@ -125,7 +125,7 @@ catch (ApiException e) # **CreatePromotionStack** -> PromotionsStacksCreateResponseBody CreatePromotionStack (string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody = null) +> PromotionsStacksCreateResponseBody CreatePromotionStack (string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody) Create Promotion Stack @@ -160,7 +160,7 @@ namespace Example var apiInstance = new PromotionsApi(config); var campaignId = "campaignId_example"; // string | Unique campaign ID. - var promotionsStacksCreateRequestBody = new PromotionsStacksCreateRequestBody(); // PromotionsStacksCreateRequestBody | Specify the order of promotion tiers for the promotion stack. (optional) + var promotionsStacksCreateRequestBody = new PromotionsStacksCreateRequestBody(); // PromotionsStacksCreateRequestBody | Specify the order of promotion tiers for the promotion stack. try { @@ -204,7 +204,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignId** | **string** | Unique campaign ID. | | -| **promotionsStacksCreateRequestBody** | [**PromotionsStacksCreateRequestBody**](PromotionsStacksCreateRequestBody.md) | Specify the order of promotion tiers for the promotion stack. | [optional] | +| **promotionsStacksCreateRequestBody** | [**PromotionsStacksCreateRequestBody**](PromotionsStacksCreateRequestBody.md) | Specify the order of promotion tiers for the promotion stack. | | ### Return type @@ -1259,7 +1259,7 @@ catch (ApiException e) # **UpdatePromotionStack** -> PromotionsStacksUpdateResponseBody UpdatePromotionStack (string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody = null) +> PromotionsStacksUpdateResponseBody UpdatePromotionStack (string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody) Update Promotion Stack @@ -1295,7 +1295,7 @@ namespace Example var apiInstance = new PromotionsApi(config); var campaignId = "campaignId_example"; // string | ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. var stackId = "stackId_example"; // string | Promotion stack ID. - var promotionsStacksUpdateRequestBody = new PromotionsStacksUpdateRequestBody(); // PromotionsStacksUpdateRequestBody | Specify the promotion stack parameters that you would like to update. (optional) + var promotionsStacksUpdateRequestBody = new PromotionsStacksUpdateRequestBody(); // PromotionsStacksUpdateRequestBody | Specify the promotion stack parameters that you would like to update. try { @@ -1340,7 +1340,7 @@ catch (ApiException e) |------|------|-------------|-------| | **campaignId** | **string** | ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. | | | **stackId** | **string** | Promotion stack ID. | | -| **promotionsStacksUpdateRequestBody** | [**PromotionsStacksUpdateRequestBody**](PromotionsStacksUpdateRequestBody.md) | Specify the promotion stack parameters that you would like to update. | [optional] | +| **promotionsStacksUpdateRequestBody** | [**PromotionsStacksUpdateRequestBody**](PromotionsStacksUpdateRequestBody.md) | Specify the promotion stack parameters that you would like to update. | | ### Return type @@ -1365,7 +1365,7 @@ catch (ApiException e) # **UpdatePromotionTier** -> PromotionsTiersUpdateResponseBody UpdatePromotionTier (string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody = null) +> PromotionsTiersUpdateResponseBody UpdatePromotionTier (string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody) Update Promotion Tier @@ -1400,7 +1400,7 @@ namespace Example var apiInstance = new PromotionsApi(config); var promotionTierId = "promotionTierId_example"; // string | Unique promotion tier ID. - var promotionsTiersUpdateRequestBody = new PromotionsTiersUpdateRequestBody(); // PromotionsTiersUpdateRequestBody | Specify the promotion tier parameters that you would like to update. (optional) + var promotionsTiersUpdateRequestBody = new PromotionsTiersUpdateRequestBody(); // PromotionsTiersUpdateRequestBody | Specify the promotion tier parameters that you would like to update. try { @@ -1444,7 +1444,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **promotionTierId** | **string** | Unique promotion tier ID. | | -| **promotionsTiersUpdateRequestBody** | [**PromotionsTiersUpdateRequestBody**](PromotionsTiersUpdateRequestBody.md) | Specify the promotion tier parameters that you would like to update. | [optional] | +| **promotionsTiersUpdateRequestBody** | [**PromotionsTiersUpdateRequestBody**](PromotionsTiersUpdateRequestBody.md) | Specify the promotion tier parameters that you would like to update. | | ### Return type diff --git a/docs/PublicationsApi.md b/docs/PublicationsApi.md index d269556d..da20defc 100644 --- a/docs/PublicationsApi.md +++ b/docs/PublicationsApi.md @@ -10,7 +10,7 @@ All URIs are relative to *https://api.voucherify.io* # **CreatePublication** -> PublicationsCreateResponseBody CreatePublication (bool? joinOnce = null, PublicationsCreateRequestBody publicationsCreateRequestBody = null) +> PublicationsCreateResponseBody CreatePublication (PublicationsCreateRequestBody publicationsCreateRequestBody, bool? joinOnce = null) Create Publication @@ -44,13 +44,13 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new PublicationsApi(config); + var publicationsCreateRequestBody = new PublicationsCreateRequestBody(); // PublicationsCreateRequestBody | Specify the publication parameters. var joinOnce = true; // bool? | Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - var publicationsCreateRequestBody = new PublicationsCreateRequestBody(); // PublicationsCreateRequestBody | Specify the publication parameters. (optional) try { // Create Publication - PublicationsCreateResponseBody result = apiInstance.CreatePublication(joinOnce, publicationsCreateRequestBody); + PublicationsCreateResponseBody result = apiInstance.CreatePublication(publicationsCreateRequestBody, joinOnce); Debug.WriteLine(result); } catch (ApiException e) @@ -71,7 +71,7 @@ This returns an ApiResponse object which contains the response data, status code try { // Create Publication - ApiResponse response = apiInstance.CreatePublicationWithHttpInfo(joinOnce, publicationsCreateRequestBody); + ApiResponse response = apiInstance.CreatePublicationWithHttpInfo(publicationsCreateRequestBody, joinOnce); Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Response Headers: " + response.Headers); Debug.Write("Response Body: " + response.Data); @@ -88,8 +88,8 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| +| **publicationsCreateRequestBody** | [**PublicationsCreateRequestBody**](PublicationsCreateRequestBody.md) | Specify the publication parameters. | | | **joinOnce** | **bool?** | Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. | [optional] | -| **publicationsCreateRequestBody** | [**PublicationsCreateRequestBody**](PublicationsCreateRequestBody.md) | Specify the publication parameters. | [optional] | ### Return type diff --git a/docs/QualificationsApi.md b/docs/QualificationsApi.md index c6068715..1042470d 100644 --- a/docs/QualificationsApi.md +++ b/docs/QualificationsApi.md @@ -8,7 +8,7 @@ All URIs are relative to *https://api.voucherify.io* # **CheckEligibility** -> QualificationsCheckEligibilityResponseBody CheckEligibility (QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody = null) +> QualificationsCheckEligibilityResponseBody CheckEligibility (QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody) Check Eligibility @@ -42,7 +42,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new QualificationsApi(config); - var qualificationsCheckEligibilityRequestBody = new QualificationsCheckEligibilityRequestBody(); // QualificationsCheckEligibilityRequestBody | Define order and customer context. (optional) + var qualificationsCheckEligibilityRequestBody = new QualificationsCheckEligibilityRequestBody(); // QualificationsCheckEligibilityRequestBody | Define order and customer context. try { @@ -85,7 +85,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **qualificationsCheckEligibilityRequestBody** | [**QualificationsCheckEligibilityRequestBody**](QualificationsCheckEligibilityRequestBody.md) | Define order and customer context. | [optional] | +| **qualificationsCheckEligibilityRequestBody** | [**QualificationsCheckEligibilityRequestBody**](QualificationsCheckEligibilityRequestBody.md) | Define order and customer context. | | ### Return type diff --git a/docs/RedemptionsApi.md b/docs/RedemptionsApi.md index 864a539d..69617c90 100644 --- a/docs/RedemptionsApi.md +++ b/docs/RedemptionsApi.md @@ -333,11 +333,11 @@ catch (ApiException e) # **RedeemStackedDiscounts** -> RedemptionsRedeemResponseBody RedeemStackedDiscounts (RedemptionsRedeemRequestBody redemptionsRedeemRequestBody = null) +> RedemptionsRedeemResponseBody RedeemStackedDiscounts (RedemptionsRedeemRequestBody redemptionsRedeemRequestBody) Redeem Stackable Discounts -# How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. +# How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. ### Example ```csharp @@ -367,7 +367,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new RedemptionsApi(config); - var redemptionsRedeemRequestBody = new RedemptionsRedeemRequestBody(); // RedemptionsRedeemRequestBody | (optional) + var redemptionsRedeemRequestBody = new RedemptionsRedeemRequestBody(); // RedemptionsRedeemRequestBody | try { @@ -410,7 +410,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **redemptionsRedeemRequestBody** | [**RedemptionsRedeemRequestBody**](RedemptionsRedeemRequestBody.md) | | [optional] | +| **redemptionsRedeemRequestBody** | [**RedemptionsRedeemRequestBody**](RedemptionsRedeemRequestBody.md) | | | ### Return type @@ -435,7 +435,7 @@ catch (ApiException e) # **RollbackRedemption** -> RedemptionsRollbackCreateResponseBody RollbackRedemption (string redemptionId, string reason = null, string trackingId = null, RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody = null) +> RedemptionsRollbackCreateResponseBody RollbackRedemption (string redemptionId, RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody, string reason = null, string trackingId = null) Rollback Redemption @@ -470,14 +470,14 @@ namespace Example var apiInstance = new RedemptionsApi(config); var redemptionId = "redemptionId_example"; // string | The original redemption ID to be rolled back (undone). + var redemptionsRollbackCreateRequestBody = new RedemptionsRollbackCreateRequestBody(); // RedemptionsRollbackCreateRequestBody | Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. var reason = "reason_example"; // string | Reason for the rollback. (optional) var trackingId = "trackingId_example"; // string | Customers source_id. (optional) - var redemptionsRollbackCreateRequestBody = new RedemptionsRollbackCreateRequestBody(); // RedemptionsRollbackCreateRequestBody | Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) try { // Rollback Redemption - RedemptionsRollbackCreateResponseBody result = apiInstance.RollbackRedemption(redemptionId, reason, trackingId, redemptionsRollbackCreateRequestBody); + RedemptionsRollbackCreateResponseBody result = apiInstance.RollbackRedemption(redemptionId, redemptionsRollbackCreateRequestBody, reason, trackingId); Debug.WriteLine(result); } catch (ApiException e) @@ -498,7 +498,7 @@ This returns an ApiResponse object which contains the response data, status code try { // Rollback Redemption - ApiResponse response = apiInstance.RollbackRedemptionWithHttpInfo(redemptionId, reason, trackingId, redemptionsRollbackCreateRequestBody); + ApiResponse response = apiInstance.RollbackRedemptionWithHttpInfo(redemptionId, redemptionsRollbackCreateRequestBody, reason, trackingId); Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Response Headers: " + response.Headers); Debug.Write("Response Body: " + response.Data); @@ -516,9 +516,9 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **redemptionId** | **string** | The original redemption ID to be rolled back (undone). | | +| **redemptionsRollbackCreateRequestBody** | [**RedemptionsRollbackCreateRequestBody**](RedemptionsRollbackCreateRequestBody.md) | Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. | | | **reason** | **string** | Reason for the rollback. | [optional] | | **trackingId** | **string** | Customers source_id. | [optional] | -| **redemptionsRollbackCreateRequestBody** | [**RedemptionsRollbackCreateRequestBody**](RedemptionsRollbackCreateRequestBody.md) | Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. | [optional] | ### Return type @@ -543,7 +543,7 @@ catch (ApiException e) # **RollbackStackedRedemptions** -> RedemptionsRollbacksCreateResponseBody RollbackStackedRedemptions (string parentRedemptionId, string reason = null, string trackingId = null, RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody = null) +> RedemptionsRollbacksCreateResponseBody RollbackStackedRedemptions (string parentRedemptionId, RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody, string reason = null, string trackingId = null) Rollback Stackable Redemptions @@ -578,14 +578,14 @@ namespace Example var apiInstance = new RedemptionsApi(config); var parentRedemptionId = "parentRedemptionId_example"; // string | Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + var redemptionsRollbacksCreateRequestBody = new RedemptionsRollbacksCreateRequestBody(); // RedemptionsRollbacksCreateRequestBody | Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. var reason = "reason_example"; // string | Reason for the rollback. (optional) var trackingId = "trackingId_example"; // string | Customers source_id. (optional) - var redemptionsRollbacksCreateRequestBody = new RedemptionsRollbacksCreateRequestBody(); // RedemptionsRollbacksCreateRequestBody | Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) try { // Rollback Stackable Redemptions - RedemptionsRollbacksCreateResponseBody result = apiInstance.RollbackStackedRedemptions(parentRedemptionId, reason, trackingId, redemptionsRollbacksCreateRequestBody); + RedemptionsRollbacksCreateResponseBody result = apiInstance.RollbackStackedRedemptions(parentRedemptionId, redemptionsRollbacksCreateRequestBody, reason, trackingId); Debug.WriteLine(result); } catch (ApiException e) @@ -606,7 +606,7 @@ This returns an ApiResponse object which contains the response data, status code try { // Rollback Stackable Redemptions - ApiResponse response = apiInstance.RollbackStackedRedemptionsWithHttpInfo(parentRedemptionId, reason, trackingId, redemptionsRollbacksCreateRequestBody); + ApiResponse response = apiInstance.RollbackStackedRedemptionsWithHttpInfo(parentRedemptionId, redemptionsRollbacksCreateRequestBody, reason, trackingId); Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Response Headers: " + response.Headers); Debug.Write("Response Body: " + response.Data); @@ -624,9 +624,9 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **parentRedemptionId** | **string** | Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. | | +| **redemptionsRollbacksCreateRequestBody** | [**RedemptionsRollbacksCreateRequestBody**](RedemptionsRollbacksCreateRequestBody.md) | Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. | | | **reason** | **string** | Reason for the rollback. | [optional] | | **trackingId** | **string** | Customers source_id. | [optional] | -| **redemptionsRollbacksCreateRequestBody** | [**RedemptionsRollbacksCreateRequestBody**](RedemptionsRollbacksCreateRequestBody.md) | Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. | [optional] | ### Return type diff --git a/docs/ReferralProgramRefereeReward.md b/docs/ReferralProgramRefereeReward.md index 5510f49a..d1767ce1 100644 --- a/docs/ReferralProgramRefereeReward.md +++ b/docs/ReferralProgramRefereeReward.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **RelatedObjectParent** | [**ReferralProgramRefereeRewardRelatedObjectParent**](ReferralProgramRefereeRewardRelatedObjectParent.md) | | [optional] **Type** | **string** | Type of reward. | [optional] -**Amount** | **string** | Define the number of `points` to add to a loyalty card or `credits` to the balance on a gift card. In case of the gift card, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | [optional] +**Amount** | **int?** | Define the number of `points` to add to a loyalty card or `credits` to the balance on a gift card. In case of the gift card, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ReferralsApi.md b/docs/ReferralsApi.md index 3b2d93b3..c1de1f29 100644 --- a/docs/ReferralsApi.md +++ b/docs/ReferralsApi.md @@ -13,7 +13,7 @@ All URIs are relative to *https://api.voucherify.io* # **ReferralsAddHolders** -> ReferralsMembersHoldersCreateInBulkResponseBody ReferralsAddHolders (string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = null) +> ReferralsMembersHoldersCreateInBulkResponseBody ReferralsAddHolders (string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody) Add Referral Code Holders @@ -48,7 +48,7 @@ namespace Example var apiInstance = new ReferralsApi(config); var memberId = "memberId_example"; // string | Unique referral code or its identifier. - var referralsMembersHoldersCreateInBulkRequestBody = new ReferralsMembersHoldersCreateInBulkRequestBody(); // ReferralsMembersHoldersCreateInBulkRequestBody | Specify the customer data to be upserted as redeemable holders. (optional) + var referralsMembersHoldersCreateInBulkRequestBody = new ReferralsMembersHoldersCreateInBulkRequestBody(); // ReferralsMembersHoldersCreateInBulkRequestBody | Specify the customer data to be upserted as redeemable holders. try { @@ -92,7 +92,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **memberId** | **string** | Unique referral code or its identifier. | | -| **referralsMembersHoldersCreateInBulkRequestBody** | [**ReferralsMembersHoldersCreateInBulkRequestBody**](ReferralsMembersHoldersCreateInBulkRequestBody.md) | Specify the customer data to be upserted as redeemable holders. | [optional] | +| **referralsMembersHoldersCreateInBulkRequestBody** | [**ReferralsMembersHoldersCreateInBulkRequestBody**](ReferralsMembersHoldersCreateInBulkRequestBody.md) | Specify the customer data to be upserted as redeemable holders. | | ### Return type @@ -117,7 +117,7 @@ catch (ApiException e) # **ReferralsAddHolders1** -> ReferralsMembersHoldersCreateInBulkResponseBody ReferralsAddHolders1 (string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = null) +> ReferralsMembersHoldersCreateInBulkResponseBody ReferralsAddHolders1 (string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody) Add Referral Code Holders with Campaign ID @@ -153,7 +153,7 @@ namespace Example var apiInstance = new ReferralsApi(config); var campaignId = "campaignId_example"; // string | Unique identifier of a referral program campaign. var memberId = "memberId_example"; // string | Unique referral code or its identifier. - var referralsMembersHoldersCreateInBulkRequestBody = new ReferralsMembersHoldersCreateInBulkRequestBody(); // ReferralsMembersHoldersCreateInBulkRequestBody | Specify the customer data to be upserted as redeemable holders. (optional) + var referralsMembersHoldersCreateInBulkRequestBody = new ReferralsMembersHoldersCreateInBulkRequestBody(); // ReferralsMembersHoldersCreateInBulkRequestBody | Specify the customer data to be upserted as redeemable holders. try { @@ -198,7 +198,7 @@ catch (ApiException e) |------|------|-------------|-------| | **campaignId** | **string** | Unique identifier of a referral program campaign. | | | **memberId** | **string** | Unique referral code or its identifier. | | -| **referralsMembersHoldersCreateInBulkRequestBody** | [**ReferralsMembersHoldersCreateInBulkRequestBody**](ReferralsMembersHoldersCreateInBulkRequestBody.md) | Specify the customer data to be upserted as redeemable holders. | [optional] | +| **referralsMembersHoldersCreateInBulkRequestBody** | [**ReferralsMembersHoldersCreateInBulkRequestBody**](ReferralsMembersHoldersCreateInBulkRequestBody.md) | Specify the customer data to be upserted as redeemable holders. | | ### Return type diff --git a/docs/RewardsApi.md b/docs/RewardsApi.md index 24aca9cb..0fefaa7d 100644 --- a/docs/RewardsApi.md +++ b/docs/RewardsApi.md @@ -17,7 +17,7 @@ All URIs are relative to *https://api.voucherify.io* # **CreateReward** -> RewardsCreateResponseBody CreateReward (RewardsCreateRequestBody rewardsCreateRequestBody = null) +> RewardsCreateResponseBody CreateReward (RewardsCreateRequestBody rewardsCreateRequestBody) Create Reward @@ -51,7 +51,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new RewardsApi(config); - var rewardsCreateRequestBody = new RewardsCreateRequestBody(); // RewardsCreateRequestBody | Define parameters of the new reward. (optional) + var rewardsCreateRequestBody = new RewardsCreateRequestBody(); // RewardsCreateRequestBody | Define parameters of the new reward. try { @@ -94,7 +94,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **rewardsCreateRequestBody** | [**RewardsCreateRequestBody**](RewardsCreateRequestBody.md) | Define parameters of the new reward. | [optional] | +| **rewardsCreateRequestBody** | [**RewardsCreateRequestBody**](RewardsCreateRequestBody.md) | Define parameters of the new reward. | | ### Return type @@ -119,7 +119,7 @@ catch (ApiException e) # **CreateRewardAssignment** -> RewardsAssignmentsCreateResponseBody CreateRewardAssignment (string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody = null) +> RewardsAssignmentsCreateResponseBody CreateRewardAssignment (string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody) Create Reward Assignment @@ -154,7 +154,7 @@ namespace Example var apiInstance = new RewardsApi(config); var rewardId = "rewardId_example"; // string | A unique reward ID. - var rewardsAssignmentsCreateRequestBody = new RewardsAssignmentsCreateRequestBody(); // RewardsAssignmentsCreateRequestBody | Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + var rewardsAssignmentsCreateRequestBody = new RewardsAssignmentsCreateRequestBody(); // RewardsAssignmentsCreateRequestBody | Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. try { @@ -198,7 +198,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **rewardId** | **string** | A unique reward ID. | | -| **rewardsAssignmentsCreateRequestBody** | [**RewardsAssignmentsCreateRequestBody**](RewardsAssignmentsCreateRequestBody.md) | Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. | [optional] | +| **rewardsAssignmentsCreateRequestBody** | [**RewardsAssignmentsCreateRequestBody**](RewardsAssignmentsCreateRequestBody.md) | Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. | | ### Return type @@ -839,7 +839,7 @@ catch (ApiException e) # **UpdateReward** -> RewardsUpdateResponseBody UpdateReward (string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody = null) +> RewardsUpdateResponseBody UpdateReward (string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody) Update Reward @@ -874,7 +874,7 @@ namespace Example var apiInstance = new RewardsApi(config); var rewardId = "rewardId_example"; // string | A unique reward ID. - var rewardsUpdateRequestBody = new RewardsUpdateRequestBody(); // RewardsUpdateRequestBody | Define the parameters to be updated for the reward. (optional) + var rewardsUpdateRequestBody = new RewardsUpdateRequestBody(); // RewardsUpdateRequestBody | Define the parameters to be updated for the reward. try { @@ -918,7 +918,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **rewardId** | **string** | A unique reward ID. | | -| **rewardsUpdateRequestBody** | [**RewardsUpdateRequestBody**](RewardsUpdateRequestBody.md) | Define the parameters to be updated for the reward. | [optional] | +| **rewardsUpdateRequestBody** | [**RewardsUpdateRequestBody**](RewardsUpdateRequestBody.md) | Define the parameters to be updated for the reward. | | ### Return type @@ -943,7 +943,7 @@ catch (ApiException e) # **UpdateRewardAssignment** -> RewardsAssignmentsUpdateResponseBody UpdateRewardAssignment (string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody = null) +> RewardsAssignmentsUpdateResponseBody UpdateRewardAssignment (string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody) Update Reward Assignment @@ -979,7 +979,7 @@ namespace Example var apiInstance = new RewardsApi(config); var rewardId = "rewardId_example"; // string | A unique reward ID. var assignmentId = "assignmentId_example"; // string | A unique reward assignment ID. - var rewardsAssignmentsUpdateRequestBody = new RewardsAssignmentsUpdateRequestBody(); // RewardsAssignmentsUpdateRequestBody | Define the number of points required to exchange for the reward. (optional) + var rewardsAssignmentsUpdateRequestBody = new RewardsAssignmentsUpdateRequestBody(); // RewardsAssignmentsUpdateRequestBody | Define the number of points required to exchange for the reward. try { @@ -1024,7 +1024,7 @@ catch (ApiException e) |------|------|-------------|-------| | **rewardId** | **string** | A unique reward ID. | | | **assignmentId** | **string** | A unique reward assignment ID. | | -| **rewardsAssignmentsUpdateRequestBody** | [**RewardsAssignmentsUpdateRequestBody**](RewardsAssignmentsUpdateRequestBody.md) | Define the number of points required to exchange for the reward. | [optional] | +| **rewardsAssignmentsUpdateRequestBody** | [**RewardsAssignmentsUpdateRequestBody**](RewardsAssignmentsUpdateRequestBody.md) | Define the number of points required to exchange for the reward. | | ### Return type diff --git a/docs/RewardsCreateRequestBodyParametersCampaign.md b/docs/RewardsCreateRequestBodyParametersCampaign.md index 3c13a786..7cca02c7 100644 --- a/docs/RewardsCreateRequestBodyParametersCampaign.md +++ b/docs/RewardsCreateRequestBodyParametersCampaign.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **string** | | [optional] -**Balance** | **int?** | The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] +**Balance** | **int?** | The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SegmentsApi.md b/docs/SegmentsApi.md index fda2749b..632ca1dc 100644 --- a/docs/SegmentsApi.md +++ b/docs/SegmentsApi.md @@ -10,7 +10,7 @@ All URIs are relative to *https://api.voucherify.io* # **CreateSegment** -> SegmentsCreateResponseBody CreateSegment (SegmentsCreateRequestBody segmentsCreateRequestBody = null) +> SegmentsCreateResponseBody CreateSegment (SegmentsCreateRequestBody segmentsCreateRequestBody) Create Segment @@ -44,7 +44,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new SegmentsApi(config); - var segmentsCreateRequestBody = new SegmentsCreateRequestBody(); // SegmentsCreateRequestBody | Specify the boundary conditions for the customer segment. (optional) + var segmentsCreateRequestBody = new SegmentsCreateRequestBody(); // SegmentsCreateRequestBody | Specify the boundary conditions for the customer segment. try { @@ -87,7 +87,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **segmentsCreateRequestBody** | [**SegmentsCreateRequestBody**](SegmentsCreateRequestBody.md) | Specify the boundary conditions for the customer segment. | [optional] | +| **segmentsCreateRequestBody** | [**SegmentsCreateRequestBody**](SegmentsCreateRequestBody.md) | Specify the boundary conditions for the customer segment. | | ### Return type diff --git a/docs/SegmentsCreateResponseBody.md b/docs/SegmentsCreateResponseBody.md index e3df1a34..a7c6f13c 100644 --- a/docs/SegmentsCreateResponseBody.md +++ b/docs/SegmentsCreateResponseBody.md @@ -10,7 +10,6 @@ Name | Type | Description | Notes **CreatedAt** | **DateTimeOffset?** | Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format. | [optional] **Type** | **string** | Defines whether the segment is: - Active (`auto-update`): customers enter and leave the segment based on the defined filters and the `customer.segment.entered` and `customer.segment.left` events are triggered, - Passive (`passive`): customers enter and leave the segment based on the defined filters, but the `customer.segment.entered` and `customer.segment.left` events are not triggered, - Static (`static`): manually selected customers. | [optional] **Filter** | **Object** | Defines a set of criteria for an `auto-update` or `passive` segment type. | [optional] -**InitialSyncStatus** | **string** | | [optional] **Object** | **string** | The type of the object represented by JSON. This object stores information about the customer segment. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SegmentsGetResponseBody.md b/docs/SegmentsGetResponseBody.md index 47bbf9a6..2085bfe3 100644 --- a/docs/SegmentsGetResponseBody.md +++ b/docs/SegmentsGetResponseBody.md @@ -10,7 +10,6 @@ Name | Type | Description | Notes **CreatedAt** | **DateTimeOffset?** | Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format. | [optional] **Type** | **string** | Defines whether the segment is: - Active (`auto-update`): customers enter and leave the segment based on the defined filters and the `customer.segment.entered` and `customer.segment.left` events are triggered, - Passive (`passive`): customers enter and leave the segment based on the defined filters, but the `customer.segment.entered` and `customer.segment.left` events are not triggered, - Static (`static`): manually selected customers. | [optional] **Filter** | **Object** | Defines a set of criteria for an `auto-update` or `passive` segment type. | [optional] -**InitialSyncStatus** | **string** | | [optional] **Object** | **string** | The type of the object represented by JSON. This object stores information about the customer segment. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TemplatesApi.md b/docs/TemplatesApi.md index 4efd3056..f93807df 100644 --- a/docs/TemplatesApi.md +++ b/docs/TemplatesApi.md @@ -14,7 +14,7 @@ All URIs are relative to *https://api.voucherify.io* # **AddTierFromTemplate** -> TemplatesCampaignsTierSetupCreateResponseBody AddTierFromTemplate (string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody = null) +> TemplatesCampaignsTierSetupCreateResponseBody AddTierFromTemplate (string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody) Add Promotion Tier From Template @@ -49,7 +49,7 @@ namespace Example var apiInstance = new TemplatesApi(config); var campaignTemplateId = "campaignTemplateId_example"; // string | Pass the campaign template ID that was assigned by Voucherify. - var templatesCampaignsTierSetupCreateRequestBody = new TemplatesCampaignsTierSetupCreateRequestBody(); // TemplatesCampaignsTierSetupCreateRequestBody | Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + var templatesCampaignsTierSetupCreateRequestBody = new TemplatesCampaignsTierSetupCreateRequestBody(); // TemplatesCampaignsTierSetupCreateRequestBody | Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. try { @@ -93,7 +93,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignTemplateId** | **string** | Pass the campaign template ID that was assigned by Voucherify. | | -| **templatesCampaignsTierSetupCreateRequestBody** | [**TemplatesCampaignsTierSetupCreateRequestBody**](TemplatesCampaignsTierSetupCreateRequestBody.md) | Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. | [optional] | +| **templatesCampaignsTierSetupCreateRequestBody** | [**TemplatesCampaignsTierSetupCreateRequestBody**](TemplatesCampaignsTierSetupCreateRequestBody.md) | Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. | | ### Return type @@ -118,7 +118,7 @@ catch (ApiException e) # **CreateCampaignFromTemplate** -> TemplatesCampaignsCampaignSetupCreateResponseBody CreateCampaignFromTemplate (string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody = null) +> TemplatesCampaignsCampaignSetupCreateResponseBody CreateCampaignFromTemplate (string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody) Create Campaign From Template @@ -153,7 +153,7 @@ namespace Example var apiInstance = new TemplatesApi(config); var campaignTemplateId = "campaignTemplateId_example"; // string | Pass the campaign template ID that was assigned by Voucherify. - var templatesCampaignsCampaignSetupCreateRequestBody = new TemplatesCampaignsCampaignSetupCreateRequestBody(); // TemplatesCampaignsCampaignSetupCreateRequestBody | Only name is required. The rest of the fields will overwrite the template configuration. (optional) + var templatesCampaignsCampaignSetupCreateRequestBody = new TemplatesCampaignsCampaignSetupCreateRequestBody(); // TemplatesCampaignsCampaignSetupCreateRequestBody | Only name is required. The rest of the fields will overwrite the template configuration. try { @@ -197,7 +197,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignTemplateId** | **string** | Pass the campaign template ID that was assigned by Voucherify. | | -| **templatesCampaignsCampaignSetupCreateRequestBody** | [**TemplatesCampaignsCampaignSetupCreateRequestBody**](TemplatesCampaignsCampaignSetupCreateRequestBody.md) | Only name is required. The rest of the fields will overwrite the template configuration. | [optional] | +| **templatesCampaignsCampaignSetupCreateRequestBody** | [**TemplatesCampaignsCampaignSetupCreateRequestBody**](TemplatesCampaignsCampaignSetupCreateRequestBody.md) | Only name is required. The rest of the fields will overwrite the template configuration. | | ### Return type @@ -222,7 +222,7 @@ catch (ApiException e) # **CreateCampaignTemplate** -> TemplatesCampaignsCreateTemplateResponseBody CreateCampaignTemplate (TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody = null) +> TemplatesCampaignsCreateTemplateResponseBody CreateCampaignTemplate (TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody) Create Campaign Template @@ -256,7 +256,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new TemplatesApi(config); - var templatesCampaignsCreateRequestBody = new TemplatesCampaignsCreateRequestBody(); // TemplatesCampaignsCreateRequestBody | Provide details for a campaign template (optional) + var templatesCampaignsCreateRequestBody = new TemplatesCampaignsCreateRequestBody(); // TemplatesCampaignsCreateRequestBody | Provide details for a campaign template try { @@ -299,7 +299,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **templatesCampaignsCreateRequestBody** | [**TemplatesCampaignsCreateRequestBody**](TemplatesCampaignsCreateRequestBody.md) | Provide details for a campaign template | [optional] | +| **templatesCampaignsCreateRequestBody** | [**TemplatesCampaignsCreateRequestBody**](TemplatesCampaignsCreateRequestBody.md) | Provide details for a campaign template | | ### Return type @@ -634,7 +634,7 @@ catch (ApiException e) # **UpdateCampaignTemplate** -> TemplatesCampaignsUpdateResponseBody UpdateCampaignTemplate (string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody = null) +> TemplatesCampaignsUpdateResponseBody UpdateCampaignTemplate (string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody) Update Campaign Template @@ -669,7 +669,7 @@ namespace Example var apiInstance = new TemplatesApi(config); var campaignTemplateId = "campaignTemplateId_example"; // string | Pass the campaign template ID that was assigned by Voucherify. - var templatesCampaignsUpdateRequestBody = new TemplatesCampaignsUpdateRequestBody(); // TemplatesCampaignsUpdateRequestBody | Provide the new name or description for the campaign template (optional) + var templatesCampaignsUpdateRequestBody = new TemplatesCampaignsUpdateRequestBody(); // TemplatesCampaignsUpdateRequestBody | Provide the new name or description for the campaign template try { @@ -713,7 +713,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **campaignTemplateId** | **string** | Pass the campaign template ID that was assigned by Voucherify. | | -| **templatesCampaignsUpdateRequestBody** | [**TemplatesCampaignsUpdateRequestBody**](TemplatesCampaignsUpdateRequestBody.md) | Provide the new name or description for the campaign template | [optional] | +| **templatesCampaignsUpdateRequestBody** | [**TemplatesCampaignsUpdateRequestBody**](TemplatesCampaignsUpdateRequestBody.md) | Provide the new name or description for the campaign template | | ### Return type diff --git a/docs/ValidationRulesApi.md b/docs/ValidationRulesApi.md index 637466b6..9a5d7aed 100644 --- a/docs/ValidationRulesApi.md +++ b/docs/ValidationRulesApi.md @@ -16,7 +16,7 @@ All URIs are relative to *https://api.voucherify.io* # **CreateValidationRuleAssignment** -> ValidationRulesAssignmentsCreateResponseBody CreateValidationRuleAssignment (string validationRuleId, bool? force = null, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody = null) +> ValidationRulesAssignmentsCreateResponseBody CreateValidationRuleAssignment (string validationRuleId, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody, bool? force = null) Create Validation Rules Assignments @@ -51,13 +51,13 @@ namespace Example var apiInstance = new ValidationRulesApi(config); var validationRuleId = "validationRuleId_example"; // string | Unique validation rule ID. + var validationRulesAssignmentsCreateRequestBody = new ValidationRulesAssignmentsCreateRequestBody(); // ValidationRulesAssignmentsCreateRequestBody | Specify the resource that you would like to assign the validation rule to. var force = true; // bool? | If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - var validationRulesAssignmentsCreateRequestBody = new ValidationRulesAssignmentsCreateRequestBody(); // ValidationRulesAssignmentsCreateRequestBody | Specify the resource that you would like to assign the validation rule to. (optional) try { // Create Validation Rules Assignments - ValidationRulesAssignmentsCreateResponseBody result = apiInstance.CreateValidationRuleAssignment(validationRuleId, force, validationRulesAssignmentsCreateRequestBody); + ValidationRulesAssignmentsCreateResponseBody result = apiInstance.CreateValidationRuleAssignment(validationRuleId, validationRulesAssignmentsCreateRequestBody, force); Debug.WriteLine(result); } catch (ApiException e) @@ -78,7 +78,7 @@ This returns an ApiResponse object which contains the response data, status code try { // Create Validation Rules Assignments - ApiResponse response = apiInstance.CreateValidationRuleAssignmentWithHttpInfo(validationRuleId, force, validationRulesAssignmentsCreateRequestBody); + ApiResponse response = apiInstance.CreateValidationRuleAssignmentWithHttpInfo(validationRuleId, validationRulesAssignmentsCreateRequestBody, force); Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Response Headers: " + response.Headers); Debug.Write("Response Body: " + response.Data); @@ -96,8 +96,8 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **validationRuleId** | **string** | Unique validation rule ID. | | +| **validationRulesAssignmentsCreateRequestBody** | [**ValidationRulesAssignmentsCreateRequestBody**](ValidationRulesAssignmentsCreateRequestBody.md) | Specify the resource that you would like to assign the validation rule to. | | | **force** | **bool?** | If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. | [optional] | -| **validationRulesAssignmentsCreateRequestBody** | [**ValidationRulesAssignmentsCreateRequestBody**](ValidationRulesAssignmentsCreateRequestBody.md) | Specify the resource that you would like to assign the validation rule to. | [optional] | ### Return type @@ -122,7 +122,7 @@ catch (ApiException e) # **CreateValidationRules** -> ValidationRulesCreateResponseBody CreateValidationRules (ValidationRulesCreateRequestBody validationRulesCreateRequestBody = null) +> ValidationRulesCreateResponseBody CreateValidationRules (ValidationRulesCreateRequestBody validationRulesCreateRequestBody) Create Validation Rules @@ -156,7 +156,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new ValidationRulesApi(config); - var validationRulesCreateRequestBody = new ValidationRulesCreateRequestBody(); // ValidationRulesCreateRequestBody | Specify the validation rules parameters. (optional) + var validationRulesCreateRequestBody = new ValidationRulesCreateRequestBody(); // ValidationRulesCreateRequestBody | Specify the validation rules parameters. try { @@ -199,7 +199,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **validationRulesCreateRequestBody** | [**ValidationRulesCreateRequestBody**](ValidationRulesCreateRequestBody.md) | Specify the validation rules parameters. | [optional] | +| **validationRulesCreateRequestBody** | [**ValidationRulesCreateRequestBody**](ValidationRulesCreateRequestBody.md) | Specify the validation rules parameters. | | ### Return type @@ -852,7 +852,7 @@ catch (ApiException e) # **UpdateValidationRule** -> ValidationRulesUpdateResponseBody UpdateValidationRule (string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody = null) +> ValidationRulesUpdateResponseBody UpdateValidationRule (string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody) Update Validation Rule @@ -887,7 +887,7 @@ namespace Example var apiInstance = new ValidationRulesApi(config); var validationRuleId = "validationRuleId_example"; // string | A unique validation rule ID. - var validationRulesUpdateRequestBody = new ValidationRulesUpdateRequestBody(); // ValidationRulesUpdateRequestBody | Specify the parameters to be updated. (optional) + var validationRulesUpdateRequestBody = new ValidationRulesUpdateRequestBody(); // ValidationRulesUpdateRequestBody | Specify the parameters to be updated. try { @@ -931,7 +931,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **validationRuleId** | **string** | A unique validation rule ID. | | -| **validationRulesUpdateRequestBody** | [**ValidationRulesUpdateRequestBody**](ValidationRulesUpdateRequestBody.md) | Specify the parameters to be updated. | [optional] | +| **validationRulesUpdateRequestBody** | [**ValidationRulesUpdateRequestBody**](ValidationRulesUpdateRequestBody.md) | Specify the parameters to be updated. | | ### Return type diff --git a/docs/ValidationsApi.md b/docs/ValidationsApi.md index 37d159dd..720b4ad5 100644 --- a/docs/ValidationsApi.md +++ b/docs/ValidationsApi.md @@ -8,7 +8,7 @@ All URIs are relative to *https://api.voucherify.io* # **ValidateStackedDiscounts** -> ValidationsValidateResponseBody ValidateStackedDiscounts (ValidationsValidateRequestBody validationsValidateRequestBody = null) +> ValidationsValidateResponseBody ValidateStackedDiscounts (ValidationsValidateRequestBody validationsValidateRequestBody) Validate Stackable Discounts @@ -42,7 +42,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new ValidationsApi(config); - var validationsValidateRequestBody = new ValidationsValidateRequestBody(); // ValidationsValidateRequestBody | (optional) + var validationsValidateRequestBody = new ValidationsValidateRequestBody(); // ValidationsValidateRequestBody | try { @@ -85,7 +85,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **validationsValidateRequestBody** | [**ValidationsValidateRequestBody**](ValidationsValidateRequestBody.md) | | [optional] | +| **validationsValidateRequestBody** | [**ValidationsValidateRequestBody**](ValidationsValidateRequestBody.md) | | | ### Return type diff --git a/docs/ValidationsValidateRequestBody.md b/docs/ValidationsValidateRequestBody.md index d4509a84..f9a7ea69 100644 --- a/docs/ValidationsValidateRequestBody.md +++ b/docs/ValidationsValidateRequestBody.md @@ -1,5 +1,5 @@ # Voucherify.Model.ValidationsValidateRequestBody -Response body schema for **POST** `v1/validations`. +Request body schema for **POST** `v1/validations`. ## Properties diff --git a/docs/ValidityHours.md b/docs/ValidityHours.md index 8cb605a5..a8b1104a 100644 --- a/docs/ValidityHours.md +++ b/docs/ValidityHours.md @@ -5,7 +5,7 @@ Determines the hours of validity, e.g. to create a happy hours scenario. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Daily** | [**List<ValidityHoursDailyItem>**](ValidityHoursDailyItem.md) | Defines the reccuring period(s) when the resource is active. The periods should not overlap. | [optional] +**Daily** | [**List<ValidityHoursDailyItem>**](ValidityHoursDailyItem.md) | Defines the recurring period(s) when the resource is active. The periods should not overlap. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ValidityHoursDailyItem.md b/docs/ValidityHoursDailyItem.md index fa22435a..2d28af5e 100644 --- a/docs/ValidityHoursDailyItem.md +++ b/docs/ValidityHoursDailyItem.md @@ -1,5 +1,5 @@ # Voucherify.Model.ValidityHoursDailyItem -Defines the reccuring period(s) when the resource will be active. +Defines the recurring period(s) when the resource will be active. ## Properties diff --git a/docs/VoucherTransaction.md b/docs/VoucherTransaction.md index bf02d5dd..3d19d0eb 100644 --- a/docs/VoucherTransaction.md +++ b/docs/VoucherTransaction.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **SourceId** | **string** | The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null. | [optional] **VoucherId** | **string** | Unique voucher ID. | [optional] **CampaignId** | **string** | Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes. | [optional] -**Source** | **string** | The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. | [optional] +**Source** | **string** | The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. | [optional] **Reason** | **string** | Reason why the transaction occurred. In case of a redemption, this value is null. | [optional] **RelatedTransactionId** | **string** | The related transaction ID on the receiving card. | [optional] **CreatedAt** | **DateTimeOffset?** | Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format. | [optional] diff --git a/docs/VouchersApi.md b/docs/VouchersApi.md index 74d0fc0a..ff261d4a 100644 --- a/docs/VouchersApi.md +++ b/docs/VouchersApi.md @@ -23,7 +23,7 @@ All URIs are relative to *https://api.voucherify.io* # **CreateVoucher** -> VouchersCreateResponseBody CreateVoucher (string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody = null) +> VouchersCreateResponseBody CreateVoucher (string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody) Create Voucher @@ -58,7 +58,7 @@ namespace Example var apiInstance = new VouchersApi(config); var code = "code_example"; // string | A unique **code** that identifies the voucher. - var vouchersCreateWithSpecificCodeRequestBody = new VouchersCreateWithSpecificCodeRequestBody(); // VouchersCreateWithSpecificCodeRequestBody | Specify the details of the voucher that you would like to create. (optional) + var vouchersCreateWithSpecificCodeRequestBody = new VouchersCreateWithSpecificCodeRequestBody(); // VouchersCreateWithSpecificCodeRequestBody | Specify the details of the voucher that you would like to create. try { @@ -102,7 +102,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **code** | **string** | A unique **code** that identifies the voucher. | | -| **vouchersCreateWithSpecificCodeRequestBody** | [**VouchersCreateWithSpecificCodeRequestBody**](VouchersCreateWithSpecificCodeRequestBody.md) | Specify the details of the voucher that you would like to create. | [optional] | +| **vouchersCreateWithSpecificCodeRequestBody** | [**VouchersCreateWithSpecificCodeRequestBody**](VouchersCreateWithSpecificCodeRequestBody.md) | Specify the details of the voucher that you would like to create. | | ### Return type @@ -431,7 +431,7 @@ catch (ApiException e) # **ExportVoucherTransactions** -> VouchersTransactionsExportCreateResponseBody ExportVoucherTransactions (string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody = null) +> VouchersTransactionsExportCreateResponseBody ExportVoucherTransactions (string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody) Export Voucher Transactions @@ -466,7 +466,7 @@ namespace Example var apiInstance = new VouchersApi(config); var code = GIFT-CARD-1; // string | A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - var vouchersTransactionsExportCreateRequestBody = new VouchersTransactionsExportCreateRequestBody(); // VouchersTransactionsExportCreateRequestBody | Specify the parameters for the camapign transaction export. (optional) + var vouchersTransactionsExportCreateRequestBody = new VouchersTransactionsExportCreateRequestBody(); // VouchersTransactionsExportCreateRequestBody | Specify the parameters for the camapign transaction export. try { @@ -510,7 +510,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **code** | **string** | A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. | | -| **vouchersTransactionsExportCreateRequestBody** | [**VouchersTransactionsExportCreateRequestBody**](VouchersTransactionsExportCreateRequestBody.md) | Specify the parameters for the camapign transaction export. | [optional] | +| **vouchersTransactionsExportCreateRequestBody** | [**VouchersTransactionsExportCreateRequestBody**](VouchersTransactionsExportCreateRequestBody.md) | Specify the parameters for the camapign transaction export. | | ### Return type @@ -535,7 +535,7 @@ catch (ApiException e) # **GenerateRandomCode** -> VouchersCreateResponseBody GenerateRandomCode (VouchersCreateRequestBody vouchersCreateRequestBody = null) +> VouchersCreateResponseBody GenerateRandomCode (VouchersCreateRequestBody vouchersCreateRequestBody) Generate Random Code @@ -569,7 +569,7 @@ namespace Example config.AccessToken = "YOUR_ACCESS_TOKEN"; var apiInstance = new VouchersApi(config); - var vouchersCreateRequestBody = new VouchersCreateRequestBody(); // VouchersCreateRequestBody | Specify the details of the voucher that you would like to create. (optional) + var vouchersCreateRequestBody = new VouchersCreateRequestBody(); // VouchersCreateRequestBody | Specify the details of the voucher that you would like to create. try { @@ -612,7 +612,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **vouchersCreateRequestBody** | [**VouchersCreateRequestBody**](VouchersCreateRequestBody.md) | Specify the details of the voucher that you would like to create. | [optional] | +| **vouchersCreateRequestBody** | [**VouchersCreateRequestBody**](VouchersCreateRequestBody.md) | Specify the details of the voucher that you would like to create. | | ### Return type @@ -743,7 +743,7 @@ catch (ApiException e) Import Vouchers -Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. +Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. ### Example ```csharp @@ -845,7 +845,7 @@ catch (ApiException e) Import Vouchers using CSV -Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. +Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. ### Example ```csharp @@ -1053,7 +1053,7 @@ catch (ApiException e) # **ListVouchers** -> VouchersListResponseBody ListVouchers (int? limit = null, int? page = null, string category = null, string campaignId = null, string customer = null, string campaign = null, ParameterCreatedBeforeAfter createdAt = null, ParameterUpdatedBeforeAfter updatedAt = null, ParameterOrderVouchers? order = null, string code = null, List ids = null) +> VouchersListResponseBody ListVouchers (int? limit = null, int? page = null, string category = null, string campaignId = null, string customer = null, string campaign = null, ParameterCreatedBeforeAfter createdAt = null, ParameterUpdatedBeforeAfter updatedAt = null, ParameterOrderVouchers? order = null, string code = null, List ids = null, Object filters = null) List Vouchers @@ -1098,11 +1098,12 @@ namespace Example var order = (ParameterOrderVouchers) "created_at"; // ParameterOrderVouchers? | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) var code = "code_example"; // string | (optional) var ids = new List(); // List | (optional) + var filters = new Object(); // Object | Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) try { // List Vouchers - VouchersListResponseBody result = apiInstance.ListVouchers(limit, page, category, campaignId, customer, campaign, createdAt, updatedAt, order, code, ids); + VouchersListResponseBody result = apiInstance.ListVouchers(limit, page, category, campaignId, customer, campaign, createdAt, updatedAt, order, code, ids, filters); Debug.WriteLine(result); } catch (ApiException e) @@ -1123,7 +1124,7 @@ This returns an ApiResponse object which contains the response data, status code try { // List Vouchers - ApiResponse response = apiInstance.ListVouchersWithHttpInfo(limit, page, category, campaignId, customer, campaign, createdAt, updatedAt, order, code, ids); + ApiResponse response = apiInstance.ListVouchersWithHttpInfo(limit, page, category, campaignId, customer, campaign, createdAt, updatedAt, order, code, ids, filters); Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Response Headers: " + response.Headers); Debug.Write("Response Body: " + response.Data); @@ -1151,6 +1152,7 @@ catch (ApiException e) | **order** | **ParameterOrderVouchers?** | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] | | **code** | **string** | | [optional] | | **ids** | [**List<string>**](string.md) | | [optional] | +| **filters** | [**Object**](Object.md) | Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. | [optional] | ### Return type diff --git a/lib/net9.0/Voucherify.deps.json b/lib/net9.0/Voucherify.deps.json index c2cf5d6e..f05ddd0c 100644 --- a/lib/net9.0/Voucherify.deps.json +++ b/lib/net9.0/Voucherify.deps.json @@ -6,7 +6,7 @@ "compilationOptions": {}, "targets": { ".NETCoreApp,Version=v9.0": { - "Voucherify/8.1.0": { + "Voucherify/9.0.0": { "dependencies": { "JsonSubTypes": "2.0.1", "Microsoft.Extensions.DependencyInjection": "9.0.10", @@ -478,7 +478,7 @@ } }, "libraries": { - "Voucherify/8.1.0": { + "Voucherify/9.0.0": { "type": "project", "serviceable": false, "sha512": "" diff --git a/lib/net9.0/Voucherify.dll b/lib/net9.0/Voucherify.dll index 3081361f..f2cc01bd 100644 Binary files a/lib/net9.0/Voucherify.dll and b/lib/net9.0/Voucherify.dll differ diff --git a/lib/net9.0/Voucherify.xml b/lib/net9.0/Voucherify.xml index c39e3474..872b8003 100644 --- a/lib/net9.0/Voucherify.xml +++ b/lib/net9.0/Voucherify.xml @@ -555,7 +555,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. CampaignsVouchersCreateResponseBody @@ -569,11 +569,11 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. ApiResponse of CampaignsVouchersCreateResponseBody - + Add Vouchers to Campaign @@ -582,12 +582,12 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign @@ -596,8 +596,8 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. ApiResponse of CampaignsVouchersCreateCombinedResponseBody @@ -609,7 +609,7 @@ Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. CampaignsCreateResponseBody @@ -621,7 +621,7 @@ Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. ApiResponse of CampaignsCreateResponseBody @@ -708,7 +708,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. CampaignsTransactionsExportCreateResponseBody @@ -721,7 +721,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. ApiResponse of CampaignsTransactionsExportCreateResponseBody @@ -786,7 +786,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. CampaignsImportCreateResponseBody @@ -799,7 +799,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. ApiResponse of CampaignsImportCreateResponseBody @@ -910,7 +910,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. CampaignsUpdateResponseBody @@ -923,7 +923,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. ApiResponse of CampaignsUpdateResponseBody @@ -942,7 +942,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsVouchersCreateResponseBody @@ -957,12 +957,12 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsVouchersCreateResponseBody) - + Add Vouchers to Campaign @@ -971,13 +971,13 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign @@ -986,8 +986,8 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsVouchersCreateCombinedResponseBody) @@ -1000,7 +1000,7 @@ Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsCreateResponseBody @@ -1013,7 +1013,7 @@ Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsCreateResponseBody) @@ -1107,7 +1107,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsTransactionsExportCreateResponseBody @@ -1121,7 +1121,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) @@ -1191,7 +1191,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsImportCreateResponseBody @@ -1205,7 +1205,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsImportCreateResponseBody) @@ -1323,7 +1323,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsUpdateResponseBody @@ -1337,7 +1337,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsUpdateResponseBody) @@ -1415,7 +1415,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. CampaignsVouchersCreateResponseBody @@ -1426,7 +1426,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. ApiResponse of CampaignsVouchersCreateResponseBody @@ -1437,7 +1437,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsVouchersCreateResponseBody @@ -1449,53 +1449,53 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsVouchersCreateResponseBody) - + Add Vouchers to Campaign This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. ApiResponse of CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsVouchersCreateCombinedResponseBody) @@ -1505,7 +1505,7 @@ Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. CampaignsCreateResponseBody @@ -1514,7 +1514,7 @@ Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. ApiResponse of CampaignsCreateResponseBody @@ -1523,7 +1523,7 @@ Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsCreateResponseBody @@ -1533,7 +1533,7 @@ Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsCreateResponseBody) @@ -1662,7 +1662,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. CampaignsTransactionsExportCreateResponseBody @@ -1672,7 +1672,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. ApiResponse of CampaignsTransactionsExportCreateResponseBody @@ -1682,7 +1682,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsTransactionsExportCreateResponseBody @@ -1693,7 +1693,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) @@ -1788,7 +1788,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. CampaignsImportCreateResponseBody @@ -1798,7 +1798,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. ApiResponse of CampaignsImportCreateResponseBody @@ -1808,7 +1808,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsImportCreateResponseBody @@ -1819,7 +1819,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsImportCreateResponseBody) @@ -1996,7 +1996,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. CampaignsUpdateResponseBody @@ -2006,7 +2006,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. ApiResponse of CampaignsUpdateResponseBody @@ -2016,7 +2016,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsUpdateResponseBody @@ -2027,7 +2027,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsUpdateResponseBody) @@ -2045,7 +2045,7 @@ Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. CategoriesCreateResponseBody @@ -2057,7 +2057,7 @@ Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. ApiResponse of CategoriesCreateResponseBody @@ -2140,7 +2140,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. CategoriesUpdateResponseBody @@ -2153,7 +2153,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. ApiResponse of CategoriesUpdateResponseBody @@ -2170,7 +2170,7 @@ Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of CategoriesCreateResponseBody @@ -2183,7 +2183,7 @@ Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CategoriesCreateResponseBody) @@ -2273,7 +2273,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of CategoriesUpdateResponseBody @@ -2287,7 +2287,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CategoriesUpdateResponseBody) @@ -2363,7 +2363,7 @@ Create Category Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. CategoriesCreateResponseBody @@ -2372,7 +2372,7 @@ Create Category Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. ApiResponse of CategoriesCreateResponseBody @@ -2381,7 +2381,7 @@ Create Category Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of CategoriesCreateResponseBody @@ -2391,7 +2391,7 @@ Create Category Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CategoriesCreateResponseBody) @@ -2512,7 +2512,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. CategoriesUpdateResponseBody @@ -2522,7 +2522,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. ApiResponse of CategoriesUpdateResponseBody @@ -2532,7 +2532,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of CategoriesUpdateResponseBody @@ -2543,7 +2543,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CategoriesUpdateResponseBody) @@ -2561,7 +2561,7 @@ Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ClientQualificationsCheckEligibilityResponseBody @@ -2573,7 +2573,7 @@ Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ApiResponse of ClientQualificationsCheckEligibilityResponseBody @@ -2618,7 +2618,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ClientRedemptionsRedeemResponseBody @@ -2631,7 +2631,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ApiResponse of ClientRedemptionsRedeemResponseBody @@ -2644,7 +2644,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ClientEventsCreateResponseBody @@ -2657,7 +2657,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ApiResponse of ClientEventsCreateResponseBody @@ -2670,7 +2670,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ClientValidationsValidateResponseBody @@ -2683,7 +2683,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ApiResponse of ClientValidationsValidateResponseBody @@ -2700,7 +2700,7 @@ Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ClientQualificationsCheckEligibilityResponseBody @@ -2713,7 +2713,7 @@ Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientQualificationsCheckEligibilityResponseBody) @@ -2761,7 +2761,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ClientRedemptionsRedeemResponseBody @@ -2775,7 +2775,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientRedemptionsRedeemResponseBody) @@ -2789,7 +2789,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ClientEventsCreateResponseBody @@ -2803,7 +2803,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientEventsCreateResponseBody) @@ -2817,7 +2817,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ClientValidationsValidateResponseBody @@ -2831,7 +2831,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientValidationsValidateResponseBody) @@ -2907,7 +2907,7 @@ Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ClientQualificationsCheckEligibilityResponseBody @@ -2916,7 +2916,7 @@ Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ApiResponse of ClientQualificationsCheckEligibilityResponseBody @@ -2925,7 +2925,7 @@ Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ClientQualificationsCheckEligibilityResponseBody @@ -2935,7 +2935,7 @@ Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientQualificationsCheckEligibilityResponseBody) @@ -3000,7 +3000,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ClientRedemptionsRedeemResponseBody @@ -3010,7 +3010,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ApiResponse of ClientRedemptionsRedeemResponseBody @@ -3020,7 +3020,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ClientRedemptionsRedeemResponseBody @@ -3031,7 +3031,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientRedemptionsRedeemResponseBody) @@ -3042,7 +3042,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ClientEventsCreateResponseBody @@ -3052,7 +3052,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ApiResponse of ClientEventsCreateResponseBody @@ -3062,7 +3062,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ClientEventsCreateResponseBody @@ -3073,7 +3073,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientEventsCreateResponseBody) @@ -3084,7 +3084,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ClientValidationsValidateResponseBody @@ -3094,7 +3094,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ApiResponse of ClientValidationsValidateResponseBody @@ -3104,7 +3104,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ClientValidationsValidateResponseBody @@ -3115,7 +3115,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientValidationsValidateResponseBody) @@ -3133,7 +3133,7 @@ Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. CustomersCreateResponseBody @@ -3145,7 +3145,7 @@ Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. ApiResponse of CustomersCreateResponseBody @@ -3398,7 +3398,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. CustomersUpdateResponseBody @@ -3411,7 +3411,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of CustomersUpdateResponseBody @@ -3423,7 +3423,7 @@ Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. CustomersUpdateInBulkResponseBody @@ -3435,7 +3435,7 @@ Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. ApiResponse of CustomersUpdateInBulkResponseBody @@ -3447,7 +3447,7 @@ Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. CustomersMetadataUpdateInBulkResponseBody @@ -3459,7 +3459,7 @@ Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. ApiResponse of CustomersMetadataUpdateInBulkResponseBody @@ -3476,7 +3476,7 @@ Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersCreateResponseBody @@ -3489,7 +3489,7 @@ Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersCreateResponseBody) @@ -3759,7 +3759,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersUpdateResponseBody @@ -3773,7 +3773,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersUpdateResponseBody) @@ -3786,7 +3786,7 @@ Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersUpdateInBulkResponseBody @@ -3799,7 +3799,7 @@ Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersUpdateInBulkResponseBody) @@ -3812,7 +3812,7 @@ Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersMetadataUpdateInBulkResponseBody @@ -3825,7 +3825,7 @@ Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersMetadataUpdateInBulkResponseBody) @@ -3901,7 +3901,7 @@ Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. CustomersCreateResponseBody @@ -3910,7 +3910,7 @@ Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. ApiResponse of CustomersCreateResponseBody @@ -3919,7 +3919,7 @@ Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersCreateResponseBody @@ -3929,7 +3929,7 @@ Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersCreateResponseBody) @@ -4340,7 +4340,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. CustomersUpdateResponseBody @@ -4350,7 +4350,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of CustomersUpdateResponseBody @@ -4360,7 +4360,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersUpdateResponseBody @@ -4371,7 +4371,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersUpdateResponseBody) @@ -4381,7 +4381,7 @@ Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. CustomersUpdateInBulkResponseBody @@ -4390,7 +4390,7 @@ Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. ApiResponse of CustomersUpdateInBulkResponseBody @@ -4399,7 +4399,7 @@ Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersUpdateInBulkResponseBody @@ -4409,7 +4409,7 @@ Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersUpdateInBulkResponseBody) @@ -4419,7 +4419,7 @@ Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. CustomersMetadataUpdateInBulkResponseBody @@ -4428,7 +4428,7 @@ Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. ApiResponse of CustomersMetadataUpdateInBulkResponseBody @@ -4437,7 +4437,7 @@ Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersMetadataUpdateInBulkResponseBody @@ -4447,7 +4447,7 @@ Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersMetadataUpdateInBulkResponseBody) @@ -4465,7 +4465,7 @@ To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. EventsCreateResponseBody @@ -4477,7 +4477,7 @@ To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ApiResponse of EventsCreateResponseBody @@ -4494,7 +4494,7 @@ To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of EventsCreateResponseBody @@ -4507,7 +4507,7 @@ To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (EventsCreateResponseBody) @@ -4583,7 +4583,7 @@ Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. EventsCreateResponseBody @@ -4592,7 +4592,7 @@ Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ApiResponse of EventsCreateResponseBody @@ -4601,7 +4601,7 @@ Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of EventsCreateResponseBody @@ -4611,7 +4611,7 @@ Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (EventsCreateResponseBody) @@ -4629,7 +4629,7 @@ Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. ExportsCreateResponseBody @@ -4641,7 +4641,7 @@ Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. ApiResponse of ExportsCreateResponseBody @@ -4760,7 +4760,7 @@ Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ExportsCreateResponseBody @@ -4773,7 +4773,7 @@ Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ExportsCreateResponseBody) @@ -4959,7 +4959,7 @@ Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. ExportsCreateResponseBody @@ -4968,7 +4968,7 @@ Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. ApiResponse of ExportsCreateResponseBody @@ -4977,7 +4977,7 @@ Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ExportsCreateResponseBody @@ -4987,7 +4987,7 @@ Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ExportsCreateResponseBody) @@ -5472,7 +5472,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. LoyaltiesMembersCreateResponseBody @@ -5485,7 +5485,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. ApiResponse of LoyaltiesMembersCreateResponseBody @@ -5499,7 +5499,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. LoyaltiesMembersPendingPointsBalanceResponseBody @@ -5513,7 +5513,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. ApiResponse of LoyaltiesMembersPendingPointsBalanceResponseBody @@ -5552,7 +5552,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. List<LoyaltiesEarningRulesCreateResponseBody> @@ -5565,7 +5565,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. ApiResponse of List<LoyaltiesEarningRulesCreateResponseBody> @@ -5578,7 +5578,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. List<LoyaltyTier> @@ -5591,7 +5591,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. ApiResponse of List<LoyaltyTier> @@ -5603,7 +5603,7 @@ Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. LoyaltiesCreateCampaignResponseBody @@ -5615,7 +5615,7 @@ Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. ApiResponse of LoyaltiesCreateCampaignResponseBody @@ -5628,7 +5628,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. LoyaltiesPointsExpirationExportCreateResponseBody @@ -5641,7 +5641,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. ApiResponse of LoyaltiesPointsExpirationExportCreateResponseBody @@ -5654,7 +5654,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. LoyaltiesRewardsCreateAssignmentResponseBody @@ -5667,7 +5667,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. ApiResponse of LoyaltiesRewardsCreateAssignmentResponseBody @@ -5810,7 +5810,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. CampaignsTransactionsExportCreateResponseBody @@ -5823,7 +5823,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. ApiResponse of CampaignsTransactionsExportCreateResponseBody @@ -5836,7 +5836,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. LoyaltiesMembersTransactionsExportCreateResponseBody @@ -5849,7 +5849,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -5863,7 +5863,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. LoyaltiesMembersTransactionsExportCreateResponseBody @@ -5877,7 +5877,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -6670,7 +6670,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. LoyaltiesMembersRedemptionRedeemResponseBody @@ -6683,7 +6683,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody @@ -6697,7 +6697,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. LoyaltiesMembersRedemptionRedeemResponseBody @@ -6711,7 +6711,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody @@ -6725,7 +6725,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. LoyaltiesMembersTransfersCreateResponseBody @@ -6739,7 +6739,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. ApiResponse of LoyaltiesMembersTransfersCreateResponseBody @@ -6753,7 +6753,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. LoyaltiesEarningRulesUpdateResponseBody @@ -6767,7 +6767,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. ApiResponse of LoyaltiesEarningRulesUpdateResponseBody @@ -6780,7 +6780,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. LoyaltiesMembersBalanceUpdateResponseBody @@ -6793,7 +6793,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody @@ -6807,7 +6807,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. LoyaltiesMembersBalanceUpdateResponseBody @@ -6821,7 +6821,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody @@ -6834,7 +6834,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. LoyaltiesUpdateCampaignResponseBody @@ -6847,7 +6847,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. ApiResponse of LoyaltiesUpdateCampaignResponseBody @@ -6861,7 +6861,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. LoyaltiesRewardsUpdateAssignmentResponseBody @@ -6875,7 +6875,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. ApiResponse of LoyaltiesRewardsUpdateAssignmentResponseBody @@ -6921,7 +6921,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersCreateResponseBody @@ -6935,7 +6935,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersCreateResponseBody) @@ -6950,7 +6950,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersPendingPointsBalanceResponseBody @@ -6965,7 +6965,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersPendingPointsBalanceResponseBody) @@ -7007,7 +7007,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. Cancellation Token to cancel the request. Task of List<LoyaltiesEarningRulesCreateResponseBody> @@ -7021,7 +7021,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (List<LoyaltiesEarningRulesCreateResponseBody>) @@ -7035,7 +7035,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of List<LoyaltyTier> @@ -7049,7 +7049,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (List<LoyaltyTier>) @@ -7062,7 +7062,7 @@ Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesCreateCampaignResponseBody @@ -7075,7 +7075,7 @@ Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesCreateCampaignResponseBody) @@ -7089,7 +7089,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesPointsExpirationExportCreateResponseBody @@ -7103,7 +7103,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesPointsExpirationExportCreateResponseBody) @@ -7117,7 +7117,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesRewardsCreateAssignmentResponseBody @@ -7131,7 +7131,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesRewardsCreateAssignmentResponseBody) @@ -7285,7 +7285,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsTransactionsExportCreateResponseBody @@ -7299,7 +7299,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) @@ -7313,7 +7313,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -7327,7 +7327,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) @@ -7342,7 +7342,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -7357,7 +7357,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) @@ -8205,7 +8205,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersRedemptionRedeemResponseBody @@ -8219,7 +8219,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) @@ -8234,7 +8234,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersRedemptionRedeemResponseBody @@ -8249,7 +8249,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) @@ -8264,7 +8264,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransfersCreateResponseBody @@ -8279,7 +8279,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransfersCreateResponseBody) @@ -8294,7 +8294,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesEarningRulesUpdateResponseBody @@ -8309,7 +8309,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesEarningRulesUpdateResponseBody) @@ -8323,7 +8323,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersBalanceUpdateResponseBody @@ -8337,7 +8337,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) @@ -8352,7 +8352,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersBalanceUpdateResponseBody @@ -8367,7 +8367,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) @@ -8381,7 +8381,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesUpdateCampaignResponseBody @@ -8395,7 +8395,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesUpdateCampaignResponseBody) @@ -8410,7 +8410,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesRewardsUpdateAssignmentResponseBody @@ -8425,7 +8425,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesRewardsUpdateAssignmentResponseBody) @@ -8544,7 +8544,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. LoyaltiesMembersCreateResponseBody @@ -8554,7 +8554,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. ApiResponse of LoyaltiesMembersCreateResponseBody @@ -8564,7 +8564,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersCreateResponseBody @@ -8575,7 +8575,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersCreateResponseBody) @@ -8587,7 +8587,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. LoyaltiesMembersPendingPointsBalanceResponseBody @@ -8598,7 +8598,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. ApiResponse of LoyaltiesMembersPendingPointsBalanceResponseBody @@ -8609,7 +8609,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersPendingPointsBalanceResponseBody @@ -8621,7 +8621,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersPendingPointsBalanceResponseBody) @@ -8674,7 +8674,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. List<LoyaltiesEarningRulesCreateResponseBody> @@ -8684,7 +8684,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. ApiResponse of List<LoyaltiesEarningRulesCreateResponseBody> @@ -8694,7 +8694,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. Cancellation Token to cancel the request. Task of List<LoyaltiesEarningRulesCreateResponseBody> @@ -8705,7 +8705,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (List<LoyaltiesEarningRulesCreateResponseBody>) @@ -8716,7 +8716,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. List<LoyaltyTier> @@ -8726,7 +8726,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. ApiResponse of List<LoyaltyTier> @@ -8736,7 +8736,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of List<LoyaltyTier> @@ -8747,7 +8747,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (List<LoyaltyTier>) @@ -8757,7 +8757,7 @@ Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. LoyaltiesCreateCampaignResponseBody @@ -8766,7 +8766,7 @@ Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. ApiResponse of LoyaltiesCreateCampaignResponseBody @@ -8775,7 +8775,7 @@ Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesCreateCampaignResponseBody @@ -8785,7 +8785,7 @@ Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesCreateCampaignResponseBody) @@ -8796,7 +8796,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. LoyaltiesPointsExpirationExportCreateResponseBody @@ -8806,7 +8806,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. ApiResponse of LoyaltiesPointsExpirationExportCreateResponseBody @@ -8816,7 +8816,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesPointsExpirationExportCreateResponseBody @@ -8827,7 +8827,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesPointsExpirationExportCreateResponseBody) @@ -8838,7 +8838,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. LoyaltiesRewardsCreateAssignmentResponseBody @@ -8848,7 +8848,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. ApiResponse of LoyaltiesRewardsCreateAssignmentResponseBody @@ -8858,7 +8858,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesRewardsCreateAssignmentResponseBody @@ -8869,7 +8869,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesRewardsCreateAssignmentResponseBody) @@ -9090,7 +9090,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. CampaignsTransactionsExportCreateResponseBody @@ -9100,7 +9100,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. ApiResponse of CampaignsTransactionsExportCreateResponseBody @@ -9110,7 +9110,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsTransactionsExportCreateResponseBody @@ -9121,7 +9121,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) @@ -9132,7 +9132,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9142,7 +9142,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9152,7 +9152,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9163,7 +9163,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) @@ -9175,7 +9175,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9186,7 +9186,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9197,7 +9197,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9209,7 +9209,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) @@ -10510,7 +10510,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. LoyaltiesMembersRedemptionRedeemResponseBody @@ -10520,7 +10520,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody @@ -10530,7 +10530,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersRedemptionRedeemResponseBody @@ -10541,7 +10541,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) @@ -10553,7 +10553,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. LoyaltiesMembersRedemptionRedeemResponseBody @@ -10564,7 +10564,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody @@ -10575,7 +10575,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersRedemptionRedeemResponseBody @@ -10587,7 +10587,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) @@ -10599,7 +10599,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. LoyaltiesMembersTransfersCreateResponseBody @@ -10610,7 +10610,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. ApiResponse of LoyaltiesMembersTransfersCreateResponseBody @@ -10621,7 +10621,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransfersCreateResponseBody @@ -10633,7 +10633,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransfersCreateResponseBody) @@ -10645,7 +10645,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. LoyaltiesEarningRulesUpdateResponseBody @@ -10656,7 +10656,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. ApiResponse of LoyaltiesEarningRulesUpdateResponseBody @@ -10667,7 +10667,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesEarningRulesUpdateResponseBody @@ -10679,7 +10679,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesEarningRulesUpdateResponseBody) @@ -10690,7 +10690,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. LoyaltiesMembersBalanceUpdateResponseBody @@ -10700,7 +10700,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody @@ -10710,7 +10710,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersBalanceUpdateResponseBody @@ -10721,7 +10721,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) @@ -10733,7 +10733,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. LoyaltiesMembersBalanceUpdateResponseBody @@ -10744,7 +10744,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody @@ -10755,7 +10755,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersBalanceUpdateResponseBody @@ -10767,7 +10767,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) @@ -10778,7 +10778,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. LoyaltiesUpdateCampaignResponseBody @@ -10788,7 +10788,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. ApiResponse of LoyaltiesUpdateCampaignResponseBody @@ -10798,7 +10798,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesUpdateCampaignResponseBody @@ -10809,7 +10809,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesUpdateCampaignResponseBody) @@ -10821,7 +10821,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. LoyaltiesRewardsUpdateAssignmentResponseBody @@ -10832,7 +10832,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. ApiResponse of LoyaltiesRewardsUpdateAssignmentResponseBody @@ -10843,7 +10843,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesRewardsUpdateAssignmentResponseBody @@ -10855,7 +10855,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesRewardsUpdateAssignmentResponseBody) @@ -10874,7 +10874,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. ManagementProjectsUsersAssignResponseBody @@ -10887,7 +10887,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. ApiResponse of ManagementProjectsUsersAssignResponseBody @@ -10900,7 +10900,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. ManagementProjectsBrandingCreateResponseBody @@ -10913,7 +10913,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. ApiResponse of ManagementProjectsBrandingCreateResponseBody @@ -10926,7 +10926,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. ManagementProjectsCustomEventSchemasCreateResponseBody @@ -10939,7 +10939,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. ApiResponse of ManagementProjectsCustomEventSchemasCreateResponseBody @@ -10952,7 +10952,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. ManagementProjectsMetadataSchemasCreateResponseBody @@ -10965,7 +10965,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. ApiResponse of ManagementProjectsMetadataSchemasCreateResponseBody @@ -10977,7 +10977,7 @@ Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. ManagementProjectsCreateResponseBody @@ -10989,7 +10989,7 @@ Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. ApiResponse of ManagementProjectsCreateResponseBody @@ -11002,7 +11002,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. ManagementProjectsStackingRulesCreateResponseBody @@ -11015,7 +11015,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. ApiResponse of ManagementProjectsStackingRulesCreateResponseBody @@ -11028,7 +11028,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. ManagementProjectsWebhooksCreateResponseBody @@ -11041,7 +11041,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. ApiResponse of ManagementProjectsWebhooksCreateResponseBody @@ -11387,7 +11387,7 @@ Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. @@ -11399,7 +11399,7 @@ Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. ApiResponse of Object(void) @@ -11579,7 +11579,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -11593,7 +11593,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. ApiResponse of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -11667,7 +11667,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. ManagementProjectsBrandingUpdateResponseBody @@ -11681,7 +11681,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. ApiResponse of ManagementProjectsBrandingUpdateResponseBody @@ -11695,7 +11695,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -11709,7 +11709,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. ApiResponse of ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -11723,7 +11723,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. ManagementProjectsMetadataSchemasUpdateResponseBody @@ -11737,7 +11737,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. ApiResponse of ManagementProjectsMetadataSchemasUpdateResponseBody @@ -11750,7 +11750,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. ManagementProjectsUpdateResponseBody @@ -11763,7 +11763,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. ApiResponse of ManagementProjectsUpdateResponseBody @@ -11777,7 +11777,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. ManagementProjectsStackingRulesUpdateResponseBody @@ -11791,7 +11791,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. ApiResponse of ManagementProjectsStackingRulesUpdateResponseBody @@ -11805,7 +11805,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. ManagementProjectsUsersUpdateRoleResponseBody @@ -11819,7 +11819,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. ApiResponse of ManagementProjectsUsersUpdateRoleResponseBody @@ -11833,7 +11833,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. ManagementProjectsWebhooksUpdateResponseBody @@ -11847,7 +11847,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. ApiResponse of ManagementProjectsWebhooksUpdateResponseBody @@ -11865,7 +11865,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUsersAssignResponseBody @@ -11879,7 +11879,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUsersAssignResponseBody) @@ -11893,7 +11893,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsBrandingCreateResponseBody @@ -11907,7 +11907,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsBrandingCreateResponseBody) @@ -11921,7 +11921,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCustomEventSchemasCreateResponseBody @@ -11935,7 +11935,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCustomEventSchemasCreateResponseBody) @@ -11949,7 +11949,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsMetadataSchemasCreateResponseBody @@ -11963,7 +11963,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsMetadataSchemasCreateResponseBody) @@ -11976,7 +11976,7 @@ Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCreateResponseBody @@ -11989,7 +11989,7 @@ Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCreateResponseBody) @@ -12003,7 +12003,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsStackingRulesCreateResponseBody @@ -12017,7 +12017,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsStackingRulesCreateResponseBody) @@ -12031,7 +12031,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsWebhooksCreateResponseBody @@ -12045,7 +12045,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsWebhooksCreateResponseBody) @@ -12418,7 +12418,7 @@ Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. Cancellation Token to cancel the request. Task of void @@ -12431,7 +12431,7 @@ Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse @@ -12626,7 +12626,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -12641,7 +12641,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsTemplatesCampaignsCopyCreateResponseBody) @@ -12720,7 +12720,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsBrandingUpdateResponseBody @@ -12735,7 +12735,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsBrandingUpdateResponseBody) @@ -12750,7 +12750,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -12765,7 +12765,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCustomEventSchemasUpdateResponseBody) @@ -12780,7 +12780,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsMetadataSchemasUpdateResponseBody @@ -12795,7 +12795,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsMetadataSchemasUpdateResponseBody) @@ -12809,7 +12809,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUpdateResponseBody @@ -12823,7 +12823,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUpdateResponseBody) @@ -12838,7 +12838,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsStackingRulesUpdateResponseBody @@ -12853,7 +12853,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsStackingRulesUpdateResponseBody) @@ -12868,7 +12868,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUsersUpdateRoleResponseBody @@ -12883,7 +12883,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUsersUpdateRoleResponseBody) @@ -12898,7 +12898,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsWebhooksUpdateResponseBody @@ -12913,7 +12913,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsWebhooksUpdateResponseBody) @@ -12990,7 +12990,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. ManagementProjectsUsersAssignResponseBody @@ -13000,7 +13000,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. ApiResponse of ManagementProjectsUsersAssignResponseBody @@ -13010,7 +13010,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUsersAssignResponseBody @@ -13021,7 +13021,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUsersAssignResponseBody) @@ -13032,7 +13032,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. ManagementProjectsBrandingCreateResponseBody @@ -13042,7 +13042,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. ApiResponse of ManagementProjectsBrandingCreateResponseBody @@ -13052,7 +13052,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsBrandingCreateResponseBody @@ -13063,7 +13063,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsBrandingCreateResponseBody) @@ -13074,7 +13074,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. ManagementProjectsCustomEventSchemasCreateResponseBody @@ -13084,7 +13084,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. ApiResponse of ManagementProjectsCustomEventSchemasCreateResponseBody @@ -13094,7 +13094,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCustomEventSchemasCreateResponseBody @@ -13105,7 +13105,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCustomEventSchemasCreateResponseBody) @@ -13116,7 +13116,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. ManagementProjectsMetadataSchemasCreateResponseBody @@ -13126,7 +13126,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. ApiResponse of ManagementProjectsMetadataSchemasCreateResponseBody @@ -13136,7 +13136,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsMetadataSchemasCreateResponseBody @@ -13147,7 +13147,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsMetadataSchemasCreateResponseBody) @@ -13157,7 +13157,7 @@ Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. ManagementProjectsCreateResponseBody @@ -13166,7 +13166,7 @@ Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. ApiResponse of ManagementProjectsCreateResponseBody @@ -13175,7 +13175,7 @@ Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCreateResponseBody @@ -13185,7 +13185,7 @@ Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCreateResponseBody) @@ -13196,7 +13196,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. ManagementProjectsStackingRulesCreateResponseBody @@ -13206,7 +13206,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. ApiResponse of ManagementProjectsStackingRulesCreateResponseBody @@ -13216,7 +13216,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsStackingRulesCreateResponseBody @@ -13227,7 +13227,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsStackingRulesCreateResponseBody) @@ -13238,7 +13238,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. ManagementProjectsWebhooksCreateResponseBody @@ -13248,7 +13248,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. ApiResponse of ManagementProjectsWebhooksCreateResponseBody @@ -13258,7 +13258,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsWebhooksCreateResponseBody @@ -13269,7 +13269,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsWebhooksCreateResponseBody) @@ -13817,7 +13817,7 @@ Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. @@ -13826,7 +13826,7 @@ Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. ApiResponse of Object(void) @@ -13835,7 +13835,7 @@ Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. Cancellation Token to cancel the request. Task of void @@ -13845,7 +13845,7 @@ Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse @@ -14119,7 +14119,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -14130,7 +14130,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. ApiResponse of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -14141,7 +14141,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -14153,7 +14153,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsTemplatesCampaignsCopyCreateResponseBody) @@ -14265,7 +14265,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. ManagementProjectsBrandingUpdateResponseBody @@ -14276,7 +14276,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. ApiResponse of ManagementProjectsBrandingUpdateResponseBody @@ -14287,7 +14287,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsBrandingUpdateResponseBody @@ -14299,7 +14299,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsBrandingUpdateResponseBody) @@ -14311,7 +14311,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -14322,7 +14322,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. ApiResponse of ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -14333,7 +14333,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -14345,7 +14345,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCustomEventSchemasUpdateResponseBody) @@ -14357,7 +14357,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. ManagementProjectsMetadataSchemasUpdateResponseBody @@ -14368,7 +14368,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. ApiResponse of ManagementProjectsMetadataSchemasUpdateResponseBody @@ -14379,7 +14379,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsMetadataSchemasUpdateResponseBody @@ -14391,7 +14391,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsMetadataSchemasUpdateResponseBody) @@ -14402,7 +14402,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. ManagementProjectsUpdateResponseBody @@ -14412,7 +14412,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. ApiResponse of ManagementProjectsUpdateResponseBody @@ -14422,7 +14422,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUpdateResponseBody @@ -14433,7 +14433,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUpdateResponseBody) @@ -14445,7 +14445,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. ManagementProjectsStackingRulesUpdateResponseBody @@ -14456,7 +14456,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. ApiResponse of ManagementProjectsStackingRulesUpdateResponseBody @@ -14467,7 +14467,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsStackingRulesUpdateResponseBody @@ -14479,7 +14479,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsStackingRulesUpdateResponseBody) @@ -14491,7 +14491,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. ManagementProjectsUsersUpdateRoleResponseBody @@ -14502,7 +14502,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. ApiResponse of ManagementProjectsUsersUpdateRoleResponseBody @@ -14513,7 +14513,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUsersUpdateRoleResponseBody @@ -14525,7 +14525,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUsersUpdateRoleResponseBody) @@ -14537,7 +14537,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. ManagementProjectsWebhooksUpdateResponseBody @@ -14548,7 +14548,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. ApiResponse of ManagementProjectsWebhooksUpdateResponseBody @@ -14559,7 +14559,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsWebhooksUpdateResponseBody @@ -14571,7 +14571,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsWebhooksUpdateResponseBody) @@ -15181,7 +15181,7 @@ Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. OrdersCreateResponseBody @@ -15193,7 +15193,7 @@ Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. ApiResponse of OrdersCreateResponseBody @@ -15205,7 +15205,7 @@ Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. OrdersExportCreateResponseBody @@ -15217,7 +15217,7 @@ Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. ApiResponse of OrdersExportCreateResponseBody @@ -15250,10 +15250,10 @@ Import Orders - 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. OrdersImportCreateResponseBody @@ -15262,10 +15262,10 @@ Import Orders - 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. ApiResponse of OrdersImportCreateResponseBody @@ -15306,7 +15306,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. OrdersUpdateResponseBody @@ -15319,7 +15319,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. ApiResponse of OrdersUpdateResponseBody @@ -15336,7 +15336,7 @@ Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersCreateResponseBody @@ -15349,7 +15349,7 @@ Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersCreateResponseBody) @@ -15362,7 +15362,7 @@ Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersExportCreateResponseBody @@ -15375,7 +15375,7 @@ Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersExportCreateResponseBody) @@ -15411,10 +15411,10 @@ Import Orders - 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersImportCreateResponseBody @@ -15424,10 +15424,10 @@ Import Orders - 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersImportCreateResponseBody) @@ -15471,7 +15471,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersUpdateResponseBody @@ -15485,7 +15485,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersUpdateResponseBody) @@ -15561,7 +15561,7 @@ Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. OrdersCreateResponseBody @@ -15570,7 +15570,7 @@ Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. ApiResponse of OrdersCreateResponseBody @@ -15579,7 +15579,7 @@ Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersCreateResponseBody @@ -15589,7 +15589,7 @@ Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersCreateResponseBody) @@ -15599,7 +15599,7 @@ Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. OrdersExportCreateResponseBody @@ -15608,7 +15608,7 @@ Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. ApiResponse of OrdersExportCreateResponseBody @@ -15617,7 +15617,7 @@ Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersExportCreateResponseBody @@ -15627,7 +15627,7 @@ Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersExportCreateResponseBody) @@ -15672,38 +15672,38 @@ - Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. OrdersImportCreateResponseBody - Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. ApiResponse of OrdersImportCreateResponseBody - Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersImportCreateResponseBody - Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersImportCreateResponseBody) @@ -15760,7 +15760,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. OrdersUpdateResponseBody @@ -15770,7 +15770,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. ApiResponse of OrdersUpdateResponseBody @@ -15780,7 +15780,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersUpdateResponseBody @@ -15791,7 +15791,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersUpdateResponseBody) @@ -15809,7 +15809,7 @@ This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. ProductCollectionsCreateResponseBody @@ -15821,7 +15821,7 @@ This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of ProductCollectionsCreateResponseBody @@ -15946,7 +15946,7 @@ This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ProductCollectionsCreateResponseBody @@ -15959,7 +15959,7 @@ This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductCollectionsCreateResponseBody) @@ -16151,7 +16151,7 @@ Create Product Collection This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. ProductCollectionsCreateResponseBody @@ -16160,7 +16160,7 @@ Create Product Collection This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of ProductCollectionsCreateResponseBody @@ -16169,7 +16169,7 @@ Create Product Collection This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ProductCollectionsCreateResponseBody @@ -16179,7 +16179,7 @@ Create Product Collection This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductCollectionsCreateResponseBody) @@ -16373,7 +16373,7 @@ Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. ProductsCreateResponseBody @@ -16385,7 +16385,7 @@ Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. ApiResponse of ProductsCreateResponseBody @@ -16398,7 +16398,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. ProductsSkusCreateResponseBody @@ -16411,7 +16411,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. ApiResponse of ProductsSkusCreateResponseBody @@ -16640,7 +16640,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. ProductsUpdateResponseBody @@ -16653,7 +16653,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. ApiResponse of ProductsUpdateResponseBody @@ -16665,7 +16665,7 @@ Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. ProductsUpdateInBulkResponseBody @@ -16677,7 +16677,7 @@ Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. ApiResponse of ProductsUpdateInBulkResponseBody @@ -16689,7 +16689,7 @@ Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. ProductsMetadataUpdateInBulkResponseBody @@ -16701,7 +16701,7 @@ Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. ApiResponse of ProductsMetadataUpdateInBulkResponseBody @@ -16715,7 +16715,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ProductsSkusUpdateResponseBody @@ -16729,7 +16729,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of ProductsSkusUpdateResponseBody @@ -16746,7 +16746,7 @@ Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsCreateResponseBody @@ -16759,7 +16759,7 @@ Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsCreateResponseBody) @@ -16773,7 +16773,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsSkusCreateResponseBody @@ -16787,7 +16787,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsSkusCreateResponseBody) @@ -17033,7 +17033,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsUpdateResponseBody @@ -17047,7 +17047,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsUpdateResponseBody) @@ -17060,7 +17060,7 @@ Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsUpdateInBulkResponseBody @@ -17073,7 +17073,7 @@ Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsUpdateInBulkResponseBody) @@ -17086,7 +17086,7 @@ Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsMetadataUpdateInBulkResponseBody @@ -17099,7 +17099,7 @@ Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsMetadataUpdateInBulkResponseBody) @@ -17114,7 +17114,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsSkusUpdateResponseBody @@ -17129,7 +17129,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsSkusUpdateResponseBody) @@ -17205,7 +17205,7 @@ Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. ProductsCreateResponseBody @@ -17214,7 +17214,7 @@ Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. ApiResponse of ProductsCreateResponseBody @@ -17223,7 +17223,7 @@ Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsCreateResponseBody @@ -17233,7 +17233,7 @@ Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsCreateResponseBody) @@ -17244,7 +17244,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. ProductsSkusCreateResponseBody @@ -17254,7 +17254,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. ApiResponse of ProductsSkusCreateResponseBody @@ -17264,7 +17264,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsSkusCreateResponseBody @@ -17275,7 +17275,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsSkusCreateResponseBody) @@ -17638,7 +17638,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. ProductsUpdateResponseBody @@ -17648,7 +17648,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. ApiResponse of ProductsUpdateResponseBody @@ -17658,7 +17658,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsUpdateResponseBody @@ -17669,7 +17669,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsUpdateResponseBody) @@ -17679,7 +17679,7 @@ Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. ProductsUpdateInBulkResponseBody @@ -17688,7 +17688,7 @@ Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. ApiResponse of ProductsUpdateInBulkResponseBody @@ -17697,7 +17697,7 @@ Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsUpdateInBulkResponseBody @@ -17707,7 +17707,7 @@ Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsUpdateInBulkResponseBody) @@ -17717,7 +17717,7 @@ Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. ProductsMetadataUpdateInBulkResponseBody @@ -17726,7 +17726,7 @@ Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. ApiResponse of ProductsMetadataUpdateInBulkResponseBody @@ -17735,7 +17735,7 @@ Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsMetadataUpdateInBulkResponseBody @@ -17745,7 +17745,7 @@ Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsMetadataUpdateInBulkResponseBody) @@ -17757,7 +17757,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ProductsSkusUpdateResponseBody @@ -17768,7 +17768,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of ProductsSkusUpdateResponseBody @@ -17779,7 +17779,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsSkusUpdateResponseBody @@ -17791,7 +17791,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsSkusUpdateResponseBody) @@ -17810,7 +17810,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. PromotionsTiersCreateResponseBody @@ -17823,7 +17823,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. ApiResponse of PromotionsTiersCreateResponseBody @@ -17836,7 +17836,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. PromotionsStacksCreateResponseBody @@ -17849,7 +17849,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. ApiResponse of PromotionsStacksCreateResponseBody @@ -18121,7 +18121,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. PromotionsStacksUpdateResponseBody @@ -18135,7 +18135,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. ApiResponse of PromotionsStacksUpdateResponseBody @@ -18148,7 +18148,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. PromotionsTiersUpdateResponseBody @@ -18161,7 +18161,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. ApiResponse of PromotionsTiersUpdateResponseBody @@ -18179,7 +18179,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsTiersCreateResponseBody @@ -18193,7 +18193,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsTiersCreateResponseBody) @@ -18207,7 +18207,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsStacksCreateResponseBody @@ -18221,7 +18221,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsStacksCreateResponseBody) @@ -18514,7 +18514,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsStacksUpdateResponseBody @@ -18529,7 +18529,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsStacksUpdateResponseBody) @@ -18543,7 +18543,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsTiersUpdateResponseBody @@ -18557,7 +18557,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsTiersUpdateResponseBody) @@ -18634,7 +18634,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. PromotionsTiersCreateResponseBody @@ -18644,7 +18644,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. ApiResponse of PromotionsTiersCreateResponseBody @@ -18654,7 +18654,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsTiersCreateResponseBody @@ -18665,7 +18665,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsTiersCreateResponseBody) @@ -18676,7 +18676,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. PromotionsStacksCreateResponseBody @@ -18686,7 +18686,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. ApiResponse of PromotionsStacksCreateResponseBody @@ -18696,7 +18696,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsStacksCreateResponseBody @@ -18707,7 +18707,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsStacksCreateResponseBody) @@ -19135,7 +19135,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. PromotionsStacksUpdateResponseBody @@ -19146,7 +19146,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. ApiResponse of PromotionsStacksUpdateResponseBody @@ -19157,7 +19157,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsStacksUpdateResponseBody @@ -19169,7 +19169,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsStacksUpdateResponseBody) @@ -19180,7 +19180,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. PromotionsTiersUpdateResponseBody @@ -19190,7 +19190,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. ApiResponse of PromotionsTiersUpdateResponseBody @@ -19200,7 +19200,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsTiersUpdateResponseBody @@ -19211,7 +19211,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsTiersUpdateResponseBody) @@ -19221,7 +19221,7 @@ Represents a collection of functions to interact with the API endpoints - + Create Publication @@ -19229,12 +19229,12 @@ This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. PublicationsCreateResponseBody - + Create Publication @@ -19242,8 +19242,8 @@ This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. ApiResponse of PublicationsCreateResponseBody @@ -19330,7 +19330,7 @@ Represents a collection of functions to interact with the API endpoints - + Create Publication @@ -19338,13 +19338,13 @@ This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of PublicationsCreateResponseBody - + Create Publication @@ -19352,8 +19352,8 @@ This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PublicationsCreateResponseBody) @@ -19506,44 +19506,44 @@ Provides a factory method hook for the creation of exceptions. - + Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. PublicationsCreateResponseBody - + Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. ApiResponse of PublicationsCreateResponseBody - + Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of PublicationsCreateResponseBody - + Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PublicationsCreateResponseBody) @@ -19697,7 +19697,7 @@ 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. QualificationsCheckEligibilityResponseBody @@ -19709,7 +19709,7 @@ 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ApiResponse of QualificationsCheckEligibilityResponseBody @@ -19726,7 +19726,7 @@ 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of QualificationsCheckEligibilityResponseBody @@ -19739,7 +19739,7 @@ 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (QualificationsCheckEligibilityResponseBody) @@ -19815,7 +19815,7 @@ Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. QualificationsCheckEligibilityResponseBody @@ -19824,7 +19824,7 @@ Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ApiResponse of QualificationsCheckEligibilityResponseBody @@ -19833,7 +19833,7 @@ Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of QualificationsCheckEligibilityResponseBody @@ -19843,7 +19843,7 @@ Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (QualificationsCheckEligibilityResponseBody) @@ -19944,10 +19944,10 @@ Redeem Stackable Discounts - # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. RedemptionsRedeemResponseBody @@ -19956,14 +19956,14 @@ Redeem Stackable Discounts - # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of RedemptionsRedeemResponseBody - + Rollback Redemption @@ -19972,13 +19972,13 @@ Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. RedemptionsRollbackCreateResponseBody - + Rollback Redemption @@ -19987,13 +19987,13 @@ Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. ApiResponse of RedemptionsRollbackCreateResponseBody - + Rollback Stackable Redemptions @@ -20002,13 +20002,13 @@ Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions @@ -20017,9 +20017,9 @@ Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. ApiResponse of RedemptionsRollbacksCreateResponseBody @@ -20125,10 +20125,10 @@ Redeem Stackable Discounts - # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRedeemResponseBody @@ -20138,15 +20138,15 @@ Redeem Stackable Discounts - # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRedeemResponseBody) - + Rollback Redemption @@ -20155,14 +20155,14 @@ Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRollbackCreateResponseBody - + Rollback Redemption @@ -20171,14 +20171,14 @@ Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRollbackCreateResponseBody) - + Rollback Stackable Redemptions @@ -20187,14 +20187,14 @@ Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions @@ -20203,9 +20203,9 @@ Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRollbacksCreateResponseBody) @@ -20420,138 +20420,138 @@ - Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. RedemptionsRedeemResponseBody - Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of RedemptionsRedeemResponseBody - Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRedeemResponseBody - Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRedeemResponseBody) - + Rollback Redemption Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions) 🚧 You can roll back a redemption up to 3 months back. # Effect The operation - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and - gives 1 redemption back to the pool (decreases redeemed_quantity by 1). # Returned funds In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption. Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. RedemptionsRollbackCreateResponseBody - + Rollback Redemption Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions) 🚧 You can roll back a redemption up to 3 months back. # Effect The operation - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and - gives 1 redemption back to the pool (decreases redeemed_quantity by 1). # Returned funds In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption. Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. ApiResponse of RedemptionsRollbackCreateResponseBody - + Rollback Redemption Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions) 🚧 You can roll back a redemption up to 3 months back. # Effect The operation - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and - gives 1 redemption back to the pool (decreases redeemed_quantity by 1). # Returned funds In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption. Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRollbackCreateResponseBody - + Rollback Redemption Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions) 🚧 You can roll back a redemption up to 3 months back. # Effect The operation - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and - gives 1 redemption back to the pool (decreases redeemed_quantity by 1). # Returned funds In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption. Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRollbackCreateResponseBody) - + Rollback Stackable Redemptions Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧 You can roll back a redemption up to 3 months back. Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧 You can roll back a redemption up to 3 months back. Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. ApiResponse of RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧 You can roll back a redemption up to 3 months back. Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧 You can roll back a redemption up to 3 months back. Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRollbacksCreateResponseBody) @@ -20570,7 +20570,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ReferralsMembersHoldersCreateInBulkResponseBody @@ -20583,7 +20583,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody @@ -20597,7 +20597,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ReferralsMembersHoldersCreateInBulkResponseBody @@ -20611,7 +20611,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody @@ -20749,7 +20749,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ReferralsMembersHoldersCreateInBulkResponseBody @@ -20763,7 +20763,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) @@ -20778,7 +20778,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ReferralsMembersHoldersCreateInBulkResponseBody @@ -20793,7 +20793,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) @@ -20998,7 +20998,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ReferralsMembersHoldersCreateInBulkResponseBody @@ -21008,7 +21008,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody @@ -21018,7 +21018,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ReferralsMembersHoldersCreateInBulkResponseBody @@ -21029,7 +21029,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) @@ -21041,7 +21041,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ReferralsMembersHoldersCreateInBulkResponseBody @@ -21052,7 +21052,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody @@ -21063,7 +21063,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ReferralsMembersHoldersCreateInBulkResponseBody @@ -21075,7 +21075,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) @@ -21293,7 +21293,7 @@ Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. RewardsCreateResponseBody @@ -21305,7 +21305,7 @@ Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. ApiResponse of RewardsCreateResponseBody @@ -21318,7 +21318,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. RewardsAssignmentsCreateResponseBody @@ -21331,7 +21331,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. ApiResponse of RewardsAssignmentsCreateResponseBody @@ -21500,7 +21500,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. RewardsUpdateResponseBody @@ -21513,7 +21513,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. ApiResponse of RewardsUpdateResponseBody @@ -21527,7 +21527,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. RewardsAssignmentsUpdateResponseBody @@ -21541,7 +21541,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. ApiResponse of RewardsAssignmentsUpdateResponseBody @@ -21558,7 +21558,7 @@ Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsCreateResponseBody @@ -21571,7 +21571,7 @@ Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsCreateResponseBody) @@ -21585,7 +21585,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsAssignmentsCreateResponseBody @@ -21599,7 +21599,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsAssignmentsCreateResponseBody) @@ -21781,7 +21781,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsUpdateResponseBody @@ -21795,7 +21795,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsUpdateResponseBody) @@ -21810,7 +21810,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsAssignmentsUpdateResponseBody @@ -21825,7 +21825,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsAssignmentsUpdateResponseBody) @@ -21901,7 +21901,7 @@ Create Reward Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. RewardsCreateResponseBody @@ -21910,7 +21910,7 @@ Create Reward Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. ApiResponse of RewardsCreateResponseBody @@ -21919,7 +21919,7 @@ Create Reward Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsCreateResponseBody @@ -21929,7 +21929,7 @@ Create Reward Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsCreateResponseBody) @@ -21940,7 +21940,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. RewardsAssignmentsCreateResponseBody @@ -21950,7 +21950,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. ApiResponse of RewardsAssignmentsCreateResponseBody @@ -21960,7 +21960,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsAssignmentsCreateResponseBody @@ -21971,7 +21971,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsAssignmentsCreateResponseBody) @@ -22234,7 +22234,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. RewardsUpdateResponseBody @@ -22244,7 +22244,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. ApiResponse of RewardsUpdateResponseBody @@ -22254,7 +22254,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsUpdateResponseBody @@ -22265,7 +22265,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsUpdateResponseBody) @@ -22277,7 +22277,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. RewardsAssignmentsUpdateResponseBody @@ -22288,7 +22288,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. ApiResponse of RewardsAssignmentsUpdateResponseBody @@ -22299,7 +22299,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsAssignmentsUpdateResponseBody @@ -22311,7 +22311,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsAssignmentsUpdateResponseBody) @@ -22329,7 +22329,7 @@ Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. SegmentsCreateResponseBody @@ -22341,7 +22341,7 @@ Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. ApiResponse of SegmentsCreateResponseBody @@ -22406,7 +22406,7 @@ Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. Cancellation Token to cancel the request. Task of SegmentsCreateResponseBody @@ -22419,7 +22419,7 @@ Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (SegmentsCreateResponseBody) @@ -22547,7 +22547,7 @@ Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. SegmentsCreateResponseBody @@ -22556,7 +22556,7 @@ Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. ApiResponse of SegmentsCreateResponseBody @@ -22565,7 +22565,7 @@ Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. Cancellation Token to cancel the request. Task of SegmentsCreateResponseBody @@ -22575,7 +22575,7 @@ Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (SegmentsCreateResponseBody) @@ -22670,7 +22670,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. TemplatesCampaignsTierSetupCreateResponseBody @@ -22683,7 +22683,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. ApiResponse of TemplatesCampaignsTierSetupCreateResponseBody @@ -22696,7 +22696,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. TemplatesCampaignsCampaignSetupCreateResponseBody @@ -22709,7 +22709,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. ApiResponse of TemplatesCampaignsCampaignSetupCreateResponseBody @@ -22721,7 +22721,7 @@ Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. TemplatesCampaignsCreateTemplateResponseBody @@ -22733,7 +22733,7 @@ Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. ApiResponse of TemplatesCampaignsCreateTemplateResponseBody @@ -22826,7 +22826,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. TemplatesCampaignsUpdateResponseBody @@ -22839,7 +22839,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. ApiResponse of TemplatesCampaignsUpdateResponseBody @@ -22857,7 +22857,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsTierSetupCreateResponseBody @@ -22871,7 +22871,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsTierSetupCreateResponseBody) @@ -22885,7 +22885,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsCampaignSetupCreateResponseBody @@ -22899,7 +22899,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsCampaignSetupCreateResponseBody) @@ -22912,7 +22912,7 @@ Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsCreateTemplateResponseBody @@ -22925,7 +22925,7 @@ Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsCreateTemplateResponseBody) @@ -23025,7 +23025,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsUpdateResponseBody @@ -23039,7 +23039,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsUpdateResponseBody) @@ -23116,7 +23116,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. TemplatesCampaignsTierSetupCreateResponseBody @@ -23126,7 +23126,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. ApiResponse of TemplatesCampaignsTierSetupCreateResponseBody @@ -23136,7 +23136,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsTierSetupCreateResponseBody @@ -23147,7 +23147,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsTierSetupCreateResponseBody) @@ -23158,7 +23158,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. TemplatesCampaignsCampaignSetupCreateResponseBody @@ -23168,7 +23168,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. ApiResponse of TemplatesCampaignsCampaignSetupCreateResponseBody @@ -23178,7 +23178,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsCampaignSetupCreateResponseBody @@ -23189,7 +23189,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsCampaignSetupCreateResponseBody) @@ -23199,7 +23199,7 @@ Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. TemplatesCampaignsCreateTemplateResponseBody @@ -23208,7 +23208,7 @@ Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. ApiResponse of TemplatesCampaignsCreateTemplateResponseBody @@ -23217,7 +23217,7 @@ Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsCreateTemplateResponseBody @@ -23227,7 +23227,7 @@ Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsCreateTemplateResponseBody) @@ -23368,7 +23368,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. TemplatesCampaignsUpdateResponseBody @@ -23378,7 +23378,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. ApiResponse of TemplatesCampaignsUpdateResponseBody @@ -23388,7 +23388,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsUpdateResponseBody @@ -23399,7 +23399,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsUpdateResponseBody) @@ -23409,7 +23409,7 @@ Represents a collection of functions to interact with the API endpoints - + Create Validation Rules Assignments @@ -23418,12 +23418,12 @@ Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments @@ -23432,8 +23432,8 @@ Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. ApiResponse of ValidationRulesAssignmentsCreateResponseBody @@ -23445,7 +23445,7 @@ Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. ValidationRulesCreateResponseBody @@ -23457,7 +23457,7 @@ Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. ApiResponse of ValidationRulesCreateResponseBody @@ -23638,7 +23638,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ValidationRulesUpdateResponseBody @@ -23651,7 +23651,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of ValidationRulesUpdateResponseBody @@ -23660,7 +23660,7 @@ Represents a collection of functions to interact with the API endpoints - + Create Validation Rules Assignments @@ -23669,13 +23669,13 @@ Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments @@ -23684,8 +23684,8 @@ Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesAssignmentsCreateResponseBody) @@ -23698,7 +23698,7 @@ Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesCreateResponseBody @@ -23711,7 +23711,7 @@ Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesCreateResponseBody) @@ -23905,7 +23905,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesUpdateResponseBody @@ -23919,7 +23919,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesUpdateResponseBody) @@ -23990,48 +23990,48 @@ Provides a factory method hook for the creation of exceptions. - + Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution. Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution. Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. ApiResponse of ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution. Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution. Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesAssignmentsCreateResponseBody) @@ -24041,7 +24041,7 @@ Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. ValidationRulesCreateResponseBody @@ -24050,7 +24050,7 @@ Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. ApiResponse of ValidationRulesCreateResponseBody @@ -24059,7 +24059,7 @@ Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesCreateResponseBody @@ -24069,7 +24069,7 @@ Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesCreateResponseBody) @@ -24356,7 +24356,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ValidationRulesUpdateResponseBody @@ -24366,7 +24366,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of ValidationRulesUpdateResponseBody @@ -24376,7 +24376,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesUpdateResponseBody @@ -24387,7 +24387,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesUpdateResponseBody) @@ -24405,7 +24405,7 @@ Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. ValidationsValidateResponseBody @@ -24417,7 +24417,7 @@ Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of ValidationsValidateResponseBody @@ -24434,7 +24434,7 @@ Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationsValidateResponseBody @@ -24447,7 +24447,7 @@ Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationsValidateResponseBody) @@ -24523,7 +24523,7 @@ Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. ValidationsValidateResponseBody @@ -24532,7 +24532,7 @@ Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of ValidationsValidateResponseBody @@ -24541,7 +24541,7 @@ Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationsValidateResponseBody @@ -24551,7 +24551,7 @@ Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationsValidateResponseBody) @@ -24570,7 +24570,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. VouchersCreateResponseBody @@ -24583,7 +24583,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. ApiResponse of VouchersCreateResponseBody @@ -24670,7 +24670,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. VouchersTransactionsExportCreateResponseBody @@ -24683,7 +24683,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. ApiResponse of VouchersTransactionsExportCreateResponseBody @@ -24695,7 +24695,7 @@ Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. VouchersCreateResponseBody @@ -24707,7 +24707,7 @@ Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. ApiResponse of VouchersCreateResponseBody @@ -24740,7 +24740,7 @@ Import Vouchers - Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -24752,7 +24752,7 @@ Import Vouchers - Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -24764,7 +24764,7 @@ Import Vouchers using CSV - Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -24777,7 +24777,7 @@ Import Vouchers using CSV - Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -24815,7 +24815,7 @@ Index associated with the operation. ApiResponse of VouchersTransactionsListResponseBody - + List Vouchers @@ -24834,10 +24834,11 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. VouchersListResponseBody - + List Vouchers @@ -24856,6 +24857,7 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. ApiResponse of VouchersListResponseBody @@ -24999,7 +25001,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersCreateResponseBody @@ -25013,7 +25015,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersCreateResponseBody) @@ -25107,7 +25109,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersTransactionsExportCreateResponseBody @@ -25121,7 +25123,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersTransactionsExportCreateResponseBody) @@ -25134,7 +25136,7 @@ Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersCreateResponseBody @@ -25147,7 +25149,7 @@ Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersCreateResponseBody) @@ -25183,7 +25185,7 @@ Import Vouchers - Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25196,7 +25198,7 @@ Import Vouchers - Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25209,7 +25211,7 @@ Import Vouchers using CSV - Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25223,7 +25225,7 @@ Import Vouchers using CSV - Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25264,7 +25266,7 @@ Cancellation Token to cancel the request. Task of ApiResponse (VouchersTransactionsListResponseBody) - + List Vouchers @@ -25283,11 +25285,12 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersListResponseBody - + List Vouchers @@ -25306,6 +25309,7 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersListResponseBody) @@ -25518,7 +25522,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. VouchersCreateResponseBody @@ -25528,7 +25532,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. ApiResponse of VouchersCreateResponseBody @@ -25538,7 +25542,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersCreateResponseBody @@ -25549,7 +25553,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersCreateResponseBody) @@ -25678,7 +25682,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. VouchersTransactionsExportCreateResponseBody @@ -25688,7 +25692,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. ApiResponse of VouchersTransactionsExportCreateResponseBody @@ -25698,7 +25702,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersTransactionsExportCreateResponseBody @@ -25709,7 +25713,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersTransactionsExportCreateResponseBody) @@ -25719,7 +25723,7 @@ Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. VouchersCreateResponseBody @@ -25728,7 +25732,7 @@ Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. ApiResponse of VouchersCreateResponseBody @@ -25737,7 +25741,7 @@ Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersCreateResponseBody @@ -25747,7 +25751,7 @@ Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersCreateResponseBody) @@ -25792,7 +25796,7 @@ - Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25801,7 +25805,7 @@ - Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25810,7 +25814,7 @@ - Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25820,7 +25824,7 @@ - Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25830,7 +25834,7 @@ - Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25840,7 +25844,7 @@ - Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25850,7 +25854,7 @@ - Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25861,7 +25865,7 @@ - Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25920,7 +25924,7 @@ Cancellation Token to cancel the request. Task of ApiResponse (VouchersTransactionsListResponseBody) - + List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers. @@ -25936,10 +25940,11 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. VouchersListResponseBody - + List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers. @@ -25955,10 +25960,11 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. ApiResponse of VouchersListResponseBody - + List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers. @@ -25974,11 +25980,12 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersListResponseBody - + List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers. @@ -25994,6 +26001,7 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersListResponseBody) @@ -41779,7 +41787,7 @@ - Response body schema for **POST** `v1/validations`. + Request body schema for **POST** `v1/validations`. @@ -87447,7 +87455,7 @@ The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.. Unique voucher ID.. Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.. Reason why the transaction occurred. In case of a redemption, this value is null.. The related transaction ID on the receiving card.. Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.. @@ -87504,9 +87512,9 @@ - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. @@ -89845,7 +89853,7 @@ Unique identifier of the parent loyalty card.. Unique identifier of the parent campaign.. bucket. - Loyalty point point bucket status.. + Loyalty point bucket status.. Date when the number of points defined in the bucket object are due to expire.. Timestamp representing the date and time when the loyalty point bucket object was created in ISO 8601 format.. Timestamp representing the date and time when the loyalty point bucket object was updated in ISO 8601 format.. @@ -89900,9 +89908,9 @@ - Loyalty point point bucket status. + Loyalty point bucket status. - Loyalty point point bucket status. + Loyalty point bucket status. @@ -114392,7 +114400,7 @@ The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.. Unique voucher ID.. Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.. Reason why the transaction occurred. In case of a redemption, this value is null.. The related transaction ID on the receiving card.. Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.. @@ -114449,9 +114457,9 @@ - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. @@ -120335,7 +120343,7 @@ false (boolean) - + Initializes a new instance of the class. @@ -120347,7 +120355,6 @@ Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).. Array of items applied to the order. It can include up to 500 items.. A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.. - Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.. Unique referrer ID.. customer. referrer. @@ -120436,18 +120443,6 @@ false (boolean) - - - Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. - - Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. - - - - Returns false as CreatedAt should not be serialized given that it's read-only. - - false (boolean) - Unique referrer ID. @@ -128857,20 +128852,23 @@ - Show that the product collection is static (manually selected products). + Defines Type - Show that the product collection is static (manually selected products). Enum STATIC for value: STATIC + + + Enum AUTOUPDATE for value: AUTO_UPDATE + + - Show that the product collection is static (manually selected products). + Gets or Sets Type - Show that the product collection is static (manually selected products). @@ -128882,7 +128880,7 @@ Initializes a new instance of the class. - Show that the product collection is static (manually selected products).. + type. Unique user-defined product collection name.. Defines a set of products for a `STATIC` product collection type.. Defines a set of criteria and boundary conditions for an `AUTO_UPDATE` product collection type.. @@ -161735,7 +161733,7 @@ false (boolean) - + Initializes a new instance of the class. @@ -164283,7 +164281,7 @@ Initializes a new instance of the class. id. - The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.. + The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.. @@ -164298,9 +164296,9 @@ - The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. + The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. - The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. + The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. @@ -165820,32 +165818,6 @@ false (boolean) - - - Defines InitialSyncStatus - - - - - Enum INPROGRESS for value: IN_PROGRESS - - - - - Enum DONE for value: DONE - - - - - Gets or Sets InitialSyncStatus - - - - - Returns false as InitialSyncStatus should not be serialized given that it's read-only. - - false (boolean) - The type of the object represented by JSON. This object stores information about the customer segment. @@ -165869,7 +165841,7 @@ false (boolean) - + Initializes a new instance of the class. @@ -165878,7 +165850,6 @@ Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format.. Defines whether the segment is: - Active (`auto-update`): customers enter and leave the segment based on the defined filters and the `customer.segment.entered` and `customer.segment.left` events are triggered, - Passive (`passive`): customers enter and leave the segment based on the defined filters, but the `customer.segment.entered` and `customer.segment.left` events are not triggered, - Static (`static`): manually selected customers.. Defines a set of criteria for an `auto-update` or `passive` segment type.. - initialSyncStatus. The type of the object represented by JSON. This object stores information about the customer segment.. @@ -165986,32 +165957,6 @@ false (boolean) - - - Defines InitialSyncStatus - - - - - Enum INPROGRESS for value: IN_PROGRESS - - - - - Enum DONE for value: DONE - - - - - Gets or Sets InitialSyncStatus - - - - - Returns false as InitialSyncStatus should not be serialized given that it's read-only. - - false (boolean) - The type of the object represented by JSON. This object stores information about the customer segment. @@ -166035,7 +165980,7 @@ false (boolean) - + Initializes a new instance of the class. @@ -166044,7 +165989,6 @@ Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format.. Defines whether the segment is: - Active (`auto-update`): customers enter and leave the segment based on the defined filters and the `customer.segment.entered` and `customer.segment.left` events are triggered, - Passive (`passive`): customers enter and leave the segment based on the defined filters, but the `customer.segment.entered` and `customer.segment.left` events are not triggered, - Static (`static`): manually selected customers.. Defines a set of criteria for an `auto-update` or `passive` segment type.. - initialSyncStatus. The type of the object represented by JSON. This object stores information about the customer segment.. @@ -177361,7 +177305,7 @@ - Response body schema for **POST** `v1/validations`. + Request body schema for **POST** `v1/validations`. @@ -179910,13 +179854,13 @@ Initializes a new instance of the class. - Defines the reccuring period(s) when the resource is active. The periods should not overlap.. + Defines the recurring period(s) when the resource is active. The periods should not overlap.. - Defines the reccuring period(s) when the resource is active. The periods should not overlap. + Defines the recurring period(s) when the resource is active. The periods should not overlap. - Defines the reccuring period(s) when the resource is active. The periods should not overlap. + Defines the recurring period(s) when the resource is active. The periods should not overlap. @@ -179945,7 +179889,7 @@ - Defines the reccuring period(s) when the resource will be active. + Defines the recurring period(s) when the resource will be active. @@ -188068,7 +188012,7 @@ The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.. Unique voucher ID.. Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.. Reason why the transaction occurred. In case of a redemption, this value is null.. The related transaction ID on the receiving card.. Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.. @@ -188125,9 +188069,9 @@ - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. diff --git a/lib/netstandard2.0/Voucherify.deps.json b/lib/netstandard2.0/Voucherify.deps.json index 36635089..7ef79ffa 100644 --- a/lib/netstandard2.0/Voucherify.deps.json +++ b/lib/netstandard2.0/Voucherify.deps.json @@ -7,7 +7,7 @@ "targets": { ".NETStandard,Version=v2.0": {}, ".NETStandard,Version=v2.0/": { - "Voucherify/8.1.0": { + "Voucherify/9.0.0": { "dependencies": { "JsonSubTypes": "2.0.1", "NETStandard.Library": "2.0.3", @@ -179,7 +179,7 @@ } }, "libraries": { - "Voucherify/8.1.0": { + "Voucherify/9.0.0": { "type": "project", "serviceable": false, "sha512": "" diff --git a/lib/netstandard2.0/Voucherify.dll b/lib/netstandard2.0/Voucherify.dll index 451018e5..01a7deee 100644 Binary files a/lib/netstandard2.0/Voucherify.dll and b/lib/netstandard2.0/Voucherify.dll differ diff --git a/lib/netstandard2.0/Voucherify.xml b/lib/netstandard2.0/Voucherify.xml index c39e3474..872b8003 100644 --- a/lib/netstandard2.0/Voucherify.xml +++ b/lib/netstandard2.0/Voucherify.xml @@ -555,7 +555,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. CampaignsVouchersCreateResponseBody @@ -569,11 +569,11 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. ApiResponse of CampaignsVouchersCreateResponseBody - + Add Vouchers to Campaign @@ -582,12 +582,12 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign @@ -596,8 +596,8 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. ApiResponse of CampaignsVouchersCreateCombinedResponseBody @@ -609,7 +609,7 @@ Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. CampaignsCreateResponseBody @@ -621,7 +621,7 @@ Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. ApiResponse of CampaignsCreateResponseBody @@ -708,7 +708,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. CampaignsTransactionsExportCreateResponseBody @@ -721,7 +721,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. ApiResponse of CampaignsTransactionsExportCreateResponseBody @@ -786,7 +786,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. CampaignsImportCreateResponseBody @@ -799,7 +799,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. ApiResponse of CampaignsImportCreateResponseBody @@ -910,7 +910,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. CampaignsUpdateResponseBody @@ -923,7 +923,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. ApiResponse of CampaignsUpdateResponseBody @@ -942,7 +942,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsVouchersCreateResponseBody @@ -957,12 +957,12 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsVouchersCreateResponseBody) - + Add Vouchers to Campaign @@ -971,13 +971,13 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign @@ -986,8 +986,8 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsVouchersCreateCombinedResponseBody) @@ -1000,7 +1000,7 @@ Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsCreateResponseBody @@ -1013,7 +1013,7 @@ Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsCreateResponseBody) @@ -1107,7 +1107,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsTransactionsExportCreateResponseBody @@ -1121,7 +1121,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) @@ -1191,7 +1191,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsImportCreateResponseBody @@ -1205,7 +1205,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsImportCreateResponseBody) @@ -1323,7 +1323,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsUpdateResponseBody @@ -1337,7 +1337,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsUpdateResponseBody) @@ -1415,7 +1415,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. CampaignsVouchersCreateResponseBody @@ -1426,7 +1426,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. ApiResponse of CampaignsVouchersCreateResponseBody @@ -1437,7 +1437,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsVouchersCreateResponseBody @@ -1449,53 +1449,53 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsVouchersCreateResponseBody) - + Add Vouchers to Campaign This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. ApiResponse of CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsVouchersCreateCombinedResponseBody) @@ -1505,7 +1505,7 @@ Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. CampaignsCreateResponseBody @@ -1514,7 +1514,7 @@ Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. ApiResponse of CampaignsCreateResponseBody @@ -1523,7 +1523,7 @@ Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsCreateResponseBody @@ -1533,7 +1533,7 @@ Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsCreateResponseBody) @@ -1662,7 +1662,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. CampaignsTransactionsExportCreateResponseBody @@ -1672,7 +1672,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. ApiResponse of CampaignsTransactionsExportCreateResponseBody @@ -1682,7 +1682,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsTransactionsExportCreateResponseBody @@ -1693,7 +1693,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) @@ -1788,7 +1788,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. CampaignsImportCreateResponseBody @@ -1798,7 +1798,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. ApiResponse of CampaignsImportCreateResponseBody @@ -1808,7 +1808,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsImportCreateResponseBody @@ -1819,7 +1819,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsImportCreateResponseBody) @@ -1996,7 +1996,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. CampaignsUpdateResponseBody @@ -2006,7 +2006,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. ApiResponse of CampaignsUpdateResponseBody @@ -2016,7 +2016,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsUpdateResponseBody @@ -2027,7 +2027,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsUpdateResponseBody) @@ -2045,7 +2045,7 @@ Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. CategoriesCreateResponseBody @@ -2057,7 +2057,7 @@ Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. ApiResponse of CategoriesCreateResponseBody @@ -2140,7 +2140,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. CategoriesUpdateResponseBody @@ -2153,7 +2153,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. ApiResponse of CategoriesUpdateResponseBody @@ -2170,7 +2170,7 @@ Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of CategoriesCreateResponseBody @@ -2183,7 +2183,7 @@ Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CategoriesCreateResponseBody) @@ -2273,7 +2273,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of CategoriesUpdateResponseBody @@ -2287,7 +2287,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CategoriesUpdateResponseBody) @@ -2363,7 +2363,7 @@ Create Category Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. CategoriesCreateResponseBody @@ -2372,7 +2372,7 @@ Create Category Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. ApiResponse of CategoriesCreateResponseBody @@ -2381,7 +2381,7 @@ Create Category Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of CategoriesCreateResponseBody @@ -2391,7 +2391,7 @@ Create Category Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CategoriesCreateResponseBody) @@ -2512,7 +2512,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. CategoriesUpdateResponseBody @@ -2522,7 +2522,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. ApiResponse of CategoriesUpdateResponseBody @@ -2532,7 +2532,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of CategoriesUpdateResponseBody @@ -2543,7 +2543,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CategoriesUpdateResponseBody) @@ -2561,7 +2561,7 @@ Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ClientQualificationsCheckEligibilityResponseBody @@ -2573,7 +2573,7 @@ Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ApiResponse of ClientQualificationsCheckEligibilityResponseBody @@ -2618,7 +2618,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ClientRedemptionsRedeemResponseBody @@ -2631,7 +2631,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ApiResponse of ClientRedemptionsRedeemResponseBody @@ -2644,7 +2644,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ClientEventsCreateResponseBody @@ -2657,7 +2657,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ApiResponse of ClientEventsCreateResponseBody @@ -2670,7 +2670,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ClientValidationsValidateResponseBody @@ -2683,7 +2683,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ApiResponse of ClientValidationsValidateResponseBody @@ -2700,7 +2700,7 @@ Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ClientQualificationsCheckEligibilityResponseBody @@ -2713,7 +2713,7 @@ Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientQualificationsCheckEligibilityResponseBody) @@ -2761,7 +2761,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ClientRedemptionsRedeemResponseBody @@ -2775,7 +2775,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientRedemptionsRedeemResponseBody) @@ -2789,7 +2789,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ClientEventsCreateResponseBody @@ -2803,7 +2803,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientEventsCreateResponseBody) @@ -2817,7 +2817,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ClientValidationsValidateResponseBody @@ -2831,7 +2831,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientValidationsValidateResponseBody) @@ -2907,7 +2907,7 @@ Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ClientQualificationsCheckEligibilityResponseBody @@ -2916,7 +2916,7 @@ Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ApiResponse of ClientQualificationsCheckEligibilityResponseBody @@ -2925,7 +2925,7 @@ Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ClientQualificationsCheckEligibilityResponseBody @@ -2935,7 +2935,7 @@ Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientQualificationsCheckEligibilityResponseBody) @@ -3000,7 +3000,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ClientRedemptionsRedeemResponseBody @@ -3010,7 +3010,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ApiResponse of ClientRedemptionsRedeemResponseBody @@ -3020,7 +3020,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ClientRedemptionsRedeemResponseBody @@ -3031,7 +3031,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientRedemptionsRedeemResponseBody) @@ -3042,7 +3042,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ClientEventsCreateResponseBody @@ -3052,7 +3052,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ApiResponse of ClientEventsCreateResponseBody @@ -3062,7 +3062,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ClientEventsCreateResponseBody @@ -3073,7 +3073,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientEventsCreateResponseBody) @@ -3084,7 +3084,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ClientValidationsValidateResponseBody @@ -3094,7 +3094,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ApiResponse of ClientValidationsValidateResponseBody @@ -3104,7 +3104,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ClientValidationsValidateResponseBody @@ -3115,7 +3115,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientValidationsValidateResponseBody) @@ -3133,7 +3133,7 @@ Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. CustomersCreateResponseBody @@ -3145,7 +3145,7 @@ Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. ApiResponse of CustomersCreateResponseBody @@ -3398,7 +3398,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. CustomersUpdateResponseBody @@ -3411,7 +3411,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of CustomersUpdateResponseBody @@ -3423,7 +3423,7 @@ Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. CustomersUpdateInBulkResponseBody @@ -3435,7 +3435,7 @@ Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. ApiResponse of CustomersUpdateInBulkResponseBody @@ -3447,7 +3447,7 @@ Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. CustomersMetadataUpdateInBulkResponseBody @@ -3459,7 +3459,7 @@ Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. ApiResponse of CustomersMetadataUpdateInBulkResponseBody @@ -3476,7 +3476,7 @@ Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersCreateResponseBody @@ -3489,7 +3489,7 @@ Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersCreateResponseBody) @@ -3759,7 +3759,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersUpdateResponseBody @@ -3773,7 +3773,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersUpdateResponseBody) @@ -3786,7 +3786,7 @@ Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersUpdateInBulkResponseBody @@ -3799,7 +3799,7 @@ Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersUpdateInBulkResponseBody) @@ -3812,7 +3812,7 @@ Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersMetadataUpdateInBulkResponseBody @@ -3825,7 +3825,7 @@ Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersMetadataUpdateInBulkResponseBody) @@ -3901,7 +3901,7 @@ Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. CustomersCreateResponseBody @@ -3910,7 +3910,7 @@ Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. ApiResponse of CustomersCreateResponseBody @@ -3919,7 +3919,7 @@ Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersCreateResponseBody @@ -3929,7 +3929,7 @@ Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersCreateResponseBody) @@ -4340,7 +4340,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. CustomersUpdateResponseBody @@ -4350,7 +4350,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of CustomersUpdateResponseBody @@ -4360,7 +4360,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersUpdateResponseBody @@ -4371,7 +4371,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersUpdateResponseBody) @@ -4381,7 +4381,7 @@ Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. CustomersUpdateInBulkResponseBody @@ -4390,7 +4390,7 @@ Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. ApiResponse of CustomersUpdateInBulkResponseBody @@ -4399,7 +4399,7 @@ Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersUpdateInBulkResponseBody @@ -4409,7 +4409,7 @@ Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersUpdateInBulkResponseBody) @@ -4419,7 +4419,7 @@ Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. CustomersMetadataUpdateInBulkResponseBody @@ -4428,7 +4428,7 @@ Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. ApiResponse of CustomersMetadataUpdateInBulkResponseBody @@ -4437,7 +4437,7 @@ Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersMetadataUpdateInBulkResponseBody @@ -4447,7 +4447,7 @@ Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersMetadataUpdateInBulkResponseBody) @@ -4465,7 +4465,7 @@ To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. EventsCreateResponseBody @@ -4477,7 +4477,7 @@ To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ApiResponse of EventsCreateResponseBody @@ -4494,7 +4494,7 @@ To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of EventsCreateResponseBody @@ -4507,7 +4507,7 @@ To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (EventsCreateResponseBody) @@ -4583,7 +4583,7 @@ Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. EventsCreateResponseBody @@ -4592,7 +4592,7 @@ Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ApiResponse of EventsCreateResponseBody @@ -4601,7 +4601,7 @@ Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of EventsCreateResponseBody @@ -4611,7 +4611,7 @@ Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (EventsCreateResponseBody) @@ -4629,7 +4629,7 @@ Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. ExportsCreateResponseBody @@ -4641,7 +4641,7 @@ Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. ApiResponse of ExportsCreateResponseBody @@ -4760,7 +4760,7 @@ Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ExportsCreateResponseBody @@ -4773,7 +4773,7 @@ Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ExportsCreateResponseBody) @@ -4959,7 +4959,7 @@ Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. ExportsCreateResponseBody @@ -4968,7 +4968,7 @@ Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. ApiResponse of ExportsCreateResponseBody @@ -4977,7 +4977,7 @@ Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ExportsCreateResponseBody @@ -4987,7 +4987,7 @@ Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ExportsCreateResponseBody) @@ -5472,7 +5472,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. LoyaltiesMembersCreateResponseBody @@ -5485,7 +5485,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. ApiResponse of LoyaltiesMembersCreateResponseBody @@ -5499,7 +5499,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. LoyaltiesMembersPendingPointsBalanceResponseBody @@ -5513,7 +5513,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. ApiResponse of LoyaltiesMembersPendingPointsBalanceResponseBody @@ -5552,7 +5552,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. List<LoyaltiesEarningRulesCreateResponseBody> @@ -5565,7 +5565,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. ApiResponse of List<LoyaltiesEarningRulesCreateResponseBody> @@ -5578,7 +5578,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. List<LoyaltyTier> @@ -5591,7 +5591,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. ApiResponse of List<LoyaltyTier> @@ -5603,7 +5603,7 @@ Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. LoyaltiesCreateCampaignResponseBody @@ -5615,7 +5615,7 @@ Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. ApiResponse of LoyaltiesCreateCampaignResponseBody @@ -5628,7 +5628,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. LoyaltiesPointsExpirationExportCreateResponseBody @@ -5641,7 +5641,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. ApiResponse of LoyaltiesPointsExpirationExportCreateResponseBody @@ -5654,7 +5654,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. LoyaltiesRewardsCreateAssignmentResponseBody @@ -5667,7 +5667,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. ApiResponse of LoyaltiesRewardsCreateAssignmentResponseBody @@ -5810,7 +5810,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. CampaignsTransactionsExportCreateResponseBody @@ -5823,7 +5823,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. ApiResponse of CampaignsTransactionsExportCreateResponseBody @@ -5836,7 +5836,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. LoyaltiesMembersTransactionsExportCreateResponseBody @@ -5849,7 +5849,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -5863,7 +5863,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. LoyaltiesMembersTransactionsExportCreateResponseBody @@ -5877,7 +5877,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -6670,7 +6670,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. LoyaltiesMembersRedemptionRedeemResponseBody @@ -6683,7 +6683,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody @@ -6697,7 +6697,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. LoyaltiesMembersRedemptionRedeemResponseBody @@ -6711,7 +6711,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody @@ -6725,7 +6725,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. LoyaltiesMembersTransfersCreateResponseBody @@ -6739,7 +6739,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. ApiResponse of LoyaltiesMembersTransfersCreateResponseBody @@ -6753,7 +6753,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. LoyaltiesEarningRulesUpdateResponseBody @@ -6767,7 +6767,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. ApiResponse of LoyaltiesEarningRulesUpdateResponseBody @@ -6780,7 +6780,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. LoyaltiesMembersBalanceUpdateResponseBody @@ -6793,7 +6793,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody @@ -6807,7 +6807,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. LoyaltiesMembersBalanceUpdateResponseBody @@ -6821,7 +6821,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody @@ -6834,7 +6834,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. LoyaltiesUpdateCampaignResponseBody @@ -6847,7 +6847,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. ApiResponse of LoyaltiesUpdateCampaignResponseBody @@ -6861,7 +6861,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. LoyaltiesRewardsUpdateAssignmentResponseBody @@ -6875,7 +6875,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. ApiResponse of LoyaltiesRewardsUpdateAssignmentResponseBody @@ -6921,7 +6921,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersCreateResponseBody @@ -6935,7 +6935,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersCreateResponseBody) @@ -6950,7 +6950,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersPendingPointsBalanceResponseBody @@ -6965,7 +6965,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersPendingPointsBalanceResponseBody) @@ -7007,7 +7007,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. Cancellation Token to cancel the request. Task of List<LoyaltiesEarningRulesCreateResponseBody> @@ -7021,7 +7021,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (List<LoyaltiesEarningRulesCreateResponseBody>) @@ -7035,7 +7035,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of List<LoyaltyTier> @@ -7049,7 +7049,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (List<LoyaltyTier>) @@ -7062,7 +7062,7 @@ Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesCreateCampaignResponseBody @@ -7075,7 +7075,7 @@ Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesCreateCampaignResponseBody) @@ -7089,7 +7089,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesPointsExpirationExportCreateResponseBody @@ -7103,7 +7103,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesPointsExpirationExportCreateResponseBody) @@ -7117,7 +7117,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesRewardsCreateAssignmentResponseBody @@ -7131,7 +7131,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesRewardsCreateAssignmentResponseBody) @@ -7285,7 +7285,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsTransactionsExportCreateResponseBody @@ -7299,7 +7299,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) @@ -7313,7 +7313,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -7327,7 +7327,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) @@ -7342,7 +7342,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -7357,7 +7357,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) @@ -8205,7 +8205,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersRedemptionRedeemResponseBody @@ -8219,7 +8219,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) @@ -8234,7 +8234,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersRedemptionRedeemResponseBody @@ -8249,7 +8249,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) @@ -8264,7 +8264,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransfersCreateResponseBody @@ -8279,7 +8279,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransfersCreateResponseBody) @@ -8294,7 +8294,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesEarningRulesUpdateResponseBody @@ -8309,7 +8309,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesEarningRulesUpdateResponseBody) @@ -8323,7 +8323,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersBalanceUpdateResponseBody @@ -8337,7 +8337,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) @@ -8352,7 +8352,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersBalanceUpdateResponseBody @@ -8367,7 +8367,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) @@ -8381,7 +8381,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesUpdateCampaignResponseBody @@ -8395,7 +8395,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesUpdateCampaignResponseBody) @@ -8410,7 +8410,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesRewardsUpdateAssignmentResponseBody @@ -8425,7 +8425,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesRewardsUpdateAssignmentResponseBody) @@ -8544,7 +8544,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. LoyaltiesMembersCreateResponseBody @@ -8554,7 +8554,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. ApiResponse of LoyaltiesMembersCreateResponseBody @@ -8564,7 +8564,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersCreateResponseBody @@ -8575,7 +8575,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersCreateResponseBody) @@ -8587,7 +8587,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. LoyaltiesMembersPendingPointsBalanceResponseBody @@ -8598,7 +8598,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. ApiResponse of LoyaltiesMembersPendingPointsBalanceResponseBody @@ -8609,7 +8609,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersPendingPointsBalanceResponseBody @@ -8621,7 +8621,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersPendingPointsBalanceResponseBody) @@ -8674,7 +8674,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. List<LoyaltiesEarningRulesCreateResponseBody> @@ -8684,7 +8684,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. ApiResponse of List<LoyaltiesEarningRulesCreateResponseBody> @@ -8694,7 +8694,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. Cancellation Token to cancel the request. Task of List<LoyaltiesEarningRulesCreateResponseBody> @@ -8705,7 +8705,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (List<LoyaltiesEarningRulesCreateResponseBody>) @@ -8716,7 +8716,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. List<LoyaltyTier> @@ -8726,7 +8726,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. ApiResponse of List<LoyaltyTier> @@ -8736,7 +8736,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of List<LoyaltyTier> @@ -8747,7 +8747,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (List<LoyaltyTier>) @@ -8757,7 +8757,7 @@ Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. LoyaltiesCreateCampaignResponseBody @@ -8766,7 +8766,7 @@ Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. ApiResponse of LoyaltiesCreateCampaignResponseBody @@ -8775,7 +8775,7 @@ Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesCreateCampaignResponseBody @@ -8785,7 +8785,7 @@ Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesCreateCampaignResponseBody) @@ -8796,7 +8796,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. LoyaltiesPointsExpirationExportCreateResponseBody @@ -8806,7 +8806,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. ApiResponse of LoyaltiesPointsExpirationExportCreateResponseBody @@ -8816,7 +8816,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesPointsExpirationExportCreateResponseBody @@ -8827,7 +8827,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesPointsExpirationExportCreateResponseBody) @@ -8838,7 +8838,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. LoyaltiesRewardsCreateAssignmentResponseBody @@ -8848,7 +8848,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. ApiResponse of LoyaltiesRewardsCreateAssignmentResponseBody @@ -8858,7 +8858,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesRewardsCreateAssignmentResponseBody @@ -8869,7 +8869,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesRewardsCreateAssignmentResponseBody) @@ -9090,7 +9090,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. CampaignsTransactionsExportCreateResponseBody @@ -9100,7 +9100,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. ApiResponse of CampaignsTransactionsExportCreateResponseBody @@ -9110,7 +9110,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsTransactionsExportCreateResponseBody @@ -9121,7 +9121,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) @@ -9132,7 +9132,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9142,7 +9142,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9152,7 +9152,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9163,7 +9163,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) @@ -9175,7 +9175,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9186,7 +9186,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9197,7 +9197,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9209,7 +9209,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) @@ -10510,7 +10510,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. LoyaltiesMembersRedemptionRedeemResponseBody @@ -10520,7 +10520,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody @@ -10530,7 +10530,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersRedemptionRedeemResponseBody @@ -10541,7 +10541,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) @@ -10553,7 +10553,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. LoyaltiesMembersRedemptionRedeemResponseBody @@ -10564,7 +10564,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody @@ -10575,7 +10575,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersRedemptionRedeemResponseBody @@ -10587,7 +10587,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) @@ -10599,7 +10599,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. LoyaltiesMembersTransfersCreateResponseBody @@ -10610,7 +10610,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. ApiResponse of LoyaltiesMembersTransfersCreateResponseBody @@ -10621,7 +10621,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransfersCreateResponseBody @@ -10633,7 +10633,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransfersCreateResponseBody) @@ -10645,7 +10645,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. LoyaltiesEarningRulesUpdateResponseBody @@ -10656,7 +10656,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. ApiResponse of LoyaltiesEarningRulesUpdateResponseBody @@ -10667,7 +10667,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesEarningRulesUpdateResponseBody @@ -10679,7 +10679,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesEarningRulesUpdateResponseBody) @@ -10690,7 +10690,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. LoyaltiesMembersBalanceUpdateResponseBody @@ -10700,7 +10700,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody @@ -10710,7 +10710,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersBalanceUpdateResponseBody @@ -10721,7 +10721,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) @@ -10733,7 +10733,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. LoyaltiesMembersBalanceUpdateResponseBody @@ -10744,7 +10744,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody @@ -10755,7 +10755,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersBalanceUpdateResponseBody @@ -10767,7 +10767,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) @@ -10778,7 +10778,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. LoyaltiesUpdateCampaignResponseBody @@ -10788,7 +10788,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. ApiResponse of LoyaltiesUpdateCampaignResponseBody @@ -10798,7 +10798,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesUpdateCampaignResponseBody @@ -10809,7 +10809,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesUpdateCampaignResponseBody) @@ -10821,7 +10821,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. LoyaltiesRewardsUpdateAssignmentResponseBody @@ -10832,7 +10832,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. ApiResponse of LoyaltiesRewardsUpdateAssignmentResponseBody @@ -10843,7 +10843,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesRewardsUpdateAssignmentResponseBody @@ -10855,7 +10855,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesRewardsUpdateAssignmentResponseBody) @@ -10874,7 +10874,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. ManagementProjectsUsersAssignResponseBody @@ -10887,7 +10887,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. ApiResponse of ManagementProjectsUsersAssignResponseBody @@ -10900,7 +10900,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. ManagementProjectsBrandingCreateResponseBody @@ -10913,7 +10913,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. ApiResponse of ManagementProjectsBrandingCreateResponseBody @@ -10926,7 +10926,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. ManagementProjectsCustomEventSchemasCreateResponseBody @@ -10939,7 +10939,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. ApiResponse of ManagementProjectsCustomEventSchemasCreateResponseBody @@ -10952,7 +10952,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. ManagementProjectsMetadataSchemasCreateResponseBody @@ -10965,7 +10965,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. ApiResponse of ManagementProjectsMetadataSchemasCreateResponseBody @@ -10977,7 +10977,7 @@ Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. ManagementProjectsCreateResponseBody @@ -10989,7 +10989,7 @@ Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. ApiResponse of ManagementProjectsCreateResponseBody @@ -11002,7 +11002,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. ManagementProjectsStackingRulesCreateResponseBody @@ -11015,7 +11015,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. ApiResponse of ManagementProjectsStackingRulesCreateResponseBody @@ -11028,7 +11028,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. ManagementProjectsWebhooksCreateResponseBody @@ -11041,7 +11041,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. ApiResponse of ManagementProjectsWebhooksCreateResponseBody @@ -11387,7 +11387,7 @@ Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. @@ -11399,7 +11399,7 @@ Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. ApiResponse of Object(void) @@ -11579,7 +11579,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -11593,7 +11593,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. ApiResponse of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -11667,7 +11667,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. ManagementProjectsBrandingUpdateResponseBody @@ -11681,7 +11681,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. ApiResponse of ManagementProjectsBrandingUpdateResponseBody @@ -11695,7 +11695,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -11709,7 +11709,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. ApiResponse of ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -11723,7 +11723,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. ManagementProjectsMetadataSchemasUpdateResponseBody @@ -11737,7 +11737,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. ApiResponse of ManagementProjectsMetadataSchemasUpdateResponseBody @@ -11750,7 +11750,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. ManagementProjectsUpdateResponseBody @@ -11763,7 +11763,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. ApiResponse of ManagementProjectsUpdateResponseBody @@ -11777,7 +11777,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. ManagementProjectsStackingRulesUpdateResponseBody @@ -11791,7 +11791,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. ApiResponse of ManagementProjectsStackingRulesUpdateResponseBody @@ -11805,7 +11805,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. ManagementProjectsUsersUpdateRoleResponseBody @@ -11819,7 +11819,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. ApiResponse of ManagementProjectsUsersUpdateRoleResponseBody @@ -11833,7 +11833,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. ManagementProjectsWebhooksUpdateResponseBody @@ -11847,7 +11847,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. ApiResponse of ManagementProjectsWebhooksUpdateResponseBody @@ -11865,7 +11865,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUsersAssignResponseBody @@ -11879,7 +11879,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUsersAssignResponseBody) @@ -11893,7 +11893,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsBrandingCreateResponseBody @@ -11907,7 +11907,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsBrandingCreateResponseBody) @@ -11921,7 +11921,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCustomEventSchemasCreateResponseBody @@ -11935,7 +11935,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCustomEventSchemasCreateResponseBody) @@ -11949,7 +11949,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsMetadataSchemasCreateResponseBody @@ -11963,7 +11963,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsMetadataSchemasCreateResponseBody) @@ -11976,7 +11976,7 @@ Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCreateResponseBody @@ -11989,7 +11989,7 @@ Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCreateResponseBody) @@ -12003,7 +12003,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsStackingRulesCreateResponseBody @@ -12017,7 +12017,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsStackingRulesCreateResponseBody) @@ -12031,7 +12031,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsWebhooksCreateResponseBody @@ -12045,7 +12045,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsWebhooksCreateResponseBody) @@ -12418,7 +12418,7 @@ Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. Cancellation Token to cancel the request. Task of void @@ -12431,7 +12431,7 @@ Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse @@ -12626,7 +12626,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -12641,7 +12641,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsTemplatesCampaignsCopyCreateResponseBody) @@ -12720,7 +12720,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsBrandingUpdateResponseBody @@ -12735,7 +12735,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsBrandingUpdateResponseBody) @@ -12750,7 +12750,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -12765,7 +12765,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCustomEventSchemasUpdateResponseBody) @@ -12780,7 +12780,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsMetadataSchemasUpdateResponseBody @@ -12795,7 +12795,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsMetadataSchemasUpdateResponseBody) @@ -12809,7 +12809,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUpdateResponseBody @@ -12823,7 +12823,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUpdateResponseBody) @@ -12838,7 +12838,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsStackingRulesUpdateResponseBody @@ -12853,7 +12853,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsStackingRulesUpdateResponseBody) @@ -12868,7 +12868,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUsersUpdateRoleResponseBody @@ -12883,7 +12883,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUsersUpdateRoleResponseBody) @@ -12898,7 +12898,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsWebhooksUpdateResponseBody @@ -12913,7 +12913,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsWebhooksUpdateResponseBody) @@ -12990,7 +12990,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. ManagementProjectsUsersAssignResponseBody @@ -13000,7 +13000,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. ApiResponse of ManagementProjectsUsersAssignResponseBody @@ -13010,7 +13010,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUsersAssignResponseBody @@ -13021,7 +13021,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUsersAssignResponseBody) @@ -13032,7 +13032,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. ManagementProjectsBrandingCreateResponseBody @@ -13042,7 +13042,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. ApiResponse of ManagementProjectsBrandingCreateResponseBody @@ -13052,7 +13052,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsBrandingCreateResponseBody @@ -13063,7 +13063,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsBrandingCreateResponseBody) @@ -13074,7 +13074,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. ManagementProjectsCustomEventSchemasCreateResponseBody @@ -13084,7 +13084,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. ApiResponse of ManagementProjectsCustomEventSchemasCreateResponseBody @@ -13094,7 +13094,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCustomEventSchemasCreateResponseBody @@ -13105,7 +13105,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCustomEventSchemasCreateResponseBody) @@ -13116,7 +13116,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. ManagementProjectsMetadataSchemasCreateResponseBody @@ -13126,7 +13126,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. ApiResponse of ManagementProjectsMetadataSchemasCreateResponseBody @@ -13136,7 +13136,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsMetadataSchemasCreateResponseBody @@ -13147,7 +13147,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsMetadataSchemasCreateResponseBody) @@ -13157,7 +13157,7 @@ Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. ManagementProjectsCreateResponseBody @@ -13166,7 +13166,7 @@ Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. ApiResponse of ManagementProjectsCreateResponseBody @@ -13175,7 +13175,7 @@ Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCreateResponseBody @@ -13185,7 +13185,7 @@ Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCreateResponseBody) @@ -13196,7 +13196,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. ManagementProjectsStackingRulesCreateResponseBody @@ -13206,7 +13206,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. ApiResponse of ManagementProjectsStackingRulesCreateResponseBody @@ -13216,7 +13216,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsStackingRulesCreateResponseBody @@ -13227,7 +13227,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsStackingRulesCreateResponseBody) @@ -13238,7 +13238,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. ManagementProjectsWebhooksCreateResponseBody @@ -13248,7 +13248,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. ApiResponse of ManagementProjectsWebhooksCreateResponseBody @@ -13258,7 +13258,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsWebhooksCreateResponseBody @@ -13269,7 +13269,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsWebhooksCreateResponseBody) @@ -13817,7 +13817,7 @@ Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. @@ -13826,7 +13826,7 @@ Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. ApiResponse of Object(void) @@ -13835,7 +13835,7 @@ Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. Cancellation Token to cancel the request. Task of void @@ -13845,7 +13845,7 @@ Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse @@ -14119,7 +14119,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -14130,7 +14130,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. ApiResponse of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -14141,7 +14141,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -14153,7 +14153,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsTemplatesCampaignsCopyCreateResponseBody) @@ -14265,7 +14265,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. ManagementProjectsBrandingUpdateResponseBody @@ -14276,7 +14276,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. ApiResponse of ManagementProjectsBrandingUpdateResponseBody @@ -14287,7 +14287,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsBrandingUpdateResponseBody @@ -14299,7 +14299,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsBrandingUpdateResponseBody) @@ -14311,7 +14311,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -14322,7 +14322,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. ApiResponse of ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -14333,7 +14333,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -14345,7 +14345,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCustomEventSchemasUpdateResponseBody) @@ -14357,7 +14357,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. ManagementProjectsMetadataSchemasUpdateResponseBody @@ -14368,7 +14368,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. ApiResponse of ManagementProjectsMetadataSchemasUpdateResponseBody @@ -14379,7 +14379,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsMetadataSchemasUpdateResponseBody @@ -14391,7 +14391,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsMetadataSchemasUpdateResponseBody) @@ -14402,7 +14402,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. ManagementProjectsUpdateResponseBody @@ -14412,7 +14412,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. ApiResponse of ManagementProjectsUpdateResponseBody @@ -14422,7 +14422,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUpdateResponseBody @@ -14433,7 +14433,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUpdateResponseBody) @@ -14445,7 +14445,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. ManagementProjectsStackingRulesUpdateResponseBody @@ -14456,7 +14456,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. ApiResponse of ManagementProjectsStackingRulesUpdateResponseBody @@ -14467,7 +14467,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsStackingRulesUpdateResponseBody @@ -14479,7 +14479,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsStackingRulesUpdateResponseBody) @@ -14491,7 +14491,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. ManagementProjectsUsersUpdateRoleResponseBody @@ -14502,7 +14502,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. ApiResponse of ManagementProjectsUsersUpdateRoleResponseBody @@ -14513,7 +14513,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUsersUpdateRoleResponseBody @@ -14525,7 +14525,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUsersUpdateRoleResponseBody) @@ -14537,7 +14537,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. ManagementProjectsWebhooksUpdateResponseBody @@ -14548,7 +14548,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. ApiResponse of ManagementProjectsWebhooksUpdateResponseBody @@ -14559,7 +14559,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsWebhooksUpdateResponseBody @@ -14571,7 +14571,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsWebhooksUpdateResponseBody) @@ -15181,7 +15181,7 @@ Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. OrdersCreateResponseBody @@ -15193,7 +15193,7 @@ Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. ApiResponse of OrdersCreateResponseBody @@ -15205,7 +15205,7 @@ Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. OrdersExportCreateResponseBody @@ -15217,7 +15217,7 @@ Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. ApiResponse of OrdersExportCreateResponseBody @@ -15250,10 +15250,10 @@ Import Orders - 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. OrdersImportCreateResponseBody @@ -15262,10 +15262,10 @@ Import Orders - 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. ApiResponse of OrdersImportCreateResponseBody @@ -15306,7 +15306,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. OrdersUpdateResponseBody @@ -15319,7 +15319,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. ApiResponse of OrdersUpdateResponseBody @@ -15336,7 +15336,7 @@ Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersCreateResponseBody @@ -15349,7 +15349,7 @@ Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersCreateResponseBody) @@ -15362,7 +15362,7 @@ Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersExportCreateResponseBody @@ -15375,7 +15375,7 @@ Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersExportCreateResponseBody) @@ -15411,10 +15411,10 @@ Import Orders - 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersImportCreateResponseBody @@ -15424,10 +15424,10 @@ Import Orders - 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersImportCreateResponseBody) @@ -15471,7 +15471,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersUpdateResponseBody @@ -15485,7 +15485,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersUpdateResponseBody) @@ -15561,7 +15561,7 @@ Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. OrdersCreateResponseBody @@ -15570,7 +15570,7 @@ Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. ApiResponse of OrdersCreateResponseBody @@ -15579,7 +15579,7 @@ Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersCreateResponseBody @@ -15589,7 +15589,7 @@ Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersCreateResponseBody) @@ -15599,7 +15599,7 @@ Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. OrdersExportCreateResponseBody @@ -15608,7 +15608,7 @@ Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. ApiResponse of OrdersExportCreateResponseBody @@ -15617,7 +15617,7 @@ Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersExportCreateResponseBody @@ -15627,7 +15627,7 @@ Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersExportCreateResponseBody) @@ -15672,38 +15672,38 @@ - Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. OrdersImportCreateResponseBody - Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. ApiResponse of OrdersImportCreateResponseBody - Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersImportCreateResponseBody - Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersImportCreateResponseBody) @@ -15760,7 +15760,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. OrdersUpdateResponseBody @@ -15770,7 +15770,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. ApiResponse of OrdersUpdateResponseBody @@ -15780,7 +15780,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersUpdateResponseBody @@ -15791,7 +15791,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersUpdateResponseBody) @@ -15809,7 +15809,7 @@ This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. ProductCollectionsCreateResponseBody @@ -15821,7 +15821,7 @@ This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of ProductCollectionsCreateResponseBody @@ -15946,7 +15946,7 @@ This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ProductCollectionsCreateResponseBody @@ -15959,7 +15959,7 @@ This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductCollectionsCreateResponseBody) @@ -16151,7 +16151,7 @@ Create Product Collection This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. ProductCollectionsCreateResponseBody @@ -16160,7 +16160,7 @@ Create Product Collection This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of ProductCollectionsCreateResponseBody @@ -16169,7 +16169,7 @@ Create Product Collection This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ProductCollectionsCreateResponseBody @@ -16179,7 +16179,7 @@ Create Product Collection This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductCollectionsCreateResponseBody) @@ -16373,7 +16373,7 @@ Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. ProductsCreateResponseBody @@ -16385,7 +16385,7 @@ Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. ApiResponse of ProductsCreateResponseBody @@ -16398,7 +16398,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. ProductsSkusCreateResponseBody @@ -16411,7 +16411,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. ApiResponse of ProductsSkusCreateResponseBody @@ -16640,7 +16640,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. ProductsUpdateResponseBody @@ -16653,7 +16653,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. ApiResponse of ProductsUpdateResponseBody @@ -16665,7 +16665,7 @@ Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. ProductsUpdateInBulkResponseBody @@ -16677,7 +16677,7 @@ Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. ApiResponse of ProductsUpdateInBulkResponseBody @@ -16689,7 +16689,7 @@ Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. ProductsMetadataUpdateInBulkResponseBody @@ -16701,7 +16701,7 @@ Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. ApiResponse of ProductsMetadataUpdateInBulkResponseBody @@ -16715,7 +16715,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ProductsSkusUpdateResponseBody @@ -16729,7 +16729,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of ProductsSkusUpdateResponseBody @@ -16746,7 +16746,7 @@ Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsCreateResponseBody @@ -16759,7 +16759,7 @@ Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsCreateResponseBody) @@ -16773,7 +16773,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsSkusCreateResponseBody @@ -16787,7 +16787,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsSkusCreateResponseBody) @@ -17033,7 +17033,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsUpdateResponseBody @@ -17047,7 +17047,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsUpdateResponseBody) @@ -17060,7 +17060,7 @@ Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsUpdateInBulkResponseBody @@ -17073,7 +17073,7 @@ Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsUpdateInBulkResponseBody) @@ -17086,7 +17086,7 @@ Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsMetadataUpdateInBulkResponseBody @@ -17099,7 +17099,7 @@ Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsMetadataUpdateInBulkResponseBody) @@ -17114,7 +17114,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsSkusUpdateResponseBody @@ -17129,7 +17129,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsSkusUpdateResponseBody) @@ -17205,7 +17205,7 @@ Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. ProductsCreateResponseBody @@ -17214,7 +17214,7 @@ Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. ApiResponse of ProductsCreateResponseBody @@ -17223,7 +17223,7 @@ Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsCreateResponseBody @@ -17233,7 +17233,7 @@ Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsCreateResponseBody) @@ -17244,7 +17244,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. ProductsSkusCreateResponseBody @@ -17254,7 +17254,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. ApiResponse of ProductsSkusCreateResponseBody @@ -17264,7 +17264,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsSkusCreateResponseBody @@ -17275,7 +17275,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsSkusCreateResponseBody) @@ -17638,7 +17638,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. ProductsUpdateResponseBody @@ -17648,7 +17648,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. ApiResponse of ProductsUpdateResponseBody @@ -17658,7 +17658,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsUpdateResponseBody @@ -17669,7 +17669,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsUpdateResponseBody) @@ -17679,7 +17679,7 @@ Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. ProductsUpdateInBulkResponseBody @@ -17688,7 +17688,7 @@ Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. ApiResponse of ProductsUpdateInBulkResponseBody @@ -17697,7 +17697,7 @@ Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsUpdateInBulkResponseBody @@ -17707,7 +17707,7 @@ Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsUpdateInBulkResponseBody) @@ -17717,7 +17717,7 @@ Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. ProductsMetadataUpdateInBulkResponseBody @@ -17726,7 +17726,7 @@ Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. ApiResponse of ProductsMetadataUpdateInBulkResponseBody @@ -17735,7 +17735,7 @@ Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsMetadataUpdateInBulkResponseBody @@ -17745,7 +17745,7 @@ Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsMetadataUpdateInBulkResponseBody) @@ -17757,7 +17757,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ProductsSkusUpdateResponseBody @@ -17768,7 +17768,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of ProductsSkusUpdateResponseBody @@ -17779,7 +17779,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsSkusUpdateResponseBody @@ -17791,7 +17791,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsSkusUpdateResponseBody) @@ -17810,7 +17810,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. PromotionsTiersCreateResponseBody @@ -17823,7 +17823,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. ApiResponse of PromotionsTiersCreateResponseBody @@ -17836,7 +17836,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. PromotionsStacksCreateResponseBody @@ -17849,7 +17849,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. ApiResponse of PromotionsStacksCreateResponseBody @@ -18121,7 +18121,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. PromotionsStacksUpdateResponseBody @@ -18135,7 +18135,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. ApiResponse of PromotionsStacksUpdateResponseBody @@ -18148,7 +18148,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. PromotionsTiersUpdateResponseBody @@ -18161,7 +18161,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. ApiResponse of PromotionsTiersUpdateResponseBody @@ -18179,7 +18179,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsTiersCreateResponseBody @@ -18193,7 +18193,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsTiersCreateResponseBody) @@ -18207,7 +18207,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsStacksCreateResponseBody @@ -18221,7 +18221,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsStacksCreateResponseBody) @@ -18514,7 +18514,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsStacksUpdateResponseBody @@ -18529,7 +18529,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsStacksUpdateResponseBody) @@ -18543,7 +18543,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsTiersUpdateResponseBody @@ -18557,7 +18557,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsTiersUpdateResponseBody) @@ -18634,7 +18634,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. PromotionsTiersCreateResponseBody @@ -18644,7 +18644,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. ApiResponse of PromotionsTiersCreateResponseBody @@ -18654,7 +18654,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsTiersCreateResponseBody @@ -18665,7 +18665,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsTiersCreateResponseBody) @@ -18676,7 +18676,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. PromotionsStacksCreateResponseBody @@ -18686,7 +18686,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. ApiResponse of PromotionsStacksCreateResponseBody @@ -18696,7 +18696,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsStacksCreateResponseBody @@ -18707,7 +18707,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsStacksCreateResponseBody) @@ -19135,7 +19135,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. PromotionsStacksUpdateResponseBody @@ -19146,7 +19146,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. ApiResponse of PromotionsStacksUpdateResponseBody @@ -19157,7 +19157,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsStacksUpdateResponseBody @@ -19169,7 +19169,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsStacksUpdateResponseBody) @@ -19180,7 +19180,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. PromotionsTiersUpdateResponseBody @@ -19190,7 +19190,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. ApiResponse of PromotionsTiersUpdateResponseBody @@ -19200,7 +19200,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsTiersUpdateResponseBody @@ -19211,7 +19211,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsTiersUpdateResponseBody) @@ -19221,7 +19221,7 @@ Represents a collection of functions to interact with the API endpoints - + Create Publication @@ -19229,12 +19229,12 @@ This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. PublicationsCreateResponseBody - + Create Publication @@ -19242,8 +19242,8 @@ This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. ApiResponse of PublicationsCreateResponseBody @@ -19330,7 +19330,7 @@ Represents a collection of functions to interact with the API endpoints - + Create Publication @@ -19338,13 +19338,13 @@ This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of PublicationsCreateResponseBody - + Create Publication @@ -19352,8 +19352,8 @@ This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PublicationsCreateResponseBody) @@ -19506,44 +19506,44 @@ Provides a factory method hook for the creation of exceptions. - + Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. PublicationsCreateResponseBody - + Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. ApiResponse of PublicationsCreateResponseBody - + Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of PublicationsCreateResponseBody - + Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PublicationsCreateResponseBody) @@ -19697,7 +19697,7 @@ 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. QualificationsCheckEligibilityResponseBody @@ -19709,7 +19709,7 @@ 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ApiResponse of QualificationsCheckEligibilityResponseBody @@ -19726,7 +19726,7 @@ 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of QualificationsCheckEligibilityResponseBody @@ -19739,7 +19739,7 @@ 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (QualificationsCheckEligibilityResponseBody) @@ -19815,7 +19815,7 @@ Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. QualificationsCheckEligibilityResponseBody @@ -19824,7 +19824,7 @@ Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ApiResponse of QualificationsCheckEligibilityResponseBody @@ -19833,7 +19833,7 @@ Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of QualificationsCheckEligibilityResponseBody @@ -19843,7 +19843,7 @@ Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (QualificationsCheckEligibilityResponseBody) @@ -19944,10 +19944,10 @@ Redeem Stackable Discounts - # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. RedemptionsRedeemResponseBody @@ -19956,14 +19956,14 @@ Redeem Stackable Discounts - # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of RedemptionsRedeemResponseBody - + Rollback Redemption @@ -19972,13 +19972,13 @@ Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. RedemptionsRollbackCreateResponseBody - + Rollback Redemption @@ -19987,13 +19987,13 @@ Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. ApiResponse of RedemptionsRollbackCreateResponseBody - + Rollback Stackable Redemptions @@ -20002,13 +20002,13 @@ Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions @@ -20017,9 +20017,9 @@ Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. ApiResponse of RedemptionsRollbacksCreateResponseBody @@ -20125,10 +20125,10 @@ Redeem Stackable Discounts - # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRedeemResponseBody @@ -20138,15 +20138,15 @@ Redeem Stackable Discounts - # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRedeemResponseBody) - + Rollback Redemption @@ -20155,14 +20155,14 @@ Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRollbackCreateResponseBody - + Rollback Redemption @@ -20171,14 +20171,14 @@ Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRollbackCreateResponseBody) - + Rollback Stackable Redemptions @@ -20187,14 +20187,14 @@ Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions @@ -20203,9 +20203,9 @@ Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRollbacksCreateResponseBody) @@ -20420,138 +20420,138 @@ - Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. RedemptionsRedeemResponseBody - Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of RedemptionsRedeemResponseBody - Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRedeemResponseBody - Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRedeemResponseBody) - + Rollback Redemption Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions) 🚧 You can roll back a redemption up to 3 months back. # Effect The operation - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and - gives 1 redemption back to the pool (decreases redeemed_quantity by 1). # Returned funds In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption. Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. RedemptionsRollbackCreateResponseBody - + Rollback Redemption Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions) 🚧 You can roll back a redemption up to 3 months back. # Effect The operation - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and - gives 1 redemption back to the pool (decreases redeemed_quantity by 1). # Returned funds In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption. Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. ApiResponse of RedemptionsRollbackCreateResponseBody - + Rollback Redemption Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions) 🚧 You can roll back a redemption up to 3 months back. # Effect The operation - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and - gives 1 redemption back to the pool (decreases redeemed_quantity by 1). # Returned funds In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption. Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRollbackCreateResponseBody - + Rollback Redemption Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions) 🚧 You can roll back a redemption up to 3 months back. # Effect The operation - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and - gives 1 redemption back to the pool (decreases redeemed_quantity by 1). # Returned funds In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption. Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRollbackCreateResponseBody) - + Rollback Stackable Redemptions Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧 You can roll back a redemption up to 3 months back. Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧 You can roll back a redemption up to 3 months back. Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. ApiResponse of RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧 You can roll back a redemption up to 3 months back. Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧 You can roll back a redemption up to 3 months back. Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRollbacksCreateResponseBody) @@ -20570,7 +20570,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ReferralsMembersHoldersCreateInBulkResponseBody @@ -20583,7 +20583,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody @@ -20597,7 +20597,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ReferralsMembersHoldersCreateInBulkResponseBody @@ -20611,7 +20611,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody @@ -20749,7 +20749,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ReferralsMembersHoldersCreateInBulkResponseBody @@ -20763,7 +20763,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) @@ -20778,7 +20778,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ReferralsMembersHoldersCreateInBulkResponseBody @@ -20793,7 +20793,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) @@ -20998,7 +20998,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ReferralsMembersHoldersCreateInBulkResponseBody @@ -21008,7 +21008,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody @@ -21018,7 +21018,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ReferralsMembersHoldersCreateInBulkResponseBody @@ -21029,7 +21029,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) @@ -21041,7 +21041,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ReferralsMembersHoldersCreateInBulkResponseBody @@ -21052,7 +21052,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody @@ -21063,7 +21063,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ReferralsMembersHoldersCreateInBulkResponseBody @@ -21075,7 +21075,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) @@ -21293,7 +21293,7 @@ Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. RewardsCreateResponseBody @@ -21305,7 +21305,7 @@ Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. ApiResponse of RewardsCreateResponseBody @@ -21318,7 +21318,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. RewardsAssignmentsCreateResponseBody @@ -21331,7 +21331,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. ApiResponse of RewardsAssignmentsCreateResponseBody @@ -21500,7 +21500,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. RewardsUpdateResponseBody @@ -21513,7 +21513,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. ApiResponse of RewardsUpdateResponseBody @@ -21527,7 +21527,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. RewardsAssignmentsUpdateResponseBody @@ -21541,7 +21541,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. ApiResponse of RewardsAssignmentsUpdateResponseBody @@ -21558,7 +21558,7 @@ Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsCreateResponseBody @@ -21571,7 +21571,7 @@ Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsCreateResponseBody) @@ -21585,7 +21585,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsAssignmentsCreateResponseBody @@ -21599,7 +21599,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsAssignmentsCreateResponseBody) @@ -21781,7 +21781,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsUpdateResponseBody @@ -21795,7 +21795,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsUpdateResponseBody) @@ -21810,7 +21810,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsAssignmentsUpdateResponseBody @@ -21825,7 +21825,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsAssignmentsUpdateResponseBody) @@ -21901,7 +21901,7 @@ Create Reward Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. RewardsCreateResponseBody @@ -21910,7 +21910,7 @@ Create Reward Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. ApiResponse of RewardsCreateResponseBody @@ -21919,7 +21919,7 @@ Create Reward Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsCreateResponseBody @@ -21929,7 +21929,7 @@ Create Reward Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsCreateResponseBody) @@ -21940,7 +21940,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. RewardsAssignmentsCreateResponseBody @@ -21950,7 +21950,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. ApiResponse of RewardsAssignmentsCreateResponseBody @@ -21960,7 +21960,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsAssignmentsCreateResponseBody @@ -21971,7 +21971,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsAssignmentsCreateResponseBody) @@ -22234,7 +22234,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. RewardsUpdateResponseBody @@ -22244,7 +22244,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. ApiResponse of RewardsUpdateResponseBody @@ -22254,7 +22254,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsUpdateResponseBody @@ -22265,7 +22265,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsUpdateResponseBody) @@ -22277,7 +22277,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. RewardsAssignmentsUpdateResponseBody @@ -22288,7 +22288,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. ApiResponse of RewardsAssignmentsUpdateResponseBody @@ -22299,7 +22299,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsAssignmentsUpdateResponseBody @@ -22311,7 +22311,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsAssignmentsUpdateResponseBody) @@ -22329,7 +22329,7 @@ Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. SegmentsCreateResponseBody @@ -22341,7 +22341,7 @@ Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. ApiResponse of SegmentsCreateResponseBody @@ -22406,7 +22406,7 @@ Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. Cancellation Token to cancel the request. Task of SegmentsCreateResponseBody @@ -22419,7 +22419,7 @@ Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (SegmentsCreateResponseBody) @@ -22547,7 +22547,7 @@ Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. SegmentsCreateResponseBody @@ -22556,7 +22556,7 @@ Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. ApiResponse of SegmentsCreateResponseBody @@ -22565,7 +22565,7 @@ Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. Cancellation Token to cancel the request. Task of SegmentsCreateResponseBody @@ -22575,7 +22575,7 @@ Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (SegmentsCreateResponseBody) @@ -22670,7 +22670,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. TemplatesCampaignsTierSetupCreateResponseBody @@ -22683,7 +22683,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. ApiResponse of TemplatesCampaignsTierSetupCreateResponseBody @@ -22696,7 +22696,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. TemplatesCampaignsCampaignSetupCreateResponseBody @@ -22709,7 +22709,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. ApiResponse of TemplatesCampaignsCampaignSetupCreateResponseBody @@ -22721,7 +22721,7 @@ Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. TemplatesCampaignsCreateTemplateResponseBody @@ -22733,7 +22733,7 @@ Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. ApiResponse of TemplatesCampaignsCreateTemplateResponseBody @@ -22826,7 +22826,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. TemplatesCampaignsUpdateResponseBody @@ -22839,7 +22839,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. ApiResponse of TemplatesCampaignsUpdateResponseBody @@ -22857,7 +22857,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsTierSetupCreateResponseBody @@ -22871,7 +22871,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsTierSetupCreateResponseBody) @@ -22885,7 +22885,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsCampaignSetupCreateResponseBody @@ -22899,7 +22899,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsCampaignSetupCreateResponseBody) @@ -22912,7 +22912,7 @@ Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsCreateTemplateResponseBody @@ -22925,7 +22925,7 @@ Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsCreateTemplateResponseBody) @@ -23025,7 +23025,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsUpdateResponseBody @@ -23039,7 +23039,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsUpdateResponseBody) @@ -23116,7 +23116,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. TemplatesCampaignsTierSetupCreateResponseBody @@ -23126,7 +23126,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. ApiResponse of TemplatesCampaignsTierSetupCreateResponseBody @@ -23136,7 +23136,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsTierSetupCreateResponseBody @@ -23147,7 +23147,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsTierSetupCreateResponseBody) @@ -23158,7 +23158,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. TemplatesCampaignsCampaignSetupCreateResponseBody @@ -23168,7 +23168,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. ApiResponse of TemplatesCampaignsCampaignSetupCreateResponseBody @@ -23178,7 +23178,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsCampaignSetupCreateResponseBody @@ -23189,7 +23189,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsCampaignSetupCreateResponseBody) @@ -23199,7 +23199,7 @@ Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. TemplatesCampaignsCreateTemplateResponseBody @@ -23208,7 +23208,7 @@ Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. ApiResponse of TemplatesCampaignsCreateTemplateResponseBody @@ -23217,7 +23217,7 @@ Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsCreateTemplateResponseBody @@ -23227,7 +23227,7 @@ Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsCreateTemplateResponseBody) @@ -23368,7 +23368,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. TemplatesCampaignsUpdateResponseBody @@ -23378,7 +23378,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. ApiResponse of TemplatesCampaignsUpdateResponseBody @@ -23388,7 +23388,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsUpdateResponseBody @@ -23399,7 +23399,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsUpdateResponseBody) @@ -23409,7 +23409,7 @@ Represents a collection of functions to interact with the API endpoints - + Create Validation Rules Assignments @@ -23418,12 +23418,12 @@ Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments @@ -23432,8 +23432,8 @@ Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. ApiResponse of ValidationRulesAssignmentsCreateResponseBody @@ -23445,7 +23445,7 @@ Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. ValidationRulesCreateResponseBody @@ -23457,7 +23457,7 @@ Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. ApiResponse of ValidationRulesCreateResponseBody @@ -23638,7 +23638,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ValidationRulesUpdateResponseBody @@ -23651,7 +23651,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of ValidationRulesUpdateResponseBody @@ -23660,7 +23660,7 @@ Represents a collection of functions to interact with the API endpoints - + Create Validation Rules Assignments @@ -23669,13 +23669,13 @@ Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments @@ -23684,8 +23684,8 @@ Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesAssignmentsCreateResponseBody) @@ -23698,7 +23698,7 @@ Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesCreateResponseBody @@ -23711,7 +23711,7 @@ Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesCreateResponseBody) @@ -23905,7 +23905,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesUpdateResponseBody @@ -23919,7 +23919,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesUpdateResponseBody) @@ -23990,48 +23990,48 @@ Provides a factory method hook for the creation of exceptions. - + Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution. Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution. Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. ApiResponse of ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution. Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution. Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesAssignmentsCreateResponseBody) @@ -24041,7 +24041,7 @@ Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. ValidationRulesCreateResponseBody @@ -24050,7 +24050,7 @@ Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. ApiResponse of ValidationRulesCreateResponseBody @@ -24059,7 +24059,7 @@ Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesCreateResponseBody @@ -24069,7 +24069,7 @@ Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesCreateResponseBody) @@ -24356,7 +24356,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ValidationRulesUpdateResponseBody @@ -24366,7 +24366,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of ValidationRulesUpdateResponseBody @@ -24376,7 +24376,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesUpdateResponseBody @@ -24387,7 +24387,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesUpdateResponseBody) @@ -24405,7 +24405,7 @@ Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. ValidationsValidateResponseBody @@ -24417,7 +24417,7 @@ Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of ValidationsValidateResponseBody @@ -24434,7 +24434,7 @@ Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationsValidateResponseBody @@ -24447,7 +24447,7 @@ Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationsValidateResponseBody) @@ -24523,7 +24523,7 @@ Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. ValidationsValidateResponseBody @@ -24532,7 +24532,7 @@ Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of ValidationsValidateResponseBody @@ -24541,7 +24541,7 @@ Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationsValidateResponseBody @@ -24551,7 +24551,7 @@ Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationsValidateResponseBody) @@ -24570,7 +24570,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. VouchersCreateResponseBody @@ -24583,7 +24583,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. ApiResponse of VouchersCreateResponseBody @@ -24670,7 +24670,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. VouchersTransactionsExportCreateResponseBody @@ -24683,7 +24683,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. ApiResponse of VouchersTransactionsExportCreateResponseBody @@ -24695,7 +24695,7 @@ Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. VouchersCreateResponseBody @@ -24707,7 +24707,7 @@ Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. ApiResponse of VouchersCreateResponseBody @@ -24740,7 +24740,7 @@ Import Vouchers - Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -24752,7 +24752,7 @@ Import Vouchers - Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -24764,7 +24764,7 @@ Import Vouchers using CSV - Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -24777,7 +24777,7 @@ Import Vouchers using CSV - Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -24815,7 +24815,7 @@ Index associated with the operation. ApiResponse of VouchersTransactionsListResponseBody - + List Vouchers @@ -24834,10 +24834,11 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. VouchersListResponseBody - + List Vouchers @@ -24856,6 +24857,7 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. ApiResponse of VouchersListResponseBody @@ -24999,7 +25001,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersCreateResponseBody @@ -25013,7 +25015,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersCreateResponseBody) @@ -25107,7 +25109,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersTransactionsExportCreateResponseBody @@ -25121,7 +25123,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersTransactionsExportCreateResponseBody) @@ -25134,7 +25136,7 @@ Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersCreateResponseBody @@ -25147,7 +25149,7 @@ Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersCreateResponseBody) @@ -25183,7 +25185,7 @@ Import Vouchers - Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25196,7 +25198,7 @@ Import Vouchers - Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25209,7 +25211,7 @@ Import Vouchers using CSV - Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25223,7 +25225,7 @@ Import Vouchers using CSV - Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25264,7 +25266,7 @@ Cancellation Token to cancel the request. Task of ApiResponse (VouchersTransactionsListResponseBody) - + List Vouchers @@ -25283,11 +25285,12 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersListResponseBody - + List Vouchers @@ -25306,6 +25309,7 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersListResponseBody) @@ -25518,7 +25522,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. VouchersCreateResponseBody @@ -25528,7 +25532,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. ApiResponse of VouchersCreateResponseBody @@ -25538,7 +25542,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersCreateResponseBody @@ -25549,7 +25553,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersCreateResponseBody) @@ -25678,7 +25682,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. VouchersTransactionsExportCreateResponseBody @@ -25688,7 +25692,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. ApiResponse of VouchersTransactionsExportCreateResponseBody @@ -25698,7 +25702,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersTransactionsExportCreateResponseBody @@ -25709,7 +25713,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersTransactionsExportCreateResponseBody) @@ -25719,7 +25723,7 @@ Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. VouchersCreateResponseBody @@ -25728,7 +25732,7 @@ Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. ApiResponse of VouchersCreateResponseBody @@ -25737,7 +25741,7 @@ Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersCreateResponseBody @@ -25747,7 +25751,7 @@ Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersCreateResponseBody) @@ -25792,7 +25796,7 @@ - Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25801,7 +25805,7 @@ - Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25810,7 +25814,7 @@ - Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25820,7 +25824,7 @@ - Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25830,7 +25834,7 @@ - Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25840,7 +25844,7 @@ - Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25850,7 +25854,7 @@ - Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25861,7 +25865,7 @@ - Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25920,7 +25924,7 @@ Cancellation Token to cancel the request. Task of ApiResponse (VouchersTransactionsListResponseBody) - + List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers. @@ -25936,10 +25940,11 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. VouchersListResponseBody - + List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers. @@ -25955,10 +25960,11 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. ApiResponse of VouchersListResponseBody - + List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers. @@ -25974,11 +25980,12 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersListResponseBody - + List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers. @@ -25994,6 +26001,7 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersListResponseBody) @@ -41779,7 +41787,7 @@ - Response body schema for **POST** `v1/validations`. + Request body schema for **POST** `v1/validations`. @@ -87447,7 +87455,7 @@ The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.. Unique voucher ID.. Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.. Reason why the transaction occurred. In case of a redemption, this value is null.. The related transaction ID on the receiving card.. Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.. @@ -87504,9 +87512,9 @@ - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. @@ -89845,7 +89853,7 @@ Unique identifier of the parent loyalty card.. Unique identifier of the parent campaign.. bucket. - Loyalty point point bucket status.. + Loyalty point bucket status.. Date when the number of points defined in the bucket object are due to expire.. Timestamp representing the date and time when the loyalty point bucket object was created in ISO 8601 format.. Timestamp representing the date and time when the loyalty point bucket object was updated in ISO 8601 format.. @@ -89900,9 +89908,9 @@ - Loyalty point point bucket status. + Loyalty point bucket status. - Loyalty point point bucket status. + Loyalty point bucket status. @@ -114392,7 +114400,7 @@ The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.. Unique voucher ID.. Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.. Reason why the transaction occurred. In case of a redemption, this value is null.. The related transaction ID on the receiving card.. Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.. @@ -114449,9 +114457,9 @@ - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. @@ -120335,7 +120343,7 @@ false (boolean) - + Initializes a new instance of the class. @@ -120347,7 +120355,6 @@ Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).. Array of items applied to the order. It can include up to 500 items.. A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.. - Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.. Unique referrer ID.. customer. referrer. @@ -120436,18 +120443,6 @@ false (boolean) - - - Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. - - Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. - - - - Returns false as CreatedAt should not be serialized given that it's read-only. - - false (boolean) - Unique referrer ID. @@ -128857,20 +128852,23 @@ - Show that the product collection is static (manually selected products). + Defines Type - Show that the product collection is static (manually selected products). Enum STATIC for value: STATIC + + + Enum AUTOUPDATE for value: AUTO_UPDATE + + - Show that the product collection is static (manually selected products). + Gets or Sets Type - Show that the product collection is static (manually selected products). @@ -128882,7 +128880,7 @@ Initializes a new instance of the class. - Show that the product collection is static (manually selected products).. + type. Unique user-defined product collection name.. Defines a set of products for a `STATIC` product collection type.. Defines a set of criteria and boundary conditions for an `AUTO_UPDATE` product collection type.. @@ -161735,7 +161733,7 @@ false (boolean) - + Initializes a new instance of the class. @@ -164283,7 +164281,7 @@ Initializes a new instance of the class. id. - The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.. + The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.. @@ -164298,9 +164296,9 @@ - The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. + The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. - The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. + The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. @@ -165820,32 +165818,6 @@ false (boolean) - - - Defines InitialSyncStatus - - - - - Enum INPROGRESS for value: IN_PROGRESS - - - - - Enum DONE for value: DONE - - - - - Gets or Sets InitialSyncStatus - - - - - Returns false as InitialSyncStatus should not be serialized given that it's read-only. - - false (boolean) - The type of the object represented by JSON. This object stores information about the customer segment. @@ -165869,7 +165841,7 @@ false (boolean) - + Initializes a new instance of the class. @@ -165878,7 +165850,6 @@ Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format.. Defines whether the segment is: - Active (`auto-update`): customers enter and leave the segment based on the defined filters and the `customer.segment.entered` and `customer.segment.left` events are triggered, - Passive (`passive`): customers enter and leave the segment based on the defined filters, but the `customer.segment.entered` and `customer.segment.left` events are not triggered, - Static (`static`): manually selected customers.. Defines a set of criteria for an `auto-update` or `passive` segment type.. - initialSyncStatus. The type of the object represented by JSON. This object stores information about the customer segment.. @@ -165986,32 +165957,6 @@ false (boolean) - - - Defines InitialSyncStatus - - - - - Enum INPROGRESS for value: IN_PROGRESS - - - - - Enum DONE for value: DONE - - - - - Gets or Sets InitialSyncStatus - - - - - Returns false as InitialSyncStatus should not be serialized given that it's read-only. - - false (boolean) - The type of the object represented by JSON. This object stores information about the customer segment. @@ -166035,7 +165980,7 @@ false (boolean) - + Initializes a new instance of the class. @@ -166044,7 +165989,6 @@ Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format.. Defines whether the segment is: - Active (`auto-update`): customers enter and leave the segment based on the defined filters and the `customer.segment.entered` and `customer.segment.left` events are triggered, - Passive (`passive`): customers enter and leave the segment based on the defined filters, but the `customer.segment.entered` and `customer.segment.left` events are not triggered, - Static (`static`): manually selected customers.. Defines a set of criteria for an `auto-update` or `passive` segment type.. - initialSyncStatus. The type of the object represented by JSON. This object stores information about the customer segment.. @@ -177361,7 +177305,7 @@ - Response body schema for **POST** `v1/validations`. + Request body schema for **POST** `v1/validations`. @@ -179910,13 +179854,13 @@ Initializes a new instance of the class. - Defines the reccuring period(s) when the resource is active. The periods should not overlap.. + Defines the recurring period(s) when the resource is active. The periods should not overlap.. - Defines the reccuring period(s) when the resource is active. The periods should not overlap. + Defines the recurring period(s) when the resource is active. The periods should not overlap. - Defines the reccuring period(s) when the resource is active. The periods should not overlap. + Defines the recurring period(s) when the resource is active. The periods should not overlap. @@ -179945,7 +179889,7 @@ - Defines the reccuring period(s) when the resource will be active. + Defines the recurring period(s) when the resource will be active. @@ -188068,7 +188012,7 @@ The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.. Unique voucher ID.. Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.. Reason why the transaction occurred. In case of a redemption, this value is null.. The related transaction ID on the receiving card.. Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.. @@ -188125,9 +188069,9 @@ - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. diff --git a/lib/netstandard2.1/Voucherify.deps.json b/lib/netstandard2.1/Voucherify.deps.json index e46dedb8..1e39839c 100644 --- a/lib/netstandard2.1/Voucherify.deps.json +++ b/lib/netstandard2.1/Voucherify.deps.json @@ -7,7 +7,7 @@ "targets": { ".NETStandard,Version=v2.1": {}, ".NETStandard,Version=v2.1/": { - "Voucherify/8.1.0": { + "Voucherify/9.0.0": { "dependencies": { "JsonSubTypes": "2.0.1", "Newtonsoft.Json": "13.0.3", @@ -169,7 +169,7 @@ } }, "libraries": { - "Voucherify/8.1.0": { + "Voucherify/9.0.0": { "type": "project", "serviceable": false, "sha512": "" diff --git a/lib/netstandard2.1/Voucherify.dll b/lib/netstandard2.1/Voucherify.dll index c282a649..e7b835d3 100644 Binary files a/lib/netstandard2.1/Voucherify.dll and b/lib/netstandard2.1/Voucherify.dll differ diff --git a/lib/netstandard2.1/Voucherify.xml b/lib/netstandard2.1/Voucherify.xml index c39e3474..872b8003 100644 --- a/lib/netstandard2.1/Voucherify.xml +++ b/lib/netstandard2.1/Voucherify.xml @@ -555,7 +555,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. CampaignsVouchersCreateResponseBody @@ -569,11 +569,11 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. ApiResponse of CampaignsVouchersCreateResponseBody - + Add Vouchers to Campaign @@ -582,12 +582,12 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign @@ -596,8 +596,8 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. ApiResponse of CampaignsVouchersCreateCombinedResponseBody @@ -609,7 +609,7 @@ Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. CampaignsCreateResponseBody @@ -621,7 +621,7 @@ Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. ApiResponse of CampaignsCreateResponseBody @@ -708,7 +708,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. CampaignsTransactionsExportCreateResponseBody @@ -721,7 +721,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. ApiResponse of CampaignsTransactionsExportCreateResponseBody @@ -786,7 +786,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. CampaignsImportCreateResponseBody @@ -799,7 +799,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. ApiResponse of CampaignsImportCreateResponseBody @@ -910,7 +910,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. CampaignsUpdateResponseBody @@ -923,7 +923,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. ApiResponse of CampaignsUpdateResponseBody @@ -942,7 +942,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsVouchersCreateResponseBody @@ -957,12 +957,12 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsVouchersCreateResponseBody) - + Add Vouchers to Campaign @@ -971,13 +971,13 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign @@ -986,8 +986,8 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsVouchersCreateCombinedResponseBody) @@ -1000,7 +1000,7 @@ Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsCreateResponseBody @@ -1013,7 +1013,7 @@ Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsCreateResponseBody) @@ -1107,7 +1107,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsTransactionsExportCreateResponseBody @@ -1121,7 +1121,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) @@ -1191,7 +1191,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsImportCreateResponseBody @@ -1205,7 +1205,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsImportCreateResponseBody) @@ -1323,7 +1323,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsUpdateResponseBody @@ -1337,7 +1337,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsUpdateResponseBody) @@ -1415,7 +1415,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. CampaignsVouchersCreateResponseBody @@ -1426,7 +1426,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. ApiResponse of CampaignsVouchersCreateResponseBody @@ -1437,7 +1437,7 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsVouchersCreateResponseBody @@ -1449,53 +1449,53 @@ Thrown when fails to make API call The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. A custom **code** that identifies the voucher. - Specify the voucher parameters that you would like to overwrite. (optional) + Specify the voucher parameters that you would like to overwrite. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsVouchersCreateResponseBody) - + Add Vouchers to Campaign This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. ApiResponse of CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsVouchersCreateCombinedResponseBody - + Add Vouchers to Campaign This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). Thrown when fails to make API call The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + Specify the voucher parameters that you would like to overwrite. Number of vouchers that should be added. (optional) - Specify the voucher parameters that you would like to overwrite. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsVouchersCreateCombinedResponseBody) @@ -1505,7 +1505,7 @@ Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. CampaignsCreateResponseBody @@ -1514,7 +1514,7 @@ Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. ApiResponse of CampaignsCreateResponseBody @@ -1523,7 +1523,7 @@ Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsCreateResponseBody @@ -1533,7 +1533,7 @@ Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the campaign that you would like to create. (optional) + Specify the details of the campaign that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsCreateResponseBody) @@ -1662,7 +1662,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. CampaignsTransactionsExportCreateResponseBody @@ -1672,7 +1672,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. ApiResponse of CampaignsTransactionsExportCreateResponseBody @@ -1682,7 +1682,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsTransactionsExportCreateResponseBody @@ -1693,7 +1693,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) @@ -1788,7 +1788,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. CampaignsImportCreateResponseBody @@ -1798,7 +1798,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. ApiResponse of CampaignsImportCreateResponseBody @@ -1808,7 +1808,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsImportCreateResponseBody @@ -1819,7 +1819,7 @@ Thrown when fails to make API call The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsImportCreateResponseBody) @@ -1996,7 +1996,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. CampaignsUpdateResponseBody @@ -2006,7 +2006,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. ApiResponse of CampaignsUpdateResponseBody @@ -2016,7 +2016,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsUpdateResponseBody @@ -2027,7 +2027,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the campaign parameters to be updated. (optional) + Specify the campaign parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsUpdateResponseBody) @@ -2045,7 +2045,7 @@ Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. CategoriesCreateResponseBody @@ -2057,7 +2057,7 @@ Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. ApiResponse of CategoriesCreateResponseBody @@ -2140,7 +2140,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. CategoriesUpdateResponseBody @@ -2153,7 +2153,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. ApiResponse of CategoriesUpdateResponseBody @@ -2170,7 +2170,7 @@ Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of CategoriesCreateResponseBody @@ -2183,7 +2183,7 @@ Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CategoriesCreateResponseBody) @@ -2273,7 +2273,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of CategoriesUpdateResponseBody @@ -2287,7 +2287,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CategoriesUpdateResponseBody) @@ -2363,7 +2363,7 @@ Create Category Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. CategoriesCreateResponseBody @@ -2372,7 +2372,7 @@ Create Category Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. ApiResponse of CategoriesCreateResponseBody @@ -2381,7 +2381,7 @@ Create Category Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of CategoriesCreateResponseBody @@ -2391,7 +2391,7 @@ Create Category Create category with a specific name and hierarchy. Thrown when fails to make API call - Specify the details of the category that you would like to create. (optional) + Specify the details of the category that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CategoriesCreateResponseBody) @@ -2512,7 +2512,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. CategoriesUpdateResponseBody @@ -2522,7 +2522,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. ApiResponse of CategoriesUpdateResponseBody @@ -2532,7 +2532,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of CategoriesUpdateResponseBody @@ -2543,7 +2543,7 @@ Thrown when fails to make API call Unique category ID assigned by Voucherify. - Specify the details of the category that you would like to update. (optional) + Specify the details of the category that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CategoriesUpdateResponseBody) @@ -2561,7 +2561,7 @@ Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ClientQualificationsCheckEligibilityResponseBody @@ -2573,7 +2573,7 @@ Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ApiResponse of ClientQualificationsCheckEligibilityResponseBody @@ -2618,7 +2618,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ClientRedemptionsRedeemResponseBody @@ -2631,7 +2631,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ApiResponse of ClientRedemptionsRedeemResponseBody @@ -2644,7 +2644,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ClientEventsCreateResponseBody @@ -2657,7 +2657,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ApiResponse of ClientEventsCreateResponseBody @@ -2670,7 +2670,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ClientValidationsValidateResponseBody @@ -2683,7 +2683,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ApiResponse of ClientValidationsValidateResponseBody @@ -2700,7 +2700,7 @@ Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ClientQualificationsCheckEligibilityResponseBody @@ -2713,7 +2713,7 @@ Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientQualificationsCheckEligibilityResponseBody) @@ -2761,7 +2761,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ClientRedemptionsRedeemResponseBody @@ -2775,7 +2775,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientRedemptionsRedeemResponseBody) @@ -2789,7 +2789,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ClientEventsCreateResponseBody @@ -2803,7 +2803,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientEventsCreateResponseBody) @@ -2817,7 +2817,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ClientValidationsValidateResponseBody @@ -2831,7 +2831,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientValidationsValidateResponseBody) @@ -2907,7 +2907,7 @@ Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ClientQualificationsCheckEligibilityResponseBody @@ -2916,7 +2916,7 @@ Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ApiResponse of ClientQualificationsCheckEligibilityResponseBody @@ -2925,7 +2925,7 @@ Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ClientQualificationsCheckEligibilityResponseBody @@ -2935,7 +2935,7 @@ Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientQualificationsCheckEligibilityResponseBody) @@ -3000,7 +3000,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ClientRedemptionsRedeemResponseBody @@ -3010,7 +3010,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ApiResponse of ClientRedemptionsRedeemResponseBody @@ -3020,7 +3020,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ClientRedemptionsRedeemResponseBody @@ -3031,7 +3031,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientRedemptionsRedeemResponseBody) @@ -3042,7 +3042,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ClientEventsCreateResponseBody @@ -3052,7 +3052,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ApiResponse of ClientEventsCreateResponseBody @@ -3062,7 +3062,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ClientEventsCreateResponseBody @@ -3073,7 +3073,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientEventsCreateResponseBody) @@ -3084,7 +3084,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ClientValidationsValidateResponseBody @@ -3094,7 +3094,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. ApiResponse of ClientValidationsValidateResponseBody @@ -3104,7 +3104,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ClientValidationsValidateResponseBody @@ -3115,7 +3115,7 @@ Thrown when fails to make API call Indicates the origin (scheme, hostname, and port). - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ClientValidationsValidateResponseBody) @@ -3133,7 +3133,7 @@ Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. CustomersCreateResponseBody @@ -3145,7 +3145,7 @@ Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. ApiResponse of CustomersCreateResponseBody @@ -3398,7 +3398,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. CustomersUpdateResponseBody @@ -3411,7 +3411,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of CustomersUpdateResponseBody @@ -3423,7 +3423,7 @@ Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. CustomersUpdateInBulkResponseBody @@ -3435,7 +3435,7 @@ Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. ApiResponse of CustomersUpdateInBulkResponseBody @@ -3447,7 +3447,7 @@ Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. CustomersMetadataUpdateInBulkResponseBody @@ -3459,7 +3459,7 @@ Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. ApiResponse of CustomersMetadataUpdateInBulkResponseBody @@ -3476,7 +3476,7 @@ Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersCreateResponseBody @@ -3489,7 +3489,7 @@ Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersCreateResponseBody) @@ -3759,7 +3759,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersUpdateResponseBody @@ -3773,7 +3773,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersUpdateResponseBody) @@ -3786,7 +3786,7 @@ Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersUpdateInBulkResponseBody @@ -3799,7 +3799,7 @@ Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersUpdateInBulkResponseBody) @@ -3812,7 +3812,7 @@ Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersMetadataUpdateInBulkResponseBody @@ -3825,7 +3825,7 @@ Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersMetadataUpdateInBulkResponseBody) @@ -3901,7 +3901,7 @@ Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. CustomersCreateResponseBody @@ -3910,7 +3910,7 @@ Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. ApiResponse of CustomersCreateResponseBody @@ -3919,7 +3919,7 @@ Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersCreateResponseBody @@ -3929,7 +3929,7 @@ Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. Thrown when fails to make API call - Create a customer with specified parameters. (optional) + Create a customer with specified parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersCreateResponseBody) @@ -4340,7 +4340,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. CustomersUpdateResponseBody @@ -4350,7 +4350,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of CustomersUpdateResponseBody @@ -4360,7 +4360,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersUpdateResponseBody @@ -4371,7 +4371,7 @@ Thrown when fails to make API call A Voucherify customers id or source_id. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersUpdateResponseBody) @@ -4381,7 +4381,7 @@ Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. CustomersUpdateInBulkResponseBody @@ -4390,7 +4390,7 @@ Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. ApiResponse of CustomersUpdateInBulkResponseBody @@ -4399,7 +4399,7 @@ Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersUpdateInBulkResponseBody @@ -4409,7 +4409,7 @@ Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the customer fields to be updated in each customer object. (optional) + List the customer fields to be updated in each customer object. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersUpdateInBulkResponseBody) @@ -4419,7 +4419,7 @@ Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. CustomersMetadataUpdateInBulkResponseBody @@ -4428,7 +4428,7 @@ Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. ApiResponse of CustomersMetadataUpdateInBulkResponseBody @@ -4437,7 +4437,7 @@ Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of CustomersMetadataUpdateInBulkResponseBody @@ -4447,7 +4447,7 @@ Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the customers you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CustomersMetadataUpdateInBulkResponseBody) @@ -4465,7 +4465,7 @@ To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. EventsCreateResponseBody @@ -4477,7 +4477,7 @@ To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ApiResponse of EventsCreateResponseBody @@ -4494,7 +4494,7 @@ To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of EventsCreateResponseBody @@ -4507,7 +4507,7 @@ To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (EventsCreateResponseBody) @@ -4583,7 +4583,7 @@ Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. EventsCreateResponseBody @@ -4592,7 +4592,7 @@ Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. ApiResponse of EventsCreateResponseBody @@ -4601,7 +4601,7 @@ Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of EventsCreateResponseBody @@ -4611,7 +4611,7 @@ Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. Thrown when fails to make API call - Specify the details of the custom event. (optional) + Specify the details of the custom event. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (EventsCreateResponseBody) @@ -4629,7 +4629,7 @@ Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. ExportsCreateResponseBody @@ -4641,7 +4641,7 @@ Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. ApiResponse of ExportsCreateResponseBody @@ -4760,7 +4760,7 @@ Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ExportsCreateResponseBody @@ -4773,7 +4773,7 @@ Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ExportsCreateResponseBody) @@ -4959,7 +4959,7 @@ Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. ExportsCreateResponseBody @@ -4968,7 +4968,7 @@ Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. ApiResponse of ExportsCreateResponseBody @@ -4977,7 +4977,7 @@ Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ExportsCreateResponseBody @@ -4987,7 +4987,7 @@ Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions Thrown when fails to make API call - Specify the details of the export that you would like to create. (optional) + Specify the details of the export that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ExportsCreateResponseBody) @@ -5472,7 +5472,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. LoyaltiesMembersCreateResponseBody @@ -5485,7 +5485,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. ApiResponse of LoyaltiesMembersCreateResponseBody @@ -5499,7 +5499,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. LoyaltiesMembersPendingPointsBalanceResponseBody @@ -5513,7 +5513,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. ApiResponse of LoyaltiesMembersPendingPointsBalanceResponseBody @@ -5552,7 +5552,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. List<LoyaltiesEarningRulesCreateResponseBody> @@ -5565,7 +5565,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. ApiResponse of List<LoyaltiesEarningRulesCreateResponseBody> @@ -5578,7 +5578,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. List<LoyaltyTier> @@ -5591,7 +5591,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. ApiResponse of List<LoyaltyTier> @@ -5603,7 +5603,7 @@ Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. LoyaltiesCreateCampaignResponseBody @@ -5615,7 +5615,7 @@ Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. ApiResponse of LoyaltiesCreateCampaignResponseBody @@ -5628,7 +5628,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. LoyaltiesPointsExpirationExportCreateResponseBody @@ -5641,7 +5641,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. ApiResponse of LoyaltiesPointsExpirationExportCreateResponseBody @@ -5654,7 +5654,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. LoyaltiesRewardsCreateAssignmentResponseBody @@ -5667,7 +5667,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. ApiResponse of LoyaltiesRewardsCreateAssignmentResponseBody @@ -5810,7 +5810,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. CampaignsTransactionsExportCreateResponseBody @@ -5823,7 +5823,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. ApiResponse of CampaignsTransactionsExportCreateResponseBody @@ -5836,7 +5836,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. LoyaltiesMembersTransactionsExportCreateResponseBody @@ -5849,7 +5849,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -5863,7 +5863,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. LoyaltiesMembersTransactionsExportCreateResponseBody @@ -5877,7 +5877,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -6670,7 +6670,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. LoyaltiesMembersRedemptionRedeemResponseBody @@ -6683,7 +6683,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody @@ -6697,7 +6697,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. LoyaltiesMembersRedemptionRedeemResponseBody @@ -6711,7 +6711,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody @@ -6725,7 +6725,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. LoyaltiesMembersTransfersCreateResponseBody @@ -6739,7 +6739,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. ApiResponse of LoyaltiesMembersTransfersCreateResponseBody @@ -6753,7 +6753,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. LoyaltiesEarningRulesUpdateResponseBody @@ -6767,7 +6767,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. ApiResponse of LoyaltiesEarningRulesUpdateResponseBody @@ -6780,7 +6780,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. LoyaltiesMembersBalanceUpdateResponseBody @@ -6793,7 +6793,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody @@ -6807,7 +6807,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. LoyaltiesMembersBalanceUpdateResponseBody @@ -6821,7 +6821,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody @@ -6834,7 +6834,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. LoyaltiesUpdateCampaignResponseBody @@ -6847,7 +6847,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. ApiResponse of LoyaltiesUpdateCampaignResponseBody @@ -6861,7 +6861,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. LoyaltiesRewardsUpdateAssignmentResponseBody @@ -6875,7 +6875,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. ApiResponse of LoyaltiesRewardsUpdateAssignmentResponseBody @@ -6921,7 +6921,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersCreateResponseBody @@ -6935,7 +6935,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersCreateResponseBody) @@ -6950,7 +6950,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersPendingPointsBalanceResponseBody @@ -6965,7 +6965,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersPendingPointsBalanceResponseBody) @@ -7007,7 +7007,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. Cancellation Token to cancel the request. Task of List<LoyaltiesEarningRulesCreateResponseBody> @@ -7021,7 +7021,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (List<LoyaltiesEarningRulesCreateResponseBody>) @@ -7035,7 +7035,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of List<LoyaltyTier> @@ -7049,7 +7049,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (List<LoyaltyTier>) @@ -7062,7 +7062,7 @@ Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesCreateCampaignResponseBody @@ -7075,7 +7075,7 @@ Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesCreateCampaignResponseBody) @@ -7089,7 +7089,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesPointsExpirationExportCreateResponseBody @@ -7103,7 +7103,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesPointsExpirationExportCreateResponseBody) @@ -7117,7 +7117,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesRewardsCreateAssignmentResponseBody @@ -7131,7 +7131,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesRewardsCreateAssignmentResponseBody) @@ -7285,7 +7285,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsTransactionsExportCreateResponseBody @@ -7299,7 +7299,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) @@ -7313,7 +7313,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -7327,7 +7327,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) @@ -7342,7 +7342,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -7357,7 +7357,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) @@ -8205,7 +8205,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersRedemptionRedeemResponseBody @@ -8219,7 +8219,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) @@ -8234,7 +8234,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersRedemptionRedeemResponseBody @@ -8249,7 +8249,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) @@ -8264,7 +8264,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransfersCreateResponseBody @@ -8279,7 +8279,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransfersCreateResponseBody) @@ -8294,7 +8294,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesEarningRulesUpdateResponseBody @@ -8309,7 +8309,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesEarningRulesUpdateResponseBody) @@ -8323,7 +8323,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersBalanceUpdateResponseBody @@ -8337,7 +8337,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) @@ -8352,7 +8352,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersBalanceUpdateResponseBody @@ -8367,7 +8367,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) @@ -8381,7 +8381,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesUpdateCampaignResponseBody @@ -8395,7 +8395,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesUpdateCampaignResponseBody) @@ -8410,7 +8410,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesRewardsUpdateAssignmentResponseBody @@ -8425,7 +8425,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesRewardsUpdateAssignmentResponseBody) @@ -8544,7 +8544,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. LoyaltiesMembersCreateResponseBody @@ -8554,7 +8554,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. ApiResponse of LoyaltiesMembersCreateResponseBody @@ -8564,7 +8564,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersCreateResponseBody @@ -8575,7 +8575,7 @@ Thrown when fails to make API call Unique campaign ID of the loyalty program. - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersCreateResponseBody) @@ -8587,7 +8587,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. LoyaltiesMembersPendingPointsBalanceResponseBody @@ -8598,7 +8598,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. ApiResponse of LoyaltiesMembersPendingPointsBalanceResponseBody @@ -8609,7 +8609,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersPendingPointsBalanceResponseBody @@ -8621,7 +8621,7 @@ Thrown when fails to make API call Unique loyalty card code assigned to a particular customer. Unique pending point identifier, assigned by Voucherify. - Define the number of pending points to be added or subtracted. (optional) + Define the number of pending points to be added or subtracted. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersPendingPointsBalanceResponseBody) @@ -8674,7 +8674,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. List<LoyaltiesEarningRulesCreateResponseBody> @@ -8684,7 +8684,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. ApiResponse of List<LoyaltiesEarningRulesCreateResponseBody> @@ -8694,7 +8694,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. Cancellation Token to cancel the request. Task of List<LoyaltiesEarningRulesCreateResponseBody> @@ -8705,7 +8705,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (List<LoyaltiesEarningRulesCreateResponseBody>) @@ -8716,7 +8716,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. List<LoyaltyTier> @@ -8726,7 +8726,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. ApiResponse of List<LoyaltyTier> @@ -8736,7 +8736,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of List<LoyaltyTier> @@ -8747,7 +8747,7 @@ Thrown when fails to make API call Unique loyalty campaign ID or name. - Provide tier definitions you want to add to existing loyalty campaign. (optional) + Provide tier definitions you want to add to existing loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (List<LoyaltyTier>) @@ -8757,7 +8757,7 @@ Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. LoyaltiesCreateCampaignResponseBody @@ -8766,7 +8766,7 @@ Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. ApiResponse of LoyaltiesCreateCampaignResponseBody @@ -8775,7 +8775,7 @@ Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesCreateCampaignResponseBody @@ -8785,7 +8785,7 @@ Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. Thrown when fails to make API call - Specify the loyalty campaign details. (optional) + Specify the loyalty campaign details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesCreateCampaignResponseBody) @@ -8796,7 +8796,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. LoyaltiesPointsExpirationExportCreateResponseBody @@ -8806,7 +8806,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. ApiResponse of LoyaltiesPointsExpirationExportCreateResponseBody @@ -8816,7 +8816,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesPointsExpirationExportCreateResponseBody @@ -8827,7 +8827,7 @@ Thrown when fails to make API call Unique campaign ID or name. - Specify the data filters, types of data to return and order in which the results should be returned. (optional) + Specify the data filters, types of data to return and order in which the results should be returned. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesPointsExpirationExportCreateResponseBody) @@ -8838,7 +8838,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. LoyaltiesRewardsCreateAssignmentResponseBody @@ -8848,7 +8848,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. ApiResponse of LoyaltiesRewardsCreateAssignmentResponseBody @@ -8858,7 +8858,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesRewardsCreateAssignmentResponseBody @@ -8869,7 +8869,7 @@ Thrown when fails to make API call Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Define the cost of the rewards in loyalty points. (optional) + Define the cost of the rewards in loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesRewardsCreateAssignmentResponseBody) @@ -9090,7 +9090,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. CampaignsTransactionsExportCreateResponseBody @@ -9100,7 +9100,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. ApiResponse of CampaignsTransactionsExportCreateResponseBody @@ -9110,7 +9110,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of CampaignsTransactionsExportCreateResponseBody @@ -9121,7 +9121,7 @@ Thrown when fails to make API call You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - Specify the parameters for the transaction export. (optional) + Specify the parameters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) @@ -9132,7 +9132,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9142,7 +9142,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9152,7 +9152,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9163,7 +9163,7 @@ Thrown when fails to make API call A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) @@ -9175,7 +9175,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9186,7 +9186,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9197,7 +9197,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransactionsExportCreateResponseBody @@ -9209,7 +9209,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. A unique code identifying the loyalty card that you are looking to export transaction data for. - Specify the parameters and filters for the transaction export. (optional) + Specify the parameters and filters for the transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) @@ -10510,7 +10510,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. LoyaltiesMembersRedemptionRedeemResponseBody @@ -10520,7 +10520,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody @@ -10530,7 +10530,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersRedemptionRedeemResponseBody @@ -10541,7 +10541,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) @@ -10553,7 +10553,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. LoyaltiesMembersRedemptionRedeemResponseBody @@ -10564,7 +10564,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody @@ -10575,7 +10575,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersRedemptionRedeemResponseBody @@ -10587,7 +10587,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) @@ -10599,7 +10599,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. LoyaltiesMembersTransfersCreateResponseBody @@ -10610,7 +10610,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. ApiResponse of LoyaltiesMembersTransfersCreateResponseBody @@ -10621,7 +10621,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersTransfersCreateResponseBody @@ -10633,7 +10633,7 @@ Thrown when fails to make API call A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersTransfersCreateResponseBody) @@ -10645,7 +10645,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. LoyaltiesEarningRulesUpdateResponseBody @@ -10656,7 +10656,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. ApiResponse of LoyaltiesEarningRulesUpdateResponseBody @@ -10667,7 +10667,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesEarningRulesUpdateResponseBody @@ -10679,7 +10679,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique earning rule ID. - Specify the parameters that you would like to update for the given earning rule. (optional) + Specify the parameters that you would like to update for the given earning rule. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesEarningRulesUpdateResponseBody) @@ -10690,7 +10690,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. LoyaltiesMembersBalanceUpdateResponseBody @@ -10700,7 +10700,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody @@ -10710,7 +10710,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersBalanceUpdateResponseBody @@ -10721,7 +10721,7 @@ Thrown when fails to make API call Unique loyalty card assigned to a particular customer. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) @@ -10733,7 +10733,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. LoyaltiesMembersBalanceUpdateResponseBody @@ -10744,7 +10744,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody @@ -10755,7 +10755,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesMembersBalanceUpdateResponseBody @@ -10767,7 +10767,7 @@ Thrown when fails to make API call Unique campaign ID. A code that identifies the loyalty card. - Specify the point adjustment along with the expiration mechanism. (optional) + Specify the point adjustment along with the expiration mechanism. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) @@ -10778,7 +10778,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. LoyaltiesUpdateCampaignResponseBody @@ -10788,7 +10788,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. ApiResponse of LoyaltiesUpdateCampaignResponseBody @@ -10798,7 +10798,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesUpdateCampaignResponseBody @@ -10809,7 +10809,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + Specify the new values for the parameters that you would like to update for the given loyalty campaign. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesUpdateCampaignResponseBody) @@ -10821,7 +10821,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. LoyaltiesRewardsUpdateAssignmentResponseBody @@ -10832,7 +10832,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. ApiResponse of LoyaltiesRewardsUpdateAssignmentResponseBody @@ -10843,7 +10843,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. Cancellation Token to cancel the request. Task of LoyaltiesRewardsUpdateAssignmentResponseBody @@ -10855,7 +10855,7 @@ Thrown when fails to make API call The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. A unique reward assignment ID. - Update the points cost for the reward assignment. (optional) + Update the points cost for the reward assignment. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (LoyaltiesRewardsUpdateAssignmentResponseBody) @@ -10874,7 +10874,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. ManagementProjectsUsersAssignResponseBody @@ -10887,7 +10887,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. ApiResponse of ManagementProjectsUsersAssignResponseBody @@ -10900,7 +10900,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. ManagementProjectsBrandingCreateResponseBody @@ -10913,7 +10913,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. ApiResponse of ManagementProjectsBrandingCreateResponseBody @@ -10926,7 +10926,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. ManagementProjectsCustomEventSchemasCreateResponseBody @@ -10939,7 +10939,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. ApiResponse of ManagementProjectsCustomEventSchemasCreateResponseBody @@ -10952,7 +10952,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. ManagementProjectsMetadataSchemasCreateResponseBody @@ -10965,7 +10965,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. ApiResponse of ManagementProjectsMetadataSchemasCreateResponseBody @@ -10977,7 +10977,7 @@ Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. ManagementProjectsCreateResponseBody @@ -10989,7 +10989,7 @@ Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. ApiResponse of ManagementProjectsCreateResponseBody @@ -11002,7 +11002,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. ManagementProjectsStackingRulesCreateResponseBody @@ -11015,7 +11015,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. ApiResponse of ManagementProjectsStackingRulesCreateResponseBody @@ -11028,7 +11028,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. ManagementProjectsWebhooksCreateResponseBody @@ -11041,7 +11041,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. ApiResponse of ManagementProjectsWebhooksCreateResponseBody @@ -11387,7 +11387,7 @@ Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. @@ -11399,7 +11399,7 @@ Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. ApiResponse of Object(void) @@ -11579,7 +11579,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -11593,7 +11593,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. ApiResponse of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -11667,7 +11667,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. ManagementProjectsBrandingUpdateResponseBody @@ -11681,7 +11681,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. ApiResponse of ManagementProjectsBrandingUpdateResponseBody @@ -11695,7 +11695,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -11709,7 +11709,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. ApiResponse of ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -11723,7 +11723,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. ManagementProjectsMetadataSchemasUpdateResponseBody @@ -11737,7 +11737,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. ApiResponse of ManagementProjectsMetadataSchemasUpdateResponseBody @@ -11750,7 +11750,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. ManagementProjectsUpdateResponseBody @@ -11763,7 +11763,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. ApiResponse of ManagementProjectsUpdateResponseBody @@ -11777,7 +11777,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. ManagementProjectsStackingRulesUpdateResponseBody @@ -11791,7 +11791,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. ApiResponse of ManagementProjectsStackingRulesUpdateResponseBody @@ -11805,7 +11805,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. ManagementProjectsUsersUpdateRoleResponseBody @@ -11819,7 +11819,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. ApiResponse of ManagementProjectsUsersUpdateRoleResponseBody @@ -11833,7 +11833,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. ManagementProjectsWebhooksUpdateResponseBody @@ -11847,7 +11847,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. ApiResponse of ManagementProjectsWebhooksUpdateResponseBody @@ -11865,7 +11865,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUsersAssignResponseBody @@ -11879,7 +11879,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUsersAssignResponseBody) @@ -11893,7 +11893,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsBrandingCreateResponseBody @@ -11907,7 +11907,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsBrandingCreateResponseBody) @@ -11921,7 +11921,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCustomEventSchemasCreateResponseBody @@ -11935,7 +11935,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCustomEventSchemasCreateResponseBody) @@ -11949,7 +11949,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsMetadataSchemasCreateResponseBody @@ -11963,7 +11963,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsMetadataSchemasCreateResponseBody) @@ -11976,7 +11976,7 @@ Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCreateResponseBody @@ -11989,7 +11989,7 @@ Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCreateResponseBody) @@ -12003,7 +12003,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsStackingRulesCreateResponseBody @@ -12017,7 +12017,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsStackingRulesCreateResponseBody) @@ -12031,7 +12031,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsWebhooksCreateResponseBody @@ -12045,7 +12045,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsWebhooksCreateResponseBody) @@ -12418,7 +12418,7 @@ Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. Cancellation Token to cancel the request. Task of void @@ -12431,7 +12431,7 @@ Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse @@ -12626,7 +12626,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -12641,7 +12641,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsTemplatesCampaignsCopyCreateResponseBody) @@ -12720,7 +12720,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsBrandingUpdateResponseBody @@ -12735,7 +12735,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsBrandingUpdateResponseBody) @@ -12750,7 +12750,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -12765,7 +12765,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCustomEventSchemasUpdateResponseBody) @@ -12780,7 +12780,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsMetadataSchemasUpdateResponseBody @@ -12795,7 +12795,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsMetadataSchemasUpdateResponseBody) @@ -12809,7 +12809,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUpdateResponseBody @@ -12823,7 +12823,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUpdateResponseBody) @@ -12838,7 +12838,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsStackingRulesUpdateResponseBody @@ -12853,7 +12853,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsStackingRulesUpdateResponseBody) @@ -12868,7 +12868,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUsersUpdateRoleResponseBody @@ -12883,7 +12883,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUsersUpdateRoleResponseBody) @@ -12898,7 +12898,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsWebhooksUpdateResponseBody @@ -12913,7 +12913,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsWebhooksUpdateResponseBody) @@ -12990,7 +12990,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. ManagementProjectsUsersAssignResponseBody @@ -13000,7 +13000,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. ApiResponse of ManagementProjectsUsersAssignResponseBody @@ -13010,7 +13010,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUsersAssignResponseBody @@ -13021,7 +13021,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the user details. (optional) + Defines the user details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUsersAssignResponseBody) @@ -13032,7 +13032,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. ManagementProjectsBrandingCreateResponseBody @@ -13042,7 +13042,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. ApiResponse of ManagementProjectsBrandingCreateResponseBody @@ -13052,7 +13052,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsBrandingCreateResponseBody @@ -13063,7 +13063,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a brand configuration. (optional) + Defines a brand configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsBrandingCreateResponseBody) @@ -13074,7 +13074,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. ManagementProjectsCustomEventSchemasCreateResponseBody @@ -13084,7 +13084,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. ApiResponse of ManagementProjectsCustomEventSchemasCreateResponseBody @@ -13094,7 +13094,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCustomEventSchemasCreateResponseBody @@ -13105,7 +13105,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the custom event schema. (optional) + Defines the custom event schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCustomEventSchemasCreateResponseBody) @@ -13116,7 +13116,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. ManagementProjectsMetadataSchemasCreateResponseBody @@ -13126,7 +13126,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. ApiResponse of ManagementProjectsMetadataSchemasCreateResponseBody @@ -13136,7 +13136,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsMetadataSchemasCreateResponseBody @@ -13147,7 +13147,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the metadata schema. (optional) + Defines the metadata schema. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsMetadataSchemasCreateResponseBody) @@ -13157,7 +13157,7 @@ Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. ManagementProjectsCreateResponseBody @@ -13166,7 +13166,7 @@ Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. ApiResponse of ManagementProjectsCreateResponseBody @@ -13175,7 +13175,7 @@ Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCreateResponseBody @@ -13185,7 +13185,7 @@ Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. Thrown when fails to make API call - Define project details. (optional) + Define project details. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCreateResponseBody) @@ -13196,7 +13196,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. ManagementProjectsStackingRulesCreateResponseBody @@ -13206,7 +13206,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. ApiResponse of ManagementProjectsStackingRulesCreateResponseBody @@ -13216,7 +13216,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsStackingRulesCreateResponseBody @@ -13227,7 +13227,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines the stacking rule parameters. (optional) + Defines the stacking rule parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsStackingRulesCreateResponseBody) @@ -13238,7 +13238,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. ManagementProjectsWebhooksCreateResponseBody @@ -13248,7 +13248,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. ApiResponse of ManagementProjectsWebhooksCreateResponseBody @@ -13258,7 +13258,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsWebhooksCreateResponseBody @@ -13269,7 +13269,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Defines a webhook configuration. (optional) + Defines a webhook configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsWebhooksCreateResponseBody) @@ -13817,7 +13817,7 @@ Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. @@ -13826,7 +13826,7 @@ Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. ApiResponse of Object(void) @@ -13835,7 +13835,7 @@ Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. Cancellation Token to cancel the request. Task of void @@ -13845,7 +13845,7 @@ Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. Thrown when fails to make API call - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + Defines the details of the invitation, the project, and roles to which the user will be assigned. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse @@ -14119,7 +14119,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -14130,7 +14130,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. ApiResponse of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -14141,7 +14141,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody @@ -14153,7 +14153,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the campaign template. - Determines the details about the template in the destination project as well as the destination project itself. (optional) + Determines the details about the template in the destination project as well as the destination project itself. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsTemplatesCampaignsCopyCreateResponseBody) @@ -14265,7 +14265,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. ManagementProjectsBrandingUpdateResponseBody @@ -14276,7 +14276,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. ApiResponse of ManagementProjectsBrandingUpdateResponseBody @@ -14287,7 +14287,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsBrandingUpdateResponseBody @@ -14299,7 +14299,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the brand configuration. - Defines the brand configuration to be updated. (optional) + Defines the brand configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsBrandingUpdateResponseBody) @@ -14311,7 +14311,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -14322,7 +14322,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. ApiResponse of ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -14333,7 +14333,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsCustomEventSchemasUpdateResponseBody @@ -14345,7 +14345,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the custom event schema. - Defines the custom event schema to be updated. (optional) + Defines the custom event schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsCustomEventSchemasUpdateResponseBody) @@ -14357,7 +14357,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. ManagementProjectsMetadataSchemasUpdateResponseBody @@ -14368,7 +14368,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. ApiResponse of ManagementProjectsMetadataSchemasUpdateResponseBody @@ -14379,7 +14379,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsMetadataSchemasUpdateResponseBody @@ -14391,7 +14391,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the metadata schema. - Defines the metadata schema to be updated. (optional) + Defines the metadata schema to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsMetadataSchemasUpdateResponseBody) @@ -14402,7 +14402,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. ManagementProjectsUpdateResponseBody @@ -14412,7 +14412,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. ApiResponse of ManagementProjectsUpdateResponseBody @@ -14422,7 +14422,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUpdateResponseBody @@ -14433,7 +14433,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. - Define the project details to be updated. (optional) + Define the project details to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUpdateResponseBody) @@ -14445,7 +14445,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. ManagementProjectsStackingRulesUpdateResponseBody @@ -14456,7 +14456,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. ApiResponse of ManagementProjectsStackingRulesUpdateResponseBody @@ -14467,7 +14467,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsStackingRulesUpdateResponseBody @@ -14479,7 +14479,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the stacking rules. - Defines the stacking rules to be updated. (optional) + Defines the stacking rules to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsStackingRulesUpdateResponseBody) @@ -14491,7 +14491,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. ManagementProjectsUsersUpdateRoleResponseBody @@ -14502,7 +14502,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. ApiResponse of ManagementProjectsUsersUpdateRoleResponseBody @@ -14513,7 +14513,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsUsersUpdateRoleResponseBody @@ -14525,7 +14525,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the user. Alternatively, provide the users login. - Defines the users new role. (optional) + Defines the users new role. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsUsersUpdateRoleResponseBody) @@ -14537,7 +14537,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. ManagementProjectsWebhooksUpdateResponseBody @@ -14548,7 +14548,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. ApiResponse of ManagementProjectsWebhooksUpdateResponseBody @@ -14559,7 +14559,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ManagementProjectsWebhooksUpdateResponseBody @@ -14571,7 +14571,7 @@ Thrown when fails to make API call Provide the unique identifier of the project. Provide the unique identifier of the webhook configuration. - Defines the webhook configuration to be updated. (optional) + Defines the webhook configuration to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ManagementProjectsWebhooksUpdateResponseBody) @@ -15181,7 +15181,7 @@ Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. OrdersCreateResponseBody @@ -15193,7 +15193,7 @@ Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. ApiResponse of OrdersCreateResponseBody @@ -15205,7 +15205,7 @@ Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. OrdersExportCreateResponseBody @@ -15217,7 +15217,7 @@ Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. ApiResponse of OrdersExportCreateResponseBody @@ -15250,10 +15250,10 @@ Import Orders - 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. OrdersImportCreateResponseBody @@ -15262,10 +15262,10 @@ Import Orders - 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. ApiResponse of OrdersImportCreateResponseBody @@ -15306,7 +15306,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. OrdersUpdateResponseBody @@ -15319,7 +15319,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. ApiResponse of OrdersUpdateResponseBody @@ -15336,7 +15336,7 @@ Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersCreateResponseBody @@ -15349,7 +15349,7 @@ Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersCreateResponseBody) @@ -15362,7 +15362,7 @@ Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersExportCreateResponseBody @@ -15375,7 +15375,7 @@ Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersExportCreateResponseBody) @@ -15411,10 +15411,10 @@ Import Orders - 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersImportCreateResponseBody @@ -15424,10 +15424,10 @@ Import Orders - 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersImportCreateResponseBody) @@ -15471,7 +15471,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersUpdateResponseBody @@ -15485,7 +15485,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersUpdateResponseBody) @@ -15561,7 +15561,7 @@ Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. OrdersCreateResponseBody @@ -15570,7 +15570,7 @@ Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. ApiResponse of OrdersCreateResponseBody @@ -15579,7 +15579,7 @@ Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersCreateResponseBody @@ -15589,7 +15589,7 @@ Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. Thrown when fails to make API call - Specify the order parameters. (optional) + Specify the order parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersCreateResponseBody) @@ -15599,7 +15599,7 @@ Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. OrdersExportCreateResponseBody @@ -15608,7 +15608,7 @@ Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. ApiResponse of OrdersExportCreateResponseBody @@ -15617,7 +15617,7 @@ Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersExportCreateResponseBody @@ -15627,7 +15627,7 @@ Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Thrown when fails to make API call - Specify which order parameters you would like to export. (optional) + Specify which order parameters you would like to export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersExportCreateResponseBody) @@ -15672,38 +15672,38 @@ - Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. OrdersImportCreateResponseBody - Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. ApiResponse of OrdersImportCreateResponseBody - Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersImportCreateResponseBody - Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. Thrown when fails to make API call - The request body is sent in the form of an array of order objects. (optional) + The request body is sent in the form of an array of order objects. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersImportCreateResponseBody) @@ -15760,7 +15760,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. OrdersUpdateResponseBody @@ -15770,7 +15770,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. ApiResponse of OrdersUpdateResponseBody @@ -15780,7 +15780,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of OrdersUpdateResponseBody @@ -15791,7 +15791,7 @@ Thrown when fails to make API call Unique Voucherify order ID or order source ID. - Specify the parameters of the order that are to be updated. (optional) + Specify the parameters of the order that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (OrdersUpdateResponseBody) @@ -15809,7 +15809,7 @@ This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. ProductCollectionsCreateResponseBody @@ -15821,7 +15821,7 @@ This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of ProductCollectionsCreateResponseBody @@ -15946,7 +15946,7 @@ This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ProductCollectionsCreateResponseBody @@ -15959,7 +15959,7 @@ This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductCollectionsCreateResponseBody) @@ -16151,7 +16151,7 @@ Create Product Collection This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. ProductCollectionsCreateResponseBody @@ -16160,7 +16160,7 @@ Create Product Collection This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of ProductCollectionsCreateResponseBody @@ -16169,7 +16169,7 @@ Create Product Collection This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ProductCollectionsCreateResponseBody @@ -16179,7 +16179,7 @@ Create Product Collection This method creates a new product collection. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductCollectionsCreateResponseBody) @@ -16373,7 +16373,7 @@ Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. ProductsCreateResponseBody @@ -16385,7 +16385,7 @@ Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. ApiResponse of ProductsCreateResponseBody @@ -16398,7 +16398,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. ProductsSkusCreateResponseBody @@ -16411,7 +16411,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. ApiResponse of ProductsSkusCreateResponseBody @@ -16640,7 +16640,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. ProductsUpdateResponseBody @@ -16653,7 +16653,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. ApiResponse of ProductsUpdateResponseBody @@ -16665,7 +16665,7 @@ Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. ProductsUpdateInBulkResponseBody @@ -16677,7 +16677,7 @@ Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. ApiResponse of ProductsUpdateInBulkResponseBody @@ -16689,7 +16689,7 @@ Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. ProductsMetadataUpdateInBulkResponseBody @@ -16701,7 +16701,7 @@ Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. ApiResponse of ProductsMetadataUpdateInBulkResponseBody @@ -16715,7 +16715,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ProductsSkusUpdateResponseBody @@ -16729,7 +16729,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of ProductsSkusUpdateResponseBody @@ -16746,7 +16746,7 @@ Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsCreateResponseBody @@ -16759,7 +16759,7 @@ Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsCreateResponseBody) @@ -16773,7 +16773,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsSkusCreateResponseBody @@ -16787,7 +16787,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsSkusCreateResponseBody) @@ -17033,7 +17033,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsUpdateResponseBody @@ -17047,7 +17047,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsUpdateResponseBody) @@ -17060,7 +17060,7 @@ Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsUpdateInBulkResponseBody @@ -17073,7 +17073,7 @@ Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsUpdateInBulkResponseBody) @@ -17086,7 +17086,7 @@ Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsMetadataUpdateInBulkResponseBody @@ -17099,7 +17099,7 @@ Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsMetadataUpdateInBulkResponseBody) @@ -17114,7 +17114,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsSkusUpdateResponseBody @@ -17129,7 +17129,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsSkusUpdateResponseBody) @@ -17205,7 +17205,7 @@ Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. ProductsCreateResponseBody @@ -17214,7 +17214,7 @@ Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. ApiResponse of ProductsCreateResponseBody @@ -17223,7 +17223,7 @@ Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsCreateResponseBody @@ -17233,7 +17233,7 @@ Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. Thrown when fails to make API call - Specify the product parameters. (optional) + Specify the product parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsCreateResponseBody) @@ -17244,7 +17244,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. ProductsSkusCreateResponseBody @@ -17254,7 +17254,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. ApiResponse of ProductsSkusCreateResponseBody @@ -17264,7 +17264,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsSkusCreateResponseBody @@ -17275,7 +17275,7 @@ Thrown when fails to make API call A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - Specify the SKU parameters to be created. (optional) + Specify the SKU parameters to be created. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsSkusCreateResponseBody) @@ -17638,7 +17638,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. ProductsUpdateResponseBody @@ -17648,7 +17648,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. ApiResponse of ProductsUpdateResponseBody @@ -17658,7 +17658,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsUpdateResponseBody @@ -17669,7 +17669,7 @@ Thrown when fails to make API call A Voucherify product ID or source ID. - Specify the parameters of the product that are to be updated. (optional) + Specify the parameters of the product that are to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsUpdateResponseBody) @@ -17679,7 +17679,7 @@ Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. ProductsUpdateInBulkResponseBody @@ -17688,7 +17688,7 @@ Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. ApiResponse of ProductsUpdateInBulkResponseBody @@ -17697,7 +17697,7 @@ Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsUpdateInBulkResponseBody @@ -17707,7 +17707,7 @@ Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the product fields to be updated in each product object. (optional) + List the product fields to be updated in each product object. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsUpdateInBulkResponseBody) @@ -17717,7 +17717,7 @@ Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. ProductsMetadataUpdateInBulkResponseBody @@ -17726,7 +17726,7 @@ Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. ApiResponse of ProductsMetadataUpdateInBulkResponseBody @@ -17735,7 +17735,7 @@ Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsMetadataUpdateInBulkResponseBody @@ -17745,7 +17745,7 @@ Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. Thrown when fails to make API call - List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + List the source_ids of the products you would like to update with the metadata key/value pairs. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsMetadataUpdateInBulkResponseBody) @@ -17757,7 +17757,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ProductsSkusUpdateResponseBody @@ -17768,7 +17768,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of ProductsSkusUpdateResponseBody @@ -17779,7 +17779,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ProductsSkusUpdateResponseBody @@ -17791,7 +17791,7 @@ Thrown when fails to make API call A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ProductsSkusUpdateResponseBody) @@ -17810,7 +17810,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. PromotionsTiersCreateResponseBody @@ -17823,7 +17823,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. ApiResponse of PromotionsTiersCreateResponseBody @@ -17836,7 +17836,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. PromotionsStacksCreateResponseBody @@ -17849,7 +17849,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. ApiResponse of PromotionsStacksCreateResponseBody @@ -18121,7 +18121,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. PromotionsStacksUpdateResponseBody @@ -18135,7 +18135,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. ApiResponse of PromotionsStacksUpdateResponseBody @@ -18148,7 +18148,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. PromotionsTiersUpdateResponseBody @@ -18161,7 +18161,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. ApiResponse of PromotionsTiersUpdateResponseBody @@ -18179,7 +18179,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsTiersCreateResponseBody @@ -18193,7 +18193,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsTiersCreateResponseBody) @@ -18207,7 +18207,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsStacksCreateResponseBody @@ -18221,7 +18221,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsStacksCreateResponseBody) @@ -18514,7 +18514,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsStacksUpdateResponseBody @@ -18529,7 +18529,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsStacksUpdateResponseBody) @@ -18543,7 +18543,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsTiersUpdateResponseBody @@ -18557,7 +18557,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsTiersUpdateResponseBody) @@ -18634,7 +18634,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. PromotionsTiersCreateResponseBody @@ -18644,7 +18644,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. ApiResponse of PromotionsTiersCreateResponseBody @@ -18654,7 +18654,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsTiersCreateResponseBody @@ -18665,7 +18665,7 @@ Thrown when fails to make API call Unique campaign ID assigned by Voucherify. - Specify the promotion tier parameters. (optional) + Specify the promotion tier parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsTiersCreateResponseBody) @@ -18676,7 +18676,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. PromotionsStacksCreateResponseBody @@ -18686,7 +18686,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. ApiResponse of PromotionsStacksCreateResponseBody @@ -18696,7 +18696,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsStacksCreateResponseBody @@ -18707,7 +18707,7 @@ Thrown when fails to make API call Unique campaign ID. - Specify the order of promotion tiers for the promotion stack. (optional) + Specify the order of promotion tiers for the promotion stack. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsStacksCreateResponseBody) @@ -19135,7 +19135,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. PromotionsStacksUpdateResponseBody @@ -19146,7 +19146,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. ApiResponse of PromotionsStacksUpdateResponseBody @@ -19157,7 +19157,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsStacksUpdateResponseBody @@ -19169,7 +19169,7 @@ Thrown when fails to make API call ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. Promotion stack ID. - Specify the promotion stack parameters that you would like to update. (optional) + Specify the promotion stack parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsStacksUpdateResponseBody) @@ -19180,7 +19180,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. PromotionsTiersUpdateResponseBody @@ -19190,7 +19190,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. ApiResponse of PromotionsTiersUpdateResponseBody @@ -19200,7 +19200,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of PromotionsTiersUpdateResponseBody @@ -19211,7 +19211,7 @@ Thrown when fails to make API call Unique promotion tier ID. - Specify the promotion tier parameters that you would like to update. (optional) + Specify the promotion tier parameters that you would like to update. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PromotionsTiersUpdateResponseBody) @@ -19221,7 +19221,7 @@ Represents a collection of functions to interact with the API endpoints - + Create Publication @@ -19229,12 +19229,12 @@ This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. PublicationsCreateResponseBody - + Create Publication @@ -19242,8 +19242,8 @@ This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. ApiResponse of PublicationsCreateResponseBody @@ -19330,7 +19330,7 @@ Represents a collection of functions to interact with the API endpoints - + Create Publication @@ -19338,13 +19338,13 @@ This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of PublicationsCreateResponseBody - + Create Publication @@ -19352,8 +19352,8 @@ This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PublicationsCreateResponseBody) @@ -19506,44 +19506,44 @@ Provides a factory method hook for the creation of exceptions. - + Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. PublicationsCreateResponseBody - + Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. ApiResponse of PublicationsCreateResponseBody - + Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of PublicationsCreateResponseBody - + Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. Thrown when fails to make API call + Specify the publication parameters. Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - Specify the publication parameters. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (PublicationsCreateResponseBody) @@ -19697,7 +19697,7 @@ 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. QualificationsCheckEligibilityResponseBody @@ -19709,7 +19709,7 @@ 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ApiResponse of QualificationsCheckEligibilityResponseBody @@ -19726,7 +19726,7 @@ 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of QualificationsCheckEligibilityResponseBody @@ -19739,7 +19739,7 @@ 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (QualificationsCheckEligibilityResponseBody) @@ -19815,7 +19815,7 @@ Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. QualificationsCheckEligibilityResponseBody @@ -19824,7 +19824,7 @@ Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. ApiResponse of QualificationsCheckEligibilityResponseBody @@ -19833,7 +19833,7 @@ Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of QualificationsCheckEligibilityResponseBody @@ -19843,7 +19843,7 @@ Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. Thrown when fails to make API call - Define order and customer context. (optional) + Define order and customer context. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (QualificationsCheckEligibilityResponseBody) @@ -19944,10 +19944,10 @@ Redeem Stackable Discounts - # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. RedemptionsRedeemResponseBody @@ -19956,14 +19956,14 @@ Redeem Stackable Discounts - # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of RedemptionsRedeemResponseBody - + Rollback Redemption @@ -19972,13 +19972,13 @@ Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. RedemptionsRollbackCreateResponseBody - + Rollback Redemption @@ -19987,13 +19987,13 @@ Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. ApiResponse of RedemptionsRollbackCreateResponseBody - + Rollback Stackable Redemptions @@ -20002,13 +20002,13 @@ Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions @@ -20017,9 +20017,9 @@ Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. ApiResponse of RedemptionsRollbacksCreateResponseBody @@ -20125,10 +20125,10 @@ Redeem Stackable Discounts - # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRedeemResponseBody @@ -20138,15 +20138,15 @@ Redeem Stackable Discounts - # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRedeemResponseBody) - + Rollback Redemption @@ -20155,14 +20155,14 @@ Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRollbackCreateResponseBody - + Rollback Redemption @@ -20171,14 +20171,14 @@ Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRollbackCreateResponseBody) - + Rollback Stackable Redemptions @@ -20187,14 +20187,14 @@ Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions @@ -20203,9 +20203,9 @@ Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRollbacksCreateResponseBody) @@ -20420,138 +20420,138 @@ - Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. RedemptionsRedeemResponseBody - Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of RedemptionsRedeemResponseBody - Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRedeemResponseBody - Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRedeemResponseBody) - + Rollback Redemption Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions) 🚧 You can roll back a redemption up to 3 months back. # Effect The operation - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and - gives 1 redemption back to the pool (decreases redeemed_quantity by 1). # Returned funds In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption. Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. RedemptionsRollbackCreateResponseBody - + Rollback Redemption Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions) 🚧 You can roll back a redemption up to 3 months back. # Effect The operation - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and - gives 1 redemption back to the pool (decreases redeemed_quantity by 1). # Returned funds In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption. Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. ApiResponse of RedemptionsRollbackCreateResponseBody - + Rollback Redemption Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions) 🚧 You can roll back a redemption up to 3 months back. # Effect The operation - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and - gives 1 redemption back to the pool (decreases redeemed_quantity by 1). # Returned funds In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption. Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRollbackCreateResponseBody - + Rollback Redemption Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions) 🚧 You can roll back a redemption up to 3 months back. # Effect The operation - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and - gives 1 redemption back to the pool (decreases redeemed_quantity by 1). # Returned funds In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption. Thrown when fails to make API call The original redemption ID to be rolled back (undone). + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRollbackCreateResponseBody) - + Rollback Stackable Redemptions Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧 You can roll back a redemption up to 3 months back. Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧 You can roll back a redemption up to 3 months back. Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. ApiResponse of RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧 You can roll back a redemption up to 3 months back. Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of RedemptionsRollbacksCreateResponseBody - + Rollback Stackable Redemptions Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧 You can roll back a redemption up to 3 months back. Thrown when fails to make API call Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. Reason for the rollback. (optional) Customers source_id. (optional) - Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RedemptionsRollbacksCreateResponseBody) @@ -20570,7 +20570,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ReferralsMembersHoldersCreateInBulkResponseBody @@ -20583,7 +20583,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody @@ -20597,7 +20597,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ReferralsMembersHoldersCreateInBulkResponseBody @@ -20611,7 +20611,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody @@ -20749,7 +20749,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ReferralsMembersHoldersCreateInBulkResponseBody @@ -20763,7 +20763,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) @@ -20778,7 +20778,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ReferralsMembersHoldersCreateInBulkResponseBody @@ -20793,7 +20793,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) @@ -20998,7 +20998,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ReferralsMembersHoldersCreateInBulkResponseBody @@ -21008,7 +21008,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody @@ -21018,7 +21018,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ReferralsMembersHoldersCreateInBulkResponseBody @@ -21029,7 +21029,7 @@ Thrown when fails to make API call Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) @@ -21041,7 +21041,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ReferralsMembersHoldersCreateInBulkResponseBody @@ -21052,7 +21052,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody @@ -21063,7 +21063,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ReferralsMembersHoldersCreateInBulkResponseBody @@ -21075,7 +21075,7 @@ Thrown when fails to make API call Unique identifier of a referral program campaign. Unique referral code or its identifier. - Specify the customer data to be upserted as redeemable holders. (optional) + Specify the customer data to be upserted as redeemable holders. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) @@ -21293,7 +21293,7 @@ Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. RewardsCreateResponseBody @@ -21305,7 +21305,7 @@ Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. ApiResponse of RewardsCreateResponseBody @@ -21318,7 +21318,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. RewardsAssignmentsCreateResponseBody @@ -21331,7 +21331,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. ApiResponse of RewardsAssignmentsCreateResponseBody @@ -21500,7 +21500,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. RewardsUpdateResponseBody @@ -21513,7 +21513,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. ApiResponse of RewardsUpdateResponseBody @@ -21527,7 +21527,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. RewardsAssignmentsUpdateResponseBody @@ -21541,7 +21541,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. ApiResponse of RewardsAssignmentsUpdateResponseBody @@ -21558,7 +21558,7 @@ Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsCreateResponseBody @@ -21571,7 +21571,7 @@ Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsCreateResponseBody) @@ -21585,7 +21585,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsAssignmentsCreateResponseBody @@ -21599,7 +21599,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsAssignmentsCreateResponseBody) @@ -21781,7 +21781,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsUpdateResponseBody @@ -21795,7 +21795,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsUpdateResponseBody) @@ -21810,7 +21810,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsAssignmentsUpdateResponseBody @@ -21825,7 +21825,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsAssignmentsUpdateResponseBody) @@ -21901,7 +21901,7 @@ Create Reward Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. RewardsCreateResponseBody @@ -21910,7 +21910,7 @@ Create Reward Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. ApiResponse of RewardsCreateResponseBody @@ -21919,7 +21919,7 @@ Create Reward Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsCreateResponseBody @@ -21929,7 +21929,7 @@ Create Reward Create a new reward. Thrown when fails to make API call - Define parameters of the new reward. (optional) + Define parameters of the new reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsCreateResponseBody) @@ -21940,7 +21940,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. RewardsAssignmentsCreateResponseBody @@ -21950,7 +21950,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. ApiResponse of RewardsAssignmentsCreateResponseBody @@ -21960,7 +21960,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsAssignmentsCreateResponseBody @@ -21971,7 +21971,7 @@ Thrown when fails to make API call A unique reward ID. - Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsAssignmentsCreateResponseBody) @@ -22234,7 +22234,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. RewardsUpdateResponseBody @@ -22244,7 +22244,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. ApiResponse of RewardsUpdateResponseBody @@ -22254,7 +22254,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsUpdateResponseBody @@ -22265,7 +22265,7 @@ Thrown when fails to make API call A unique reward ID. - Define the parameters to be updated for the reward. (optional) + Define the parameters to be updated for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsUpdateResponseBody) @@ -22277,7 +22277,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. RewardsAssignmentsUpdateResponseBody @@ -22288,7 +22288,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. ApiResponse of RewardsAssignmentsUpdateResponseBody @@ -22299,7 +22299,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of RewardsAssignmentsUpdateResponseBody @@ -22311,7 +22311,7 @@ Thrown when fails to make API call A unique reward ID. A unique reward assignment ID. - Define the number of points required to exchange for the reward. (optional) + Define the number of points required to exchange for the reward. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (RewardsAssignmentsUpdateResponseBody) @@ -22329,7 +22329,7 @@ Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. SegmentsCreateResponseBody @@ -22341,7 +22341,7 @@ Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. ApiResponse of SegmentsCreateResponseBody @@ -22406,7 +22406,7 @@ Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. Cancellation Token to cancel the request. Task of SegmentsCreateResponseBody @@ -22419,7 +22419,7 @@ Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (SegmentsCreateResponseBody) @@ -22547,7 +22547,7 @@ Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. SegmentsCreateResponseBody @@ -22556,7 +22556,7 @@ Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. ApiResponse of SegmentsCreateResponseBody @@ -22565,7 +22565,7 @@ Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. Cancellation Token to cancel the request. Task of SegmentsCreateResponseBody @@ -22575,7 +22575,7 @@ Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. Thrown when fails to make API call - Specify the boundary conditions for the customer segment. (optional) + Specify the boundary conditions for the customer segment. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (SegmentsCreateResponseBody) @@ -22670,7 +22670,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. TemplatesCampaignsTierSetupCreateResponseBody @@ -22683,7 +22683,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. ApiResponse of TemplatesCampaignsTierSetupCreateResponseBody @@ -22696,7 +22696,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. TemplatesCampaignsCampaignSetupCreateResponseBody @@ -22709,7 +22709,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. ApiResponse of TemplatesCampaignsCampaignSetupCreateResponseBody @@ -22721,7 +22721,7 @@ Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. TemplatesCampaignsCreateTemplateResponseBody @@ -22733,7 +22733,7 @@ Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. ApiResponse of TemplatesCampaignsCreateTemplateResponseBody @@ -22826,7 +22826,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. TemplatesCampaignsUpdateResponseBody @@ -22839,7 +22839,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. ApiResponse of TemplatesCampaignsUpdateResponseBody @@ -22857,7 +22857,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsTierSetupCreateResponseBody @@ -22871,7 +22871,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsTierSetupCreateResponseBody) @@ -22885,7 +22885,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsCampaignSetupCreateResponseBody @@ -22899,7 +22899,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsCampaignSetupCreateResponseBody) @@ -22912,7 +22912,7 @@ Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsCreateTemplateResponseBody @@ -22925,7 +22925,7 @@ Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsCreateTemplateResponseBody) @@ -23025,7 +23025,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsUpdateResponseBody @@ -23039,7 +23039,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsUpdateResponseBody) @@ -23116,7 +23116,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. TemplatesCampaignsTierSetupCreateResponseBody @@ -23126,7 +23126,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. ApiResponse of TemplatesCampaignsTierSetupCreateResponseBody @@ -23136,7 +23136,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsTierSetupCreateResponseBody @@ -23147,7 +23147,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsTierSetupCreateResponseBody) @@ -23158,7 +23158,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. TemplatesCampaignsCampaignSetupCreateResponseBody @@ -23168,7 +23168,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. ApiResponse of TemplatesCampaignsCampaignSetupCreateResponseBody @@ -23178,7 +23178,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsCampaignSetupCreateResponseBody @@ -23189,7 +23189,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Only name is required. The rest of the fields will overwrite the template configuration. (optional) + Only name is required. The rest of the fields will overwrite the template configuration. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsCampaignSetupCreateResponseBody) @@ -23199,7 +23199,7 @@ Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. TemplatesCampaignsCreateTemplateResponseBody @@ -23208,7 +23208,7 @@ Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. ApiResponse of TemplatesCampaignsCreateTemplateResponseBody @@ -23217,7 +23217,7 @@ Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsCreateTemplateResponseBody @@ -23227,7 +23227,7 @@ Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. Thrown when fails to make API call - Provide details for a campaign template (optional) + Provide details for a campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsCreateTemplateResponseBody) @@ -23368,7 +23368,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. TemplatesCampaignsUpdateResponseBody @@ -23378,7 +23378,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. ApiResponse of TemplatesCampaignsUpdateResponseBody @@ -23388,7 +23388,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of TemplatesCampaignsUpdateResponseBody @@ -23399,7 +23399,7 @@ Thrown when fails to make API call Pass the campaign template ID that was assigned by Voucherify. - Provide the new name or description for the campaign template (optional) + Provide the new name or description for the campaign template Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (TemplatesCampaignsUpdateResponseBody) @@ -23409,7 +23409,7 @@ Represents a collection of functions to interact with the API endpoints - + Create Validation Rules Assignments @@ -23418,12 +23418,12 @@ Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments @@ -23432,8 +23432,8 @@ Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. ApiResponse of ValidationRulesAssignmentsCreateResponseBody @@ -23445,7 +23445,7 @@ Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. ValidationRulesCreateResponseBody @@ -23457,7 +23457,7 @@ Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. ApiResponse of ValidationRulesCreateResponseBody @@ -23638,7 +23638,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ValidationRulesUpdateResponseBody @@ -23651,7 +23651,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of ValidationRulesUpdateResponseBody @@ -23660,7 +23660,7 @@ Represents a collection of functions to interact with the API endpoints - + Create Validation Rules Assignments @@ -23669,13 +23669,13 @@ Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments @@ -23684,8 +23684,8 @@ Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesAssignmentsCreateResponseBody) @@ -23698,7 +23698,7 @@ Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesCreateResponseBody @@ -23711,7 +23711,7 @@ Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesCreateResponseBody) @@ -23905,7 +23905,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesUpdateResponseBody @@ -23919,7 +23919,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesUpdateResponseBody) @@ -23990,48 +23990,48 @@ Provides a factory method hook for the creation of exceptions. - + Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution. Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution. Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. ApiResponse of ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution. Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesAssignmentsCreateResponseBody - + Create Validation Rules Assignments Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution. Thrown when fails to make API call Unique validation rule ID. + Specify the resource that you would like to assign the validation rule to. If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - Specify the resource that you would like to assign the validation rule to. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesAssignmentsCreateResponseBody) @@ -24041,7 +24041,7 @@ Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. ValidationRulesCreateResponseBody @@ -24050,7 +24050,7 @@ Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. ApiResponse of ValidationRulesCreateResponseBody @@ -24059,7 +24059,7 @@ Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesCreateResponseBody @@ -24069,7 +24069,7 @@ Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. Thrown when fails to make API call - Specify the validation rules parameters. (optional) + Specify the validation rules parameters. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesCreateResponseBody) @@ -24356,7 +24356,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ValidationRulesUpdateResponseBody @@ -24366,7 +24366,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. ApiResponse of ValidationRulesUpdateResponseBody @@ -24376,7 +24376,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationRulesUpdateResponseBody @@ -24387,7 +24387,7 @@ Thrown when fails to make API call A unique validation rule ID. - Specify the parameters to be updated. (optional) + Specify the parameters to be updated. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationRulesUpdateResponseBody) @@ -24405,7 +24405,7 @@ Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. ValidationsValidateResponseBody @@ -24417,7 +24417,7 @@ Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of ValidationsValidateResponseBody @@ -24434,7 +24434,7 @@ Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationsValidateResponseBody @@ -24447,7 +24447,7 @@ Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationsValidateResponseBody) @@ -24523,7 +24523,7 @@ Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. ValidationsValidateResponseBody @@ -24532,7 +24532,7 @@ Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. ApiResponse of ValidationsValidateResponseBody @@ -24541,7 +24541,7 @@ Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ValidationsValidateResponseBody @@ -24551,7 +24551,7 @@ Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. Thrown when fails to make API call - (optional) + Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (ValidationsValidateResponseBody) @@ -24570,7 +24570,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. VouchersCreateResponseBody @@ -24583,7 +24583,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. ApiResponse of VouchersCreateResponseBody @@ -24670,7 +24670,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. VouchersTransactionsExportCreateResponseBody @@ -24683,7 +24683,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. ApiResponse of VouchersTransactionsExportCreateResponseBody @@ -24695,7 +24695,7 @@ Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. VouchersCreateResponseBody @@ -24707,7 +24707,7 @@ Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. ApiResponse of VouchersCreateResponseBody @@ -24740,7 +24740,7 @@ Import Vouchers - Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -24752,7 +24752,7 @@ Import Vouchers - Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -24764,7 +24764,7 @@ Import Vouchers using CSV - Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -24777,7 +24777,7 @@ Import Vouchers using CSV - Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -24815,7 +24815,7 @@ Index associated with the operation. ApiResponse of VouchersTransactionsListResponseBody - + List Vouchers @@ -24834,10 +24834,11 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. VouchersListResponseBody - + List Vouchers @@ -24856,6 +24857,7 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. ApiResponse of VouchersListResponseBody @@ -24999,7 +25001,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersCreateResponseBody @@ -25013,7 +25015,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersCreateResponseBody) @@ -25107,7 +25109,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersTransactionsExportCreateResponseBody @@ -25121,7 +25123,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersTransactionsExportCreateResponseBody) @@ -25134,7 +25136,7 @@ Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersCreateResponseBody @@ -25147,7 +25149,7 @@ Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersCreateResponseBody) @@ -25183,7 +25185,7 @@ Import Vouchers - Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25196,7 +25198,7 @@ Import Vouchers - Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25209,7 +25211,7 @@ Import Vouchers using CSV - Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25223,7 +25225,7 @@ Import Vouchers using CSV - Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25264,7 +25266,7 @@ Cancellation Token to cancel the request. Task of ApiResponse (VouchersTransactionsListResponseBody) - + List Vouchers @@ -25283,11 +25285,12 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersListResponseBody - + List Vouchers @@ -25306,6 +25309,7 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersListResponseBody) @@ -25518,7 +25522,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. VouchersCreateResponseBody @@ -25528,7 +25532,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. ApiResponse of VouchersCreateResponseBody @@ -25538,7 +25542,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersCreateResponseBody @@ -25549,7 +25553,7 @@ Thrown when fails to make API call A unique **code** that identifies the voucher. - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersCreateResponseBody) @@ -25678,7 +25682,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. VouchersTransactionsExportCreateResponseBody @@ -25688,7 +25692,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. ApiResponse of VouchersTransactionsExportCreateResponseBody @@ -25698,7 +25702,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersTransactionsExportCreateResponseBody @@ -25709,7 +25713,7 @@ Thrown when fails to make API call A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - Specify the parameters for the camapign transaction export. (optional) + Specify the parameters for the camapign transaction export. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersTransactionsExportCreateResponseBody) @@ -25719,7 +25723,7 @@ Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. VouchersCreateResponseBody @@ -25728,7 +25732,7 @@ Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. ApiResponse of VouchersCreateResponseBody @@ -25737,7 +25741,7 @@ Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersCreateResponseBody @@ -25747,7 +25751,7 @@ Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. Thrown when fails to make API call - Specify the details of the voucher that you would like to create. (optional) + Specify the details of the voucher that you would like to create. Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersCreateResponseBody) @@ -25792,7 +25796,7 @@ - Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25801,7 +25805,7 @@ - Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25810,7 +25814,7 @@ - Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25820,7 +25824,7 @@ - Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call The request body is an array of objects. Each object contains details about a specific voucher. @@ -25830,7 +25834,7 @@ - Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25840,7 +25844,7 @@ - Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25850,7 +25854,7 @@ - Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25861,7 +25865,7 @@ - Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Thrown when fails to make API call File path. (optional) @@ -25920,7 +25924,7 @@ Cancellation Token to cancel the request. Task of ApiResponse (VouchersTransactionsListResponseBody) - + List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers. @@ -25936,10 +25940,11 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. VouchersListResponseBody - + List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers. @@ -25955,10 +25960,11 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. ApiResponse of VouchersListResponseBody - + List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers. @@ -25974,11 +25980,12 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of VouchersListResponseBody - + List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers. @@ -25994,6 +26001,7 @@ Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) (optional) (optional) + Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) Index associated with the operation. Cancellation Token to cancel the request. Task of ApiResponse (VouchersListResponseBody) @@ -41779,7 +41787,7 @@ - Response body schema for **POST** `v1/validations`. + Request body schema for **POST** `v1/validations`. @@ -87447,7 +87455,7 @@ The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.. Unique voucher ID.. Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.. Reason why the transaction occurred. In case of a redemption, this value is null.. The related transaction ID on the receiving card.. Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.. @@ -87504,9 +87512,9 @@ - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. @@ -89845,7 +89853,7 @@ Unique identifier of the parent loyalty card.. Unique identifier of the parent campaign.. bucket. - Loyalty point point bucket status.. + Loyalty point bucket status.. Date when the number of points defined in the bucket object are due to expire.. Timestamp representing the date and time when the loyalty point bucket object was created in ISO 8601 format.. Timestamp representing the date and time when the loyalty point bucket object was updated in ISO 8601 format.. @@ -89900,9 +89908,9 @@ - Loyalty point point bucket status. + Loyalty point bucket status. - Loyalty point point bucket status. + Loyalty point bucket status. @@ -114392,7 +114400,7 @@ The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.. Unique voucher ID.. Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.. Reason why the transaction occurred. In case of a redemption, this value is null.. The related transaction ID on the receiving card.. Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.. @@ -114449,9 +114457,9 @@ - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. @@ -120335,7 +120343,7 @@ false (boolean) - + Initializes a new instance of the class. @@ -120347,7 +120355,6 @@ Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).. Array of items applied to the order. It can include up to 500 items.. A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.. - Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.. Unique referrer ID.. customer. referrer. @@ -120436,18 +120443,6 @@ false (boolean) - - - Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. - - Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. - - - - Returns false as CreatedAt should not be serialized given that it's read-only. - - false (boolean) - Unique referrer ID. @@ -128857,20 +128852,23 @@ - Show that the product collection is static (manually selected products). + Defines Type - Show that the product collection is static (manually selected products). Enum STATIC for value: STATIC + + + Enum AUTOUPDATE for value: AUTO_UPDATE + + - Show that the product collection is static (manually selected products). + Gets or Sets Type - Show that the product collection is static (manually selected products). @@ -128882,7 +128880,7 @@ Initializes a new instance of the class. - Show that the product collection is static (manually selected products).. + type. Unique user-defined product collection name.. Defines a set of products for a `STATIC` product collection type.. Defines a set of criteria and boundary conditions for an `AUTO_UPDATE` product collection type.. @@ -161735,7 +161733,7 @@ false (boolean) - + Initializes a new instance of the class. @@ -164283,7 +164281,7 @@ Initializes a new instance of the class. id. - The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.. + The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.. @@ -164298,9 +164296,9 @@ - The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. + The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. - The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. + The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. @@ -165820,32 +165818,6 @@ false (boolean) - - - Defines InitialSyncStatus - - - - - Enum INPROGRESS for value: IN_PROGRESS - - - - - Enum DONE for value: DONE - - - - - Gets or Sets InitialSyncStatus - - - - - Returns false as InitialSyncStatus should not be serialized given that it's read-only. - - false (boolean) - The type of the object represented by JSON. This object stores information about the customer segment. @@ -165869,7 +165841,7 @@ false (boolean) - + Initializes a new instance of the class. @@ -165878,7 +165850,6 @@ Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format.. Defines whether the segment is: - Active (`auto-update`): customers enter and leave the segment based on the defined filters and the `customer.segment.entered` and `customer.segment.left` events are triggered, - Passive (`passive`): customers enter and leave the segment based on the defined filters, but the `customer.segment.entered` and `customer.segment.left` events are not triggered, - Static (`static`): manually selected customers.. Defines a set of criteria for an `auto-update` or `passive` segment type.. - initialSyncStatus. The type of the object represented by JSON. This object stores information about the customer segment.. @@ -165986,32 +165957,6 @@ false (boolean) - - - Defines InitialSyncStatus - - - - - Enum INPROGRESS for value: IN_PROGRESS - - - - - Enum DONE for value: DONE - - - - - Gets or Sets InitialSyncStatus - - - - - Returns false as InitialSyncStatus should not be serialized given that it's read-only. - - false (boolean) - The type of the object represented by JSON. This object stores information about the customer segment. @@ -166035,7 +165980,7 @@ false (boolean) - + Initializes a new instance of the class. @@ -166044,7 +165989,6 @@ Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format.. Defines whether the segment is: - Active (`auto-update`): customers enter and leave the segment based on the defined filters and the `customer.segment.entered` and `customer.segment.left` events are triggered, - Passive (`passive`): customers enter and leave the segment based on the defined filters, but the `customer.segment.entered` and `customer.segment.left` events are not triggered, - Static (`static`): manually selected customers.. Defines a set of criteria for an `auto-update` or `passive` segment type.. - initialSyncStatus. The type of the object represented by JSON. This object stores information about the customer segment.. @@ -177361,7 +177305,7 @@ - Response body schema for **POST** `v1/validations`. + Request body schema for **POST** `v1/validations`. @@ -179910,13 +179854,13 @@ Initializes a new instance of the class. - Defines the reccuring period(s) when the resource is active. The periods should not overlap.. + Defines the recurring period(s) when the resource is active. The periods should not overlap.. - Defines the reccuring period(s) when the resource is active. The periods should not overlap. + Defines the recurring period(s) when the resource is active. The periods should not overlap. - Defines the reccuring period(s) when the resource is active. The periods should not overlap. + Defines the recurring period(s) when the resource is active. The periods should not overlap. @@ -179945,7 +179889,7 @@ - Defines the reccuring period(s) when the resource will be active. + Defines the recurring period(s) when the resource will be active. @@ -188068,7 +188012,7 @@ The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.. Unique voucher ID.. Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.. Reason why the transaction occurred. In case of a redemption, this value is null.. The related transaction ID on the receiving card.. Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.. @@ -188125,9 +188069,9 @@ - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. - The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. diff --git a/readme.md b/readme.md index 80fd67f1..2c3298b2 100644 --- a/readme.md +++ b/readme.md @@ -33,9 +33,9 @@ For more info, visit those places: ## Frameworks supported Voucherify .NET SDK supports the following frameworks: -- .NET Core >= 1.0 -- .NET Framework >= 4.6 -- Mono/Xamarin >= vNext +- .NET Core >=1.0 +- .NET Framework >=4.6 +- Mono/Xamarin >=vNext ## Dependencies @@ -60,7 +60,6 @@ Install-Package System.ComponentModel.Annotations ## βš™οΈ Install -To install the SDK: 1. Generate the DLL using your preferred tool, for example `dotnet build`. 2. Then include the DLL (under the `bin` folder) in the C# project, and use the namespaces: @@ -144,10 +143,9 @@ namespace Example ``` > [!TIP] -> +> > Check the test implementation in the [Test folder](./src/Voucherify.Test). - ## 🐳 Run local tests with docker To run tests locally with docker: @@ -165,7 +163,7 @@ This SDK is auto-generated (except for tests), so changes made here will be over ## 🏷️ Link tags -[OpenAPI generated from tag](https://github.com/voucherifyio/voucherify-openapi/releases/tag/sdk-dotnet-8.1.0). +[OpenAPI generated from tag](https://github.com/voucherifyio/voucherify-openapi/releases/tag/sdk-dotnet-9.0.0). ## πŸ” Authorization @@ -214,51 +212,57 @@ Authorization schemes defined for the API. - **Authorization URL**: https://api.voucherify.io/v1/oauth/token - **Scopes**: - `api`: Gives access to whole server-side API. - - `vouchers`: Gives access to all endpoints and methods starting with `v1/vouchers`. + - `vouchers`: Gives access to all endpoints and methods starting with `v1/vouchers`. - `client_api`: Gives access to whole client-side API. - - `client_vouchers`: Gives access to all endpoints and methods starting with `/client/v1/vouchers`. - - `promotions`: Gives access to all endpoints and methods starting with `/v1/promotions`. - - `client_promotions`: Gives access to all endpoints and methods starting with `/client/v1/promotions` - - `campaigns`: Gives access to all endpoints and methods starting with `v1/campaigns`. - - `client_publish`: Gives access to all endpoints and methods starting with `/client/v1/publish`. - - `exports`: Gives access to all endpoints and methods starting with `/v1/exports`. - - `publications`: Gives access to all endpoints and methods starting with `/v1/publications`. - - `client_validate`: Gives access to all endpoints and methods starting with `/client/v1/validate`. - - `validations`: Gives access to all endpoints and methods starting with `/v1/validations`. - - `client_validations`: Gives access to all endpoints and methods starting with `/client/v1/validations`. - - `qualifications`: Gives access to all endpoints and methods starting with `/v1/qualifications`. - - `client_qualifications`: Gives access to all endpoints and methods starting with `/client/v1/qualifications`. - - `client_redeem`: Gives access to all endpoints and methods starting with `/client/v1/redeem - - `redemptions`: Gives access to all endpoints and methods starting with `/v1/redemptions`. - - `client_redemptions`: Gives access to all endpoints and methods starting with `/client/v1/redemptions` - - `customers`: Gives access to all endpoints and methods starting with `/v1/customers`. - - `client_customers`: Gives access to all endpoints and methods starting with `/client/v1/customers`. - - `orders`: Gives access to all endpoints and methods starting with `/v1/orders`. - - `products`: Gives access to all endpoints and methods starting with `/v1/products`. - - `skus`: Gives access to all endpoints and methods starting with `/v1/SKUs`. - - `validation-rules`: Gives access to all endpoints and methods starting with `/v1/validation-rules`. - - `validation-rules-assignments`: Gives access to all endpoints and methods starting with `/v1/validation-rules-assignments - - `segments`: Gives access to all endpoints and methods starting with `/v1/segments`. - - `events`: Gives access to all endpoints and methods starting with `/v1/events`. - - `client_events`: Gives access to all endpoints and methods starting with `client/v1/events`. - - `rewards`: Gives access to all endpoints and methods starting with `/v1/rewards`. - - `assets`: Gives access to all endpoints and methods starting with `/v1/assets`. - - `task-results`: Gives access to all endpoints and methods starting with `/v1/task-results`. - - `loyalties`: Gives access to all endpoints and methods starting with `/v1/loyalties`. - - `client_consents`: Gives access to all endpoints and methods starting with `client/v1/consents`. - - `consents`: Gives access to all endpoints and methods starting with `/v1/consents`. - - `async-actions`: Gives access to all endpoints and methods starting with `/v1/async-actions`. - - `product-collections`: Gives access to all endpoints and methods starting with `/v1/product-collections`. - - `categories`: Gives access to all endpoints and methods starting with `/v1/categories`. - - `metadata-schemas`: Gives access to all endpoints and methods starting with `/v1/metadata-schemas`. - - `locations`: Gives access to all endpoints and methods starting with `/v1/locations`. - - `referrals`: Gives access to all endpoints and methods starting with `/v1/referrals`. - - `trash-bin`: Gives access to all endpoints and methods starting with `/v1/trash-bin`. - - `templates`: Gives access to all endpoints and methods starting with `/v1/templates`. + - `client_vouchers`: Gives access to all endpoints and methods starting with `/client/v1/vouchers`. + - `promotions`: Gives access to all endpoints and methods starting with `/v1/promotions`. + - `client_promotions`: Gives access to all endpoints and methods starting with `/client/v1/promotions` + - `campaigns`: Gives access to all endpoints and methods starting with `v1/campaigns`. + - `client_publish`: Gives access to all endpoints and methods starting with `/client/v1/publish`. + - `exports`: Gives access to all endpoints and methods starting with `/v1/exports`. + - `publications`: Gives access to all endpoints and methods starting with `/v1/publications`. + - `client_validate`: Gives access to all endpoints and methods starting with `/client/v1/validate`. + - `validations`: Gives access to all endpoints and methods starting with `/v1/validations`. + - `client_validations`: Gives access to all endpoints and methods starting with `/client/v1/validations`. + - `qualifications`: Gives access to all endpoints and methods starting with `/v1/qualifications`. + - `client_qualifications`: Gives access to all endpoints and methods starting with `/client/v1/qualifications`. + - `client_redeem`: Gives access to all endpoints and methods starting with `/client/v1/redeem + - `redemptions`: Gives access to all endpoints and methods starting with `/v1/redemptions`. + - `client_redemptions`: Gives access to all endpoints and methods starting with `/client/v1/redemptions` + - `customers`: Gives access to all endpoints and methods starting with `/v1/customers`. + - `client_customers`: Gives access to all endpoints and methods starting with `/client/v1/customers`. + - `orders`: Gives access to all endpoints and methods starting with `/v1/orders`. + - `products`: Gives access to all endpoints and methods starting with `/v1/products`. + - `skus`: Gives access to all endpoints and methods starting with `/v1/SKUs`. + - `validation-rules`: Gives access to all endpoints and methods starting with `/v1/validation-rules`. + - `validation-rules-assignments`: Gives access to all endpoints and methods starting with `/v1/validation-rules-assignments + - `segments`: Gives access to all endpoints and methods starting with `/v1/segments`. + - `events`: Gives access to all endpoints and methods starting with `/v1/events`. + - `client_events`: Gives access to all endpoints and methods starting with `client/v1/events`. + - `rewards`: Gives access to all endpoints and methods starting with `/v1/rewards`. + - `assets`: Gives access to all endpoints and methods starting with `/v1/assets`. + - `task-results`: Gives access to all endpoints and methods starting with `/v1/task-results`. + - `loyalties`: Gives access to all endpoints and methods starting with `/v1/loyalties`. + - `client_consents`: Gives access to all endpoints and methods starting with `client/v1/consents`. + - `consents`: Gives access to all endpoints and methods starting with `/v1/consents`. + - `async-actions`: Gives access to all endpoints and methods starting with `/v1/async-actions`. + - `product-collections`: Gives access to all endpoints and methods starting with `/v1/product-collections`. + - `categories`: Gives access to all endpoints and methods starting with `/v1/categories`. + - `metadata-schemas`: Gives access to all endpoints and methods starting with `/v1/metadata-schemas`. + - `locations`: Gives access to all endpoints and methods starting with `/v1/locations`. + - `referrals`: Gives access to all endpoints and methods starting with `/v1/referrals`. + - `trash-bin`: Gives access to all endpoints and methods starting with `/v1/trash-bin`. + - `templates`: Gives access to all endpoints and methods starting with `/v1/templates`. ## πŸ“… Changelog -- **2024-10-21** - `8.1.0` +- **2025-12-14** - `9.0.0` + - All POST requests now require a payload. As a result, the order of parameters in API method calls may have changed. If you encounter a build error, please check the documentation for the method you are calling. + - `OrdersImportCreateRequestBodyItem` no longer has `CreatedAt` property. + - `RelatedObjectParent` property `Amount` now is `int?` type, instead of `string?`. + - `SegmentsCreateResponseBody` and `SegmentsGetResponseBody` no longer have `InitialSyncStatus` property. + - Added support for advanced filtering while listing vouchers. +- **2025-10-21** - `8.1.0` - **Invalid/New Enums will be parsed as null** - **If a property is missing will be simply skipped, please ensure on your side if parameter is expected** - Added support for POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance @@ -270,268 +274,269 @@ Authorization schemes defined for the API. - `PointsFormula` is supported now - `ManagementProjectsStackingRulesUpdateResponseBody` has many more properties now. - Aligned with the latest OpenAPI definition. -- **2024-05-06** - `8.0.1` +- **2025-05-07** - `8.0.1` - Added OAuth support for Loyalty Pending Points endpoints. -- **2024-05-06** - `8.0.0` +- **2025-05-07** - `8.0.0` - The new version of the SDK includes coverage for all Voucherify endpoints and supports typed models. *Previous versions of the SDK are no longer supported. We highly recommend upgrading to version 8.0.0 or newer, as it is now designated as Long-Term Support (LTS).* *Changelog for previous versions is in the [DEPRECATED CHANGELOG file](https://github.com/voucherifyio/voucherify-dotNET-sdk/blob/versions/7.19.0/readme.md#changelog)* -## 🌐 Documentation of API endpoints - -All URIs are relative to `https://api.voucherify.io`. - -| Class | Method | HTTP request | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------- | -| *AsyncActionsApi* | [**GetAsyncAction**](docs/AsyncActionsApi.md#getasyncaction) | **GET** /v1/async-actions/{asyncActionId} | Get Async Action | -| *AsyncActionsApi* | [**ListAsyncActions**](docs/AsyncActionsApi.md#listasyncactions) | **GET** /v1/async-actions | List Async Actions | -| *BinApi* | [**DeleteBinEntry**](docs/BinApi.md#deletebinentry) | **DELETE** /v1/trash-bin/{binEntryId} | Delete Bin Entry | -| *BinApi* | [**ListBinEntries**](docs/BinApi.md#listbinentries) | **GET** /v1/trash-bin | List Bin Entries | -| *CampaignsApi* | [**AddVoucherWithSpecificCodeToCampaign**](docs/CampaignsApi.md#addvoucherwithspecificcodetocampaign) | **POST** /v1/campaigns/{campaignId}/vouchers/{code} | Add Voucher with Specific Code to Campaign | -| *CampaignsApi* | [**AddVouchersToCampaign**](docs/CampaignsApi.md#addvoucherstocampaign) | **POST** /v1/campaigns/{campaignId}/vouchers | Add Vouchers to Campaign | -| *CampaignsApi* | [**CreateCampaign**](docs/CampaignsApi.md#createcampaign) | **POST** /v1/campaigns | Create Campaign | -| *CampaignsApi* | [**DeleteCampaign**](docs/CampaignsApi.md#deletecampaign) | **DELETE** /v1/campaigns/{campaignId} | Delete Campaign | -| *CampaignsApi* | [**DisableCampaign**](docs/CampaignsApi.md#disablecampaign) | **POST** /v1/campaigns/{campaignId}/disable | Disable Campaign | -| *CampaignsApi* | [**EnableCampaign**](docs/CampaignsApi.md#enablecampaign) | **POST** /v1/campaigns/{campaignId}/enable | Enable Campaign | -| *CampaignsApi* | [**ExportCampaignTransactions**](docs/CampaignsApi.md#exportcampaigntransactions) | **POST** /v1/campaigns/{campaignId}/transactions/export | Export Campaign Transactions | -| *CampaignsApi* | [**GetCampaign**](docs/CampaignsApi.md#getcampaign) | **GET** /v1/campaigns/{campaignId} | Get Campaign | -| *CampaignsApi* | [**GetCampaignSummary**](docs/CampaignsApi.md#getcampaignsummary) | **GET** /v1/campaigns/{campaignId}/summary | Get Campaign Summary | -| *CampaignsApi* | [**ImportVouchersToCampaign**](docs/CampaignsApi.md#importvoucherstocampaign) | **POST** /v1/campaigns/{campaignId}/import | Import Vouchers to Campaign | -| *CampaignsApi* | [**ImportVouchersToCampaignUsingCsv**](docs/CampaignsApi.md#importvoucherstocampaignusingcsv) | **POST** /v1/campaigns/{campaignId}/importCSV | Import Vouchers to Campaign by CSV | -| *CampaignsApi* | [**ListCampaignTransactions**](docs/CampaignsApi.md#listcampaigntransactions) | **GET** /v1/campaigns/{campaignId}/transactions | List Campaign Transactions | -| *CampaignsApi* | [**ListCampaigns**](docs/CampaignsApi.md#listcampaigns) | **GET** /v1/campaigns | List Campaigns | -| *CampaignsApi* | [**UpdateCampaign**](docs/CampaignsApi.md#updatecampaign) | **PUT** /v1/campaigns/{campaignId} | Update Campaign | -| *CategoriesApi* | [**CreateCategory**](docs/CategoriesApi.md#createcategory) | **POST** /v1/categories | Create Category | -| *CategoriesApi* | [**DeleteCategory**](docs/CategoriesApi.md#deletecategory) | **DELETE** /v1/categories/{categoryId} | Delete Category | -| *CategoriesApi* | [**GetCategory**](docs/CategoriesApi.md#getcategory) | **GET** /v1/categories/{categoryId} | Get Category | -| *CategoriesApi* | [**ListCategories**](docs/CategoriesApi.md#listcategories) | **GET** /v1/categories | List Categories | -| *CategoriesApi* | [**UpdateCategory**](docs/CategoriesApi.md#updatecategory) | **PUT** /v1/categories/{categoryId} | Update Category | -| *ClientSideApi* | [**CheckEligibilityClientSide**](docs/ClientSideApi.md#checkeligibilityclientside) | **POST** /client/v1/qualifications | Check Eligibility (client-side) | -| *ClientSideApi* | [**ListPromotionTiersClientSide**](docs/ClientSideApi.md#listpromotiontiersclientside) | **GET** /client/v1/promotions/tiers | List Promotion Tiers (client-side) | -| *ClientSideApi* | [**RedeemStackedDiscountsClientSide**](docs/ClientSideApi.md#redeemstackeddiscountsclientside) | **POST** /client/v1/redemptions | Redeem Stackable Discounts (client-side) | -| *ClientSideApi* | [**TrackCustomEventClientSide**](docs/ClientSideApi.md#trackcustomeventclientside) | **POST** /client/v1/events | Track Custom Event (client-side) | -| *ClientSideApi* | [**ValidateStackedDiscountsClientSide**](docs/ClientSideApi.md#validatestackeddiscountsclientside) | **POST** /client/v1/validations | Validate Stackable Discounts (client-side) | -| *CustomersApi* | [**CreateCustomer**](docs/CustomersApi.md#createcustomer) | **POST** /v1/customers | Create Customer | -| *CustomersApi* | [**CustomerPermanentlyDeletion**](docs/CustomersApi.md#customerpermanentlydeletion) | **POST** /v1/customers/{customerId}/permanent-deletion | Delete Customer Permanently | -| *CustomersApi* | [**DeleteCustomer**](docs/CustomersApi.md#deletecustomer) | **DELETE** /v1/customers/{customerId} | Delete Customer | -| *CustomersApi* | [**GetCustomer**](docs/CustomersApi.md#getcustomer) | **GET** /v1/customers/{customerId} | Get Customer | -| *CustomersApi* | [**ImportCustomersUsingCsv**](docs/CustomersApi.md#importcustomersusingcsv) | **POST** /v1/customers/importCSV | Import and Update Customers using CSV | -| *CustomersApi* | [**ListCustomerActivity**](docs/CustomersApi.md#listcustomeractivity) | **GET** /v1/customers/{customerId}/activity | List Customer Activity | -| *CustomersApi* | [**ListCustomerRedeemables**](docs/CustomersApi.md#listcustomerredeemables) | **GET** /v1/customers/{customerId}/redeemables | List Customer's Redeemables | -| *CustomersApi* | [**ListCustomerSegments**](docs/CustomersApi.md#listcustomersegments) | **GET** /v1/customers/{customerId}/segments | List Customer's Segments | -| *CustomersApi* | [**ListCustomers**](docs/CustomersApi.md#listcustomers) | **GET** /v1/customers | List Customers | -| *CustomersApi* | [**UpdateCustomer**](docs/CustomersApi.md#updatecustomer) | **PUT** /v1/customers/{customerId} | Update Customer | -| *CustomersApi* | [**UpdateCustomersInBulk**](docs/CustomersApi.md#updatecustomersinbulk) | **POST** /v1/customers/bulk/async | Update Customers in Bulk | -| *CustomersApi* | [**UpdateCustomersMetadataInBulk**](docs/CustomersApi.md#updatecustomersmetadatainbulk) | **POST** /v1/customers/metadata/async | Update Customers' Metadata in Bulk | -| *EventsApi* | [**TrackCustomEvent**](docs/EventsApi.md#trackcustomevent) | **POST** /v1/events | Track Custom Event | -| *ExportsApi* | [**CreateExport**](docs/ExportsApi.md#createexport) | **POST** /v1/exports | Create Export | -| *ExportsApi* | [**DeleteExport**](docs/ExportsApi.md#deleteexport) | **DELETE** /v1/exports/{exportId} | Delete Export | -| *ExportsApi* | [**DownloadExport**](docs/ExportsApi.md#downloadexport) | **GET** /v1/exports/{export_Id} | Download Export | -| *ExportsApi* | [**GetExport**](docs/ExportsApi.md#getexport) | **GET** /v1/exports/{exportId} | Get Export | -| *ExportsApi* | [**ListExports**](docs/ExportsApi.md#listexports) | **GET** /v1/exports | List Exports | -| *LocationsApi* | [**GetLocation**](docs/LocationsApi.md#getlocation) | **GET** /v1/locations/{locationId} | Get Location | -| *LocationsApi* | [**ListLocations**](docs/LocationsApi.md#listlocations) | **GET** /v1/locations | List Locations | -| *LoyaltiesApi* | [**ActivateMemberPendingPoints**](docs/LoyaltiesApi.md#activatememberpendingpoints) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate | Activate Member Pending Points | -| *LoyaltiesApi* | [**AddMember**](docs/LoyaltiesApi.md#addmember) | **POST** /v1/loyalties/{campaignId}/members | Add Member | -| *LoyaltiesApi* | [**AdjustMemberPendingPoints**](docs/LoyaltiesApi.md#adjustmemberpendingpoints) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance | Adjust Member Pending Points | -| *LoyaltiesApi* | [**CancelMemberPendingPoints**](docs/LoyaltiesApi.md#cancelmemberpendingpoints) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel | Cancel Member Pending Points | -| *LoyaltiesApi* | [**CreateEarningRule**](docs/LoyaltiesApi.md#createearningrule) | **POST** /v1/loyalties/{campaignId}/earning-rules | Create Earning Rule | -| *LoyaltiesApi* | [**CreateInBulkLoyaltyTiers**](docs/LoyaltiesApi.md#createinbulkloyaltytiers) | **POST** /v1/loyalties/{campaignId}/tiers | Create loyalty tiers | -| *LoyaltiesApi* | [**CreateLoyaltyProgram**](docs/LoyaltiesApi.md#createloyaltyprogram) | **POST** /v1/loyalties | Create Loyalty Campaign | -| *LoyaltiesApi* | [**CreatePointsExpirationExport**](docs/LoyaltiesApi.md#createpointsexpirationexport) | **POST** /v1/loyalties/{campaignId}/points-expiration/export | Export Loyalty Campaign Point Expiration | -| *LoyaltiesApi* | [**CreateRewardAssignment1**](docs/LoyaltiesApi.md#createrewardassignment1) | **POST** /v1/loyalties/{campaignId}/rewards | Create Loyalty Campaign Reward Assignment | -| *LoyaltiesApi* | [**DeleteEarningRule**](docs/LoyaltiesApi.md#deleteearningrule) | **DELETE** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Delete Earning Rule | -| *LoyaltiesApi* | [**DeleteLoyaltyProgram**](docs/LoyaltiesApi.md#deleteloyaltyprogram) | **DELETE** /v1/loyalties/{campaignId} | Delete Loyalty Campaign | -| *LoyaltiesApi* | [**DeleteRewardAssignment1**](docs/LoyaltiesApi.md#deleterewardassignment1) | **DELETE** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Delete Campaign Reward Assignment | -| *LoyaltiesApi* | [**DisableEarningRule**](docs/LoyaltiesApi.md#disableearningrule) | **POST** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable | Disable Earning Rule | -| *LoyaltiesApi* | [**EnableEarningRule**](docs/LoyaltiesApi.md#enableearningrule) | **POST** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable | Enable Earning Rule | -| *LoyaltiesApi* | [**ExportLoyaltyCampaignTransactions**](docs/LoyaltiesApi.md#exportloyaltycampaigntransactions) | **POST** /v1/loyalties/{campaignId}/transactions/export | Export Loyalty Campaign Transactions | -| *LoyaltiesApi* | [**ExportLoyaltyCardTransactions**](docs/LoyaltiesApi.md#exportloyaltycardtransactions) | **POST** /v1/loyalties/members/{memberId}/transactions/export | Export Loyalty Card Transactions | -| *LoyaltiesApi* | [**ExportLoyaltyCardTransactions1**](docs/LoyaltiesApi.md#exportloyaltycardtransactions1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | Export Loyalty Card Transactions with campaign ID | -| *LoyaltiesApi* | [**GetEarningRule**](docs/LoyaltiesApi.md#getearningrule) | **GET** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Get Earning Rule | -| *LoyaltiesApi* | [**GetLoyaltyProgram**](docs/LoyaltiesApi.md#getloyaltyprogram) | **GET** /v1/loyalties/{campaignId} | Get Loyalty Campaign | -| *LoyaltiesApi* | [**GetLoyaltyTier**](docs/LoyaltiesApi.md#getloyaltytier) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | Get Loyalty Tier | -| *LoyaltiesApi* | [**GetMember**](docs/LoyaltiesApi.md#getmember) | **GET** /v1/loyalties/members/{memberId} | Get Member | -| *LoyaltiesApi* | [**GetMember1**](docs/LoyaltiesApi.md#getmember1) | **GET** /v1/loyalties/{campaignId}/members/{memberId} | Get Member with campaign ID | -| *LoyaltiesApi* | [**GetRewardAssignment1**](docs/LoyaltiesApi.md#getrewardassignment1) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | Get Campaign Reward Assignments | -| *LoyaltiesApi* | [**GetRewardAssignment2**](docs/LoyaltiesApi.md#getrewardassignment2) | **GET** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Get Campaign Reward Assignment | -| *LoyaltiesApi* | [**GetRewardDetails**](docs/LoyaltiesApi.md#getrewarddetails) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | Get Reward Details | -| *LoyaltiesApi* | [**ListCampaignPendingPoints**](docs/LoyaltiesApi.md#listcampaignpendingpoints) | **GET** /v1/loyalties/{campaignId}/pending-points | List Campaign Pending Points | -| *LoyaltiesApi* | [**ListEarningRules**](docs/LoyaltiesApi.md#listearningrules) | **GET** /v1/loyalties/{campaignId}/earning-rules | List Earning Rules | -| *LoyaltiesApi* | [**ListLoyaltyCampaignTransactions**](docs/LoyaltiesApi.md#listloyaltycampaigntransactions) | **GET** /v1/loyalties/{campaignId}/transactions | List Loyalty Campaign Transactions | -| *LoyaltiesApi* | [**ListLoyaltyCardTransactions**](docs/LoyaltiesApi.md#listloyaltycardtransactions) | **GET** /v1/loyalties/members/{memberId}/transactions | List Loyalty Card Transactions | -| *LoyaltiesApi* | [**ListLoyaltyCardTransactions1**](docs/LoyaltiesApi.md#listloyaltycardtransactions1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/transactions | List Loyalty Card Transactions with campaign ID | -| *LoyaltiesApi* | [**ListLoyaltyPrograms**](docs/LoyaltiesApi.md#listloyaltyprograms) | **GET** /v1/loyalties | List Loyalty Campaigns | -| *LoyaltiesApi* | [**ListLoyaltyTierEarningRules**](docs/LoyaltiesApi.md#listloyaltytierearningrules) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules | List Loyalty Tier Earning Rules | -| *LoyaltiesApi* | [**ListLoyaltyTierRewards**](docs/LoyaltiesApi.md#listloyaltytierrewards) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards | List Loyalty Tier Rewards | -| *LoyaltiesApi* | [**ListLoyaltyTiers**](docs/LoyaltiesApi.md#listloyaltytiers) | **GET** /v1/loyalties/{campaignId}/tiers | List Loyalty Tiers | -| *LoyaltiesApi* | [**ListMemberActivity**](docs/LoyaltiesApi.md#listmemberactivity) | **GET** /v1/loyalties/members/{memberId}/activity | List Member Activity | -| *LoyaltiesApi* | [**ListMemberActivity1**](docs/LoyaltiesApi.md#listmemberactivity1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/activity | List Member Activity with campaign ID | -| *LoyaltiesApi* | [**ListMemberLoyaltyTier**](docs/LoyaltiesApi.md#listmemberloyaltytier) | **GET** /v1/loyalties/members/{memberId}/tiers | List Member's Loyalty Tiers | -| *LoyaltiesApi* | [**ListMemberPendingPoints**](docs/LoyaltiesApi.md#listmemberpendingpoints) | **GET** /v1/loyalties/members/{memberId}/pending-points | List Member Pending Points | -| *LoyaltiesApi* | [**ListMemberPendingPoints1**](docs/LoyaltiesApi.md#listmemberpendingpoints1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/pending-points | List Member Pending Points with campaign ID | -| *LoyaltiesApi* | [**ListMemberRewards**](docs/LoyaltiesApi.md#listmemberrewards) | **GET** /v1/loyalties/members/{memberId}/rewards | List Member Rewards | -| *LoyaltiesApi* | [**ListMembers**](docs/LoyaltiesApi.md#listmembers) | **GET** /v1/loyalties/{campaignId}/members | List Members | -| *LoyaltiesApi* | [**ListPointsExpiration**](docs/LoyaltiesApi.md#listpointsexpiration) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | List Loyalty Card Point Expiration | -| *LoyaltiesApi* | [**ListRewardAssignments1**](docs/LoyaltiesApi.md#listrewardassignments1) | **GET** /v1/loyalties/{campaignId}/reward-assignments | List Reward Assignments with campaign ID | -| *LoyaltiesApi* | [**ListRewardAssignments2**](docs/LoyaltiesApi.md#listrewardassignments2) | **GET** /v1/loyalties/{campaignId}/rewards | List Campaign Rewards | -| *LoyaltiesApi* | [**RedeemReward**](docs/LoyaltiesApi.md#redeemreward) | **POST** /v1/loyalties/members/{memberId}/redemption | Redeem Reward | -| *LoyaltiesApi* | [**RedeemReward1**](docs/LoyaltiesApi.md#redeemreward1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/redemption | Redeem Reward with campaign ID | -| *LoyaltiesApi* | [**TransferPoints**](docs/LoyaltiesApi.md#transferpoints) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/transfers | Transfer Loyalty Points | -| *LoyaltiesApi* | [**UpdateEarningRule**](docs/LoyaltiesApi.md#updateearningrule) | **PUT** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Update Earning Rule | -| *LoyaltiesApi* | [**UpdateLoyaltyCardBalance**](docs/LoyaltiesApi.md#updateloyaltycardbalance) | **POST** /v1/loyalties/members/{memberId}/balance | Adjust Loyalty Card Balance | -| *LoyaltiesApi* | [**UpdateLoyaltyCardBalance1**](docs/LoyaltiesApi.md#updateloyaltycardbalance1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/balance | Adjust Loyalty Card Balance with campaign ID | -| *LoyaltiesApi* | [**UpdateLoyaltyProgram**](docs/LoyaltiesApi.md#updateloyaltyprogram) | **PUT** /v1/loyalties/{campaignId} | Update Loyalty Campaign | -| *LoyaltiesApi* | [**UpdateRewardAssignment1**](docs/LoyaltiesApi.md#updaterewardassignment1) | **PUT** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Update Campaign Reward Assignment | -| *ManagementApi* | [**AssignUser**](docs/ManagementApi.md#assignuser) | **POST** /management/v1/projects/{projectId}/users | Assign User | -| *ManagementApi* | [**CreateBrand**](docs/ManagementApi.md#createbrand) | **POST** /management/v1/projects/{projectId}/branding | Create Brand | -| *ManagementApi* | [**CreateCustomEventSchema**](docs/ManagementApi.md#createcustomeventschema) | **POST** /management/v1/projects/{projectId}/custom-event-schemas | Create Custom Event Schema | -| *ManagementApi* | [**CreateMetadataSchema**](docs/ManagementApi.md#createmetadataschema) | **POST** /management/v1/projects/{projectId}/metadata-schemas | Create Metadata Schema | -| *ManagementApi* | [**CreateProject**](docs/ManagementApi.md#createproject) | **POST** /management/v1/projects | Create Project | -| *ManagementApi* | [**CreateStackingRules**](docs/ManagementApi.md#createstackingrules) | **POST** /management/v1/projects/{projectId}/stacking-rules | Create Stacking Rules | -| *ManagementApi* | [**CreateWebhook**](docs/ManagementApi.md#createwebhook) | **POST** /management/v1/projects/{projectId}/webhooks | Create Webhook | -| *ManagementApi* | [**DeleteBrand**](docs/ManagementApi.md#deletebrand) | **DELETE** /management/v1/projects/{projectId}/branding/{brandingId} | Delete Brand | -| *ManagementApi* | [**DeleteCustomEventSchema**](docs/ManagementApi.md#deletecustomeventschema) | **DELETE** /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | Delete Custom Event Schema | -| *ManagementApi* | [**DeleteMetadataSchema**](docs/ManagementApi.md#deletemetadataschema) | **DELETE** /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | Delete Metadata Schema | -| *ManagementApi* | [**DeleteProject**](docs/ManagementApi.md#deleteproject) | **DELETE** /management/v1/projects/{projectId} | Delete Project | -| *ManagementApi* | [**DeleteStackingRules**](docs/ManagementApi.md#deletestackingrules) | **DELETE** /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | Delete Stacking Rules | -| *ManagementApi* | [**DeleteWebhook**](docs/ManagementApi.md#deletewebhook) | **DELETE** /management/v1/projects/{projectId}/webhooks/{webhookId} | Delete Webhook | -| *ManagementApi* | [**GetBrand**](docs/ManagementApi.md#getbrand) | **GET** /management/v1/projects/{projectId}/branding/{brandingId} | Get Brand | -| *ManagementApi* | [**GetCustomEventSchema**](docs/ManagementApi.md#getcustomeventschema) | **GET** /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | Get Custom Event Schema | -| *ManagementApi* | [**GetMetadataSchema1**](docs/ManagementApi.md#getmetadataschema1) | **GET** /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | Get Metadata Schema | -| *ManagementApi* | [**GetProject**](docs/ManagementApi.md#getproject) | **GET** /management/v1/projects/{projectId} | Get Project | -| *ManagementApi* | [**GetStackingRules**](docs/ManagementApi.md#getstackingrules) | **GET** /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | Get Stacking Rules | -| *ManagementApi* | [**GetUser**](docs/ManagementApi.md#getuser) | **GET** /management/v1/projects/{projectId}/users/{userId} | Get User | -| *ManagementApi* | [**GetWebhook**](docs/ManagementApi.md#getwebhook) | **GET** /management/v1/projects/{projectId}/webhooks/{webhookId} | Get Webhook | -| *ManagementApi* | [**InviteUser**](docs/ManagementApi.md#inviteuser) | **POST** /management/v1/projects/users/invite | Invite a New User | -| *ManagementApi* | [**ListBrands**](docs/ManagementApi.md#listbrands) | **GET** /management/v1/projects/{projectId}/branding | List Brands | -| *ManagementApi* | [**ListCustomEventSchemas**](docs/ManagementApi.md#listcustomeventschemas) | **GET** /management/v1/projects/{projectId}/custom-event-schemas | List Custom Event Schemas | -| *ManagementApi* | [**ListMetadataSchemas1**](docs/ManagementApi.md#listmetadataschemas1) | **GET** /management/v1/projects/{projectId}/metadata-schemas | List Metadata Schemas | -| *ManagementApi* | [**ListProjects**](docs/ManagementApi.md#listprojects) | **GET** /management/v1/projects | List Projects | -| *ManagementApi* | [**ListStackingRules**](docs/ManagementApi.md#liststackingrules) | **GET** /management/v1/projects/{projectId}/stacking-rules | List Stacking Rules | -| *ManagementApi* | [**ListUsers**](docs/ManagementApi.md#listusers) | **GET** /management/v1/projects/{projectId}/users | List Users | -| *ManagementApi* | [**ListWebhooks**](docs/ManagementApi.md#listwebhooks) | **GET** /management/v1/projects/{projectId}/webhooks | List Webhooks | -| *ManagementApi* | [**ManagementCopyCampaignTemplate**](docs/ManagementApi.md#managementcopycampaigntemplate) | **POST** /management/v1/projects/{projectId}/templates/campaigns/{campaignTemplateId}/copy | Copy Campaign Template to a Project | -| *ManagementApi* | [**ManagementListCampaignTemplates**](docs/ManagementApi.md#managementlistcampaigntemplates) | **GET** /management/v1/projects/{projectId}/templates/campaigns | List Campaign Templates | -| *ManagementApi* | [**UnassignUser**](docs/ManagementApi.md#unassignuser) | **DELETE** /management/v1/projects/{projectId}/users/{userId} | Unassign User | -| *ManagementApi* | [**UpdateBrand**](docs/ManagementApi.md#updatebrand) | **PUT** /management/v1/projects/{projectId}/branding/{brandingId} | Update Brand | -| *ManagementApi* | [**UpdateCustomEventSchema**](docs/ManagementApi.md#updatecustomeventschema) | **PUT** /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | Update Custom Event Schema | -| *ManagementApi* | [**UpdateMetadataSchema**](docs/ManagementApi.md#updatemetadataschema) | **PUT** /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | Update Metadata Schema | -| *ManagementApi* | [**UpdateProject**](docs/ManagementApi.md#updateproject) | **PUT** /management/v1/projects/{projectId} | Update Project | -| *ManagementApi* | [**UpdateStackingRules**](docs/ManagementApi.md#updatestackingrules) | **PUT** /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | Update Stacking Rules | -| *ManagementApi* | [**UpdateUser**](docs/ManagementApi.md#updateuser) | **PUT** /management/v1/projects/{projectId}/users/{userId} | Update User | -| *ManagementApi* | [**UpdateWebhook**](docs/ManagementApi.md#updatewebhook) | **PUT** /management/v1/projects/{projectId}/webhooks/{webhookId} | Update Webhook | -| *MetadataSchemasApi* | [**GetMetadataSchema**](docs/MetadataSchemasApi.md#getmetadataschema) | **GET** /v1/metadata-schemas/{resource} | Get Metadata Schema | -| *MetadataSchemasApi* | [**ListMetadataSchemas**](docs/MetadataSchemasApi.md#listmetadataschemas) | **GET** /v1/metadata-schemas | List Metadata Schema Definitions | -| *OAuthApi* | [**GenerateOauthToken**](docs/OAuthApi.md#generateoauthtoken) | **POST** /v1/oauth/token | Generate OAuth 2.0 Token | -| *OAuthApi* | [**IntrospectOauthToken**](docs/OAuthApi.md#introspectoauthtoken) | **POST** /v1/oauth/introspect | Introspect OAuth 2.0 Token | -| *OAuthApi* | [**RevokeOauthToken**](docs/OAuthApi.md#revokeoauthtoken) | **POST** /v1/oauth/token/revoke | Revoke OAuth 2.0 Token | -| *OrdersApi* | [**CreateOrder**](docs/OrdersApi.md#createorder) | **POST** /v1/orders | Create Order | -| *OrdersApi* | [**CreateOrderExport**](docs/OrdersApi.md#createorderexport) | **POST** /v1/orders/export | Create Orders Export | -| *OrdersApi* | [**GetOrder**](docs/OrdersApi.md#getorder) | **GET** /v1/orders/{orderId} | Get Order | -| *OrdersApi* | [**ImportOrders**](docs/OrdersApi.md#importorders) | **POST** /v1/orders/import | Import Orders | -| *OrdersApi* | [**ListOrders**](docs/OrdersApi.md#listorders) | **GET** /v1/orders | List Orders | -| *OrdersApi* | [**UpdateOrder**](docs/OrdersApi.md#updateorder) | **PUT** /v1/orders/{orderId} | Update Order | -| *ProductCollectionsApi* | [**CreateProductCollection**](docs/ProductCollectionsApi.md#createproductcollection) | **POST** /v1/product-collections | Create Product Collection | -| *ProductCollectionsApi* | [**DeleteProductCollection**](docs/ProductCollectionsApi.md#deleteproductcollection) | **DELETE** /v1/product-collections/{productCollectionId} | Delete Product Collection | -| *ProductCollectionsApi* | [**GetProductCollection**](docs/ProductCollectionsApi.md#getproductcollection) | **GET** /v1/product-collections/{productCollectionId} | Get Product Collection | -| *ProductCollectionsApi* | [**ListProductCollections**](docs/ProductCollectionsApi.md#listproductcollections) | **GET** /v1/product-collections | List Product Collections | -| *ProductCollectionsApi* | [**ListProductsInCollection**](docs/ProductCollectionsApi.md#listproductsincollection) | **GET** /v1/product-collections/{productCollectionId}/products | List Products in Collection | -| *ProductsApi* | [**CreateProduct**](docs/ProductsApi.md#createproduct) | **POST** /v1/products | Create Product | -| *ProductsApi* | [**CreateSku**](docs/ProductsApi.md#createsku) | **POST** /v1/products/{productId}/skus | Create SKU | -| *ProductsApi* | [**DeleteProduct**](docs/ProductsApi.md#deleteproduct) | **DELETE** /v1/products/{productId} | Delete Product | -| *ProductsApi* | [**DeleteSku**](docs/ProductsApi.md#deletesku) | **DELETE** /v1/products/{productId}/skus/{skuId} | Delete SKU | -| *ProductsApi* | [**GetProduct**](docs/ProductsApi.md#getproduct) | **GET** /v1/products/{productId} | Get Product | -| *ProductsApi* | [**GetSku**](docs/ProductsApi.md#getsku) | **GET** /v1/skus/{skuId} | Get SKU | -| *ProductsApi* | [**ImportProductsUsingCsv**](docs/ProductsApi.md#importproductsusingcsv) | **POST** /v1/products/importCSV | Import Products using CSV | -| *ProductsApi* | [**ImportSKUsUsingCsv**](docs/ProductsApi.md#importskususingcsv) | **POST** /v1/skus/importCSV | Import SKUs using CSV | -| *ProductsApi* | [**ListProducts**](docs/ProductsApi.md#listproducts) | **GET** /v1/products | List Products | -| *ProductsApi* | [**ListSKUsInProduct**](docs/ProductsApi.md#listskusinproduct) | **GET** /v1/products/{productId}/skus | List SKUs in Product | -| *ProductsApi* | [**UpdateProduct**](docs/ProductsApi.md#updateproduct) | **PUT** /v1/products/{productId} | Update Product | -| *ProductsApi* | [**UpdateProductsInBulk**](docs/ProductsApi.md#updateproductsinbulk) | **POST** /v1/products/bulk/async | Update Products in Bulk | -| *ProductsApi* | [**UpdateProductsMetadataInBulk**](docs/ProductsApi.md#updateproductsmetadatainbulk) | **POST** /v1/products/metadata/async | Update Products' Metadata in Bulk | -| *ProductsApi* | [**UpdateSku**](docs/ProductsApi.md#updatesku) | **PUT** /v1/products/{productId}/skus/{skuId} | Update SKU | -| *PromotionsApi* | [**AddPromotionTierToCampaign**](docs/PromotionsApi.md#addpromotiontiertocampaign) | **POST** /v1/promotions/{campaignId}/tiers | Add Promotion Tier to Campaign | -| *PromotionsApi* | [**CreatePromotionStack**](docs/PromotionsApi.md#createpromotionstack) | **POST** /v1/promotions/{campaignId}/stacks | Create Promotion Stack | -| *PromotionsApi* | [**DeletePromotionStack**](docs/PromotionsApi.md#deletepromotionstack) | **DELETE** /v1/promotions/{campaignId}/stacks/{stackId} | Delete Promotion Stack | -| *PromotionsApi* | [**DeletePromotionTier**](docs/PromotionsApi.md#deletepromotiontier) | **DELETE** /v1/promotions/tiers/{promotionTierId} | Delete Promotion Tier | -| *PromotionsApi* | [**DisablePromotionTier**](docs/PromotionsApi.md#disablepromotiontier) | **POST** /v1/promotions/tiers/{promotionTierId}/disable | Disable Promotion Tier | -| *PromotionsApi* | [**EnablePromotionTier**](docs/PromotionsApi.md#enablepromotiontier) | **POST** /v1/promotions/tiers/{promotionTierId}/enable | Enable Promotion Tier | -| *PromotionsApi* | [**GetPromotionStack**](docs/PromotionsApi.md#getpromotionstack) | **GET** /v1/promotions/{campaignId}/stacks/{stackId} | Get Promotion Stack | -| *PromotionsApi* | [**GetPromotionTier**](docs/PromotionsApi.md#getpromotiontier) | **GET** /v1/promotions/tiers/{promotionTierId} | Get Promotion Tier | -| *PromotionsApi* | [**ListAllPromotionStacks**](docs/PromotionsApi.md#listallpromotionstacks) | **GET** /v1/promotions/stacks | List Promotion Stacks | -| *PromotionsApi* | [**ListPromotionStacksInCampaign**](docs/PromotionsApi.md#listpromotionstacksincampaign) | **GET** /v1/promotions/{campaignId}/stacks | List Promotion Stacks in Campaign | -| *PromotionsApi* | [**ListPromotionTiers**](docs/PromotionsApi.md#listpromotiontiers) | **GET** /v1/promotions/tiers | List Promotion Tiers | -| *PromotionsApi* | [**ListPromotionTiersFromCampaign**](docs/PromotionsApi.md#listpromotiontiersfromcampaign) | **GET** /v1/promotions/{campaignId}/tiers | List Promotion Tiers from Campaign | -| *PromotionsApi* | [**UpdatePromotionStack**](docs/PromotionsApi.md#updatepromotionstack) | **PUT** /v1/promotions/{campaignId}/stacks/{stackId} | Update Promotion Stack | -| *PromotionsApi* | [**UpdatePromotionTier**](docs/PromotionsApi.md#updatepromotiontier) | **PUT** /v1/promotions/tiers/{promotionTierId} | Update Promotion Tier | -| *PublicationsApi* | [**CreatePublication**](docs/PublicationsApi.md#createpublication) | **POST** /v1/publications | Create Publication | -| *PublicationsApi* | [**CreatePublication1**](docs/PublicationsApi.md#createpublication1) | **GET** /v1/publications/create | Create Publication with GET | -| *PublicationsApi* | [**ListPublications**](docs/PublicationsApi.md#listpublications) | **GET** /v1/publications | List Publications | -| *QualificationsApi* | [**CheckEligibility**](docs/QualificationsApi.md#checkeligibility) | **POST** /v1/qualifications | Check Eligibility | -| *RedemptionsApi* | [**GetRedemption**](docs/RedemptionsApi.md#getredemption) | **GET** /v1/redemptions/{redemptionId} | Get Redemption | -| *RedemptionsApi* | [**GetVoucherRedemptions**](docs/RedemptionsApi.md#getvoucherredemptions) | **GET** /v1/vouchers/{code}/redemption | Get Voucher's Redemptions | -| *RedemptionsApi* | [**ListRedemptions**](docs/RedemptionsApi.md#listredemptions) | **GET** /v1/redemptions | List Redemptions | -| *RedemptionsApi* | [**RedeemStackedDiscounts**](docs/RedemptionsApi.md#redeemstackeddiscounts) | **POST** /v1/redemptions | Redeem Stackable Discounts | -| *RedemptionsApi* | [**RollbackRedemption**](docs/RedemptionsApi.md#rollbackredemption) | **POST** /v1/redemptions/{redemptionId}/rollback | Rollback Redemption | -| *RedemptionsApi* | [**RollbackStackedRedemptions**](docs/RedemptionsApi.md#rollbackstackedredemptions) | **POST** /v1/redemptions/{parentRedemptionId}/rollbacks | Rollback Stackable Redemptions | -| *ReferralsApi* | [**ReferralsAddHolders**](docs/ReferralsApi.md#referralsaddholders) | **POST** /v1/referrals/members/{memberId}/holders | Add Referral Code Holders | -| *ReferralsApi* | [**ReferralsAddHolders1**](docs/ReferralsApi.md#referralsaddholders1) | **POST** /v1/referrals/{campaignId}/members/{memberId}/holders | Add Referral Code Holders with Campaign ID | -| *ReferralsApi* | [**ReferralsCodeHolders**](docs/ReferralsApi.md#referralscodeholders) | **GET** /v1/referrals/{campaignId}/members/{memberId}/holders | List Referral Code Holders with campaign ID | -| *ReferralsApi* | [**ReferralsCodeHolders1**](docs/ReferralsApi.md#referralscodeholders1) | **GET** /v1/referrals/members/{memberId}/holders | List Referral Code Holders | -| *ReferralsApi* | [**ReferralsRemoveHolder**](docs/ReferralsApi.md#referralsremoveholder) | **DELETE** /v1/referrals/members/{memberId}/holders/{holderId} | Remove Referral Card Holder | -| *ReferralsApi* | [**ReferralsRemoveHolder1**](docs/ReferralsApi.md#referralsremoveholder1) | **DELETE** /v1/referrals/{campaignId}/members/{memberId}/holders/{holderId} | Remove Referral Card Holder with campaign ID | -| *RewardsApi* | [**CreateReward**](docs/RewardsApi.md#createreward) | **POST** /v1/rewards | Create Reward | -| *RewardsApi* | [**CreateRewardAssignment**](docs/RewardsApi.md#createrewardassignment) | **POST** /v1/rewards/{rewardId}/assignments | Create Reward Assignment | -| *RewardsApi* | [**DeleteReward**](docs/RewardsApi.md#deletereward) | **DELETE** /v1/rewards/{rewardId} | Delete Reward | -| *RewardsApi* | [**DeleteRewardAssignment**](docs/RewardsApi.md#deleterewardassignment) | **DELETE** /v1/rewards/{rewardId}/assignments/{assignmentId} | Delete Reward Assignment | -| *RewardsApi* | [**GetReward**](docs/RewardsApi.md#getreward) | **GET** /v1/rewards/{rewardId} | Get Reward | -| *RewardsApi* | [**GetRewardAssignment**](docs/RewardsApi.md#getrewardassignment) | **GET** /v1/rewards/{rewardId}/assignments/{assignmentId} | Get Reward Assignment | -| *RewardsApi* | [**ListRewardAssignments**](docs/RewardsApi.md#listrewardassignments) | **GET** /v1/rewards/{rewardId}/assignments | List Reward Assignments | -| *RewardsApi* | [**ListRewards**](docs/RewardsApi.md#listrewards) | **GET** /v1/rewards | List Rewards | -| *RewardsApi* | [**UpdateReward**](docs/RewardsApi.md#updatereward) | **PUT** /v1/rewards/{rewardId} | Update Reward | -| *RewardsApi* | [**UpdateRewardAssignment**](docs/RewardsApi.md#updaterewardassignment) | **PUT** /v1/rewards/{rewardId}/assignments/{assignmentId} | Update Reward Assignment | -| *SegmentsApi* | [**CreateSegment**](docs/SegmentsApi.md#createsegment) | **POST** /v1/segments | Create Segment | -| *SegmentsApi* | [**DeleteSegment**](docs/SegmentsApi.md#deletesegment) | **DELETE** /v1/segments/{segmentId} | Delete Segment | -| *SegmentsApi* | [**GetSegment**](docs/SegmentsApi.md#getsegment) | **GET** /v1/segments/{segmentId} | Get Segment | -| *TemplatesApi* | [**AddTierFromTemplate**](docs/TemplatesApi.md#addtierfromtemplate) | **POST** /v1/templates/campaigns/{campaignTemplateId}/tier-setup | Add Promotion Tier From Template | -| *TemplatesApi* | [**CreateCampaignFromTemplate**](docs/TemplatesApi.md#createcampaignfromtemplate) | **POST** /v1/templates/campaigns/{campaignTemplateId}/campaign-setup | Create Campaign From Template | -| *TemplatesApi* | [**CreateCampaignTemplate**](docs/TemplatesApi.md#createcampaigntemplate) | **POST** /v1/templates/campaigns | Create Campaign Template | -| *TemplatesApi* | [**DeleteCampaignTemplate**](docs/TemplatesApi.md#deletecampaigntemplate) | **DELETE** /v1/templates/campaigns/{campaignTemplateId} | Delete Campaign Template | -| *TemplatesApi* | [**GetCampaignTemplate**](docs/TemplatesApi.md#getcampaigntemplate) | **GET** /v1/templates/campaigns/{campaignTemplateId} | Get Campaign Template | -| *TemplatesApi* | [**ListCampaignTemplates**](docs/TemplatesApi.md#listcampaigntemplates) | **GET** /v1/templates/campaigns | List Campaign Templates | -| *TemplatesApi* | [**UpdateCampaignTemplate**](docs/TemplatesApi.md#updatecampaigntemplate) | **PUT** /v1/templates/campaigns/{campaignTemplateId} | Update Campaign Template | -| *ValidationRulesApi* | [**CreateValidationRuleAssignment**](docs/ValidationRulesApi.md#createvalidationruleassignment) | **POST** /v1/validation-rules/{validationRuleId}/assignments | Create Validation Rules Assignments | -| *ValidationRulesApi* | [**CreateValidationRules**](docs/ValidationRulesApi.md#createvalidationrules) | **POST** /v1/validation-rules | Create Validation Rules | -| *ValidationRulesApi* | [**DeleteValidationRuleAssignment**](docs/ValidationRulesApi.md#deletevalidationruleassignment) | **DELETE** /v1/validation-rules/{validationRuleId}/assignments/{assignmentId} | Delete Validation Rule Assignment | -| *ValidationRulesApi* | [**DeleteValidationRules**](docs/ValidationRulesApi.md#deletevalidationrules) | **DELETE** /v1/validation-rules/{validationRuleId} | Delete Validation Rule | -| *ValidationRulesApi* | [**GetValidationRule**](docs/ValidationRulesApi.md#getvalidationrule) | **GET** /v1/validation-rules/{validationRuleId} | Get Validation Rule | -| *ValidationRulesApi* | [**ListValidationRuleAssignments**](docs/ValidationRulesApi.md#listvalidationruleassignments) | **GET** /v1/validation-rules/{validationRuleId}/assignments | List Validation Rule Assignments | -| *ValidationRulesApi* | [**ListValidationRules**](docs/ValidationRulesApi.md#listvalidationrules) | **GET** /v1/validation-rules | List Validation Rules | -| *ValidationRulesApi* | [**ListValidationRulesAssignments**](docs/ValidationRulesApi.md#listvalidationrulesassignments) | **GET** /v1/validation-rules-assignments | List Validation Rules' Assignment(s) | -| *ValidationRulesApi* | [**UpdateValidationRule**](docs/ValidationRulesApi.md#updatevalidationrule) | **PUT** /v1/validation-rules/{validationRuleId} | Update Validation Rule | -| *ValidationsApi* | [**ValidateStackedDiscounts**](docs/ValidationsApi.md#validatestackeddiscounts) | **POST** /v1/validations | Validate Stackable Discounts | -| *VouchersApi* | [**CreateVoucher**](docs/VouchersApi.md#createvoucher) | **POST** /v1/vouchers/{code} | Create Voucher | -| *VouchersApi* | [**DeleteVoucher**](docs/VouchersApi.md#deletevoucher) | **DELETE** /v1/vouchers/{code} | Delete Voucher | -| *VouchersApi* | [**DisableVoucher**](docs/VouchersApi.md#disablevoucher) | **POST** /v1/vouchers/{code}/disable | Disable Voucher | -| *VouchersApi* | [**EnableVoucher**](docs/VouchersApi.md#enablevoucher) | **POST** /v1/vouchers/{code}/enable | Enable Voucher | -| *VouchersApi* | [**ExportVoucherTransactions**](docs/VouchersApi.md#exportvouchertransactions) | **POST** /v1/vouchers/{code}/transactions/export | Export Voucher Transactions | -| *VouchersApi* | [**GenerateRandomCode**](docs/VouchersApi.md#generaterandomcode) | **POST** /v1/vouchers | Generate Random Code | -| *VouchersApi* | [**GetVoucher**](docs/VouchersApi.md#getvoucher) | **GET** /v1/vouchers/{code} | Get Voucher | -| *VouchersApi* | [**ImportVouchers**](docs/VouchersApi.md#importvouchers) | **POST** /v1/vouchers/import | Import Vouchers | -| *VouchersApi* | [**ImportVouchersUsingCsv**](docs/VouchersApi.md#importvouchersusingcsv) | **POST** /v1/vouchers/importCSV | Import Vouchers using CSV | -| *VouchersApi* | [**ListVoucherTransactions**](docs/VouchersApi.md#listvouchertransactions) | **GET** /v1/vouchers/{code}/transactions | List Voucher Transactions | -| *VouchersApi* | [**ListVouchers**](docs/VouchersApi.md#listvouchers) | **GET** /v1/vouchers | List Vouchers | -| *VouchersApi* | [**ReleaseValidationSession**](docs/VouchersApi.md#releasevalidationsession) | **DELETE** /v1/vouchers/{code}/sessions/{sessionKey} | Release Validation Session | -| *VouchersApi* | [**UpdateVoucher**](docs/VouchersApi.md#updatevoucher) | **PUT** /v1/vouchers/{code} | Update Voucher | -| *VouchersApi* | [**UpdateVoucherBalance**](docs/VouchersApi.md#updatevoucherbalance) | **POST** /v1/vouchers/{code}/balance | Adjust Voucher Balance | -| *VouchersApi* | [**UpdateVouchersInBulk**](docs/VouchersApi.md#updatevouchersinbulk) | **POST** /v1/vouchers/bulk/async | Update Vouchers in Bulk | -| *VouchersApi* | [**UpdateVouchersMetadataInBulk**](docs/VouchersApi.md#updatevouchersmetadatainbulk) | **POST** /v1/vouchers/metadata/async | Update Vouchers' Metadata in Bulk | - - -## πŸ“š Documentation of models +## Documentation of API endpoints + +All URIs are relative to *https://api.voucherify.io* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*AsyncActionsApi* | [**GetAsyncAction**](docs/AsyncActionsApi.md#getasyncaction) | **GET** /v1/async-actions/{asyncActionId} | Get Async Action +*AsyncActionsApi* | [**ListAsyncActions**](docs/AsyncActionsApi.md#listasyncactions) | **GET** /v1/async-actions | List Async Actions +*BinApi* | [**DeleteBinEntry**](docs/BinApi.md#deletebinentry) | **DELETE** /v1/trash-bin/{binEntryId} | Delete Bin Entry +*BinApi* | [**ListBinEntries**](docs/BinApi.md#listbinentries) | **GET** /v1/trash-bin | List Bin Entries +*CampaignsApi* | [**AddVoucherWithSpecificCodeToCampaign**](docs/CampaignsApi.md#addvoucherwithspecificcodetocampaign) | **POST** /v1/campaigns/{campaignId}/vouchers/{code} | Add Voucher with Specific Code to Campaign +*CampaignsApi* | [**AddVouchersToCampaign**](docs/CampaignsApi.md#addvoucherstocampaign) | **POST** /v1/campaigns/{campaignId}/vouchers | Add Vouchers to Campaign +*CampaignsApi* | [**CreateCampaign**](docs/CampaignsApi.md#createcampaign) | **POST** /v1/campaigns | Create Campaign +*CampaignsApi* | [**DeleteCampaign**](docs/CampaignsApi.md#deletecampaign) | **DELETE** /v1/campaigns/{campaignId} | Delete Campaign +*CampaignsApi* | [**DisableCampaign**](docs/CampaignsApi.md#disablecampaign) | **POST** /v1/campaigns/{campaignId}/disable | Disable Campaign +*CampaignsApi* | [**EnableCampaign**](docs/CampaignsApi.md#enablecampaign) | **POST** /v1/campaigns/{campaignId}/enable | Enable Campaign +*CampaignsApi* | [**ExportCampaignTransactions**](docs/CampaignsApi.md#exportcampaigntransactions) | **POST** /v1/campaigns/{campaignId}/transactions/export | Export Campaign Transactions +*CampaignsApi* | [**GetCampaign**](docs/CampaignsApi.md#getcampaign) | **GET** /v1/campaigns/{campaignId} | Get Campaign +*CampaignsApi* | [**GetCampaignSummary**](docs/CampaignsApi.md#getcampaignsummary) | **GET** /v1/campaigns/{campaignId}/summary | Get Campaign Summary +*CampaignsApi* | [**ImportVouchersToCampaign**](docs/CampaignsApi.md#importvoucherstocampaign) | **POST** /v1/campaigns/{campaignId}/import | Import Vouchers to Campaign +*CampaignsApi* | [**ImportVouchersToCampaignUsingCsv**](docs/CampaignsApi.md#importvoucherstocampaignusingcsv) | **POST** /v1/campaigns/{campaignId}/importCSV | Import Vouchers to Campaign by CSV +*CampaignsApi* | [**ListCampaignTransactions**](docs/CampaignsApi.md#listcampaigntransactions) | **GET** /v1/campaigns/{campaignId}/transactions | List Campaign Transactions +*CampaignsApi* | [**ListCampaigns**](docs/CampaignsApi.md#listcampaigns) | **GET** /v1/campaigns | List Campaigns +*CampaignsApi* | [**UpdateCampaign**](docs/CampaignsApi.md#updatecampaign) | **PUT** /v1/campaigns/{campaignId} | Update Campaign +*CategoriesApi* | [**CreateCategory**](docs/CategoriesApi.md#createcategory) | **POST** /v1/categories | Create Category +*CategoriesApi* | [**DeleteCategory**](docs/CategoriesApi.md#deletecategory) | **DELETE** /v1/categories/{categoryId} | Delete Category +*CategoriesApi* | [**GetCategory**](docs/CategoriesApi.md#getcategory) | **GET** /v1/categories/{categoryId} | Get Category +*CategoriesApi* | [**ListCategories**](docs/CategoriesApi.md#listcategories) | **GET** /v1/categories | List Categories +*CategoriesApi* | [**UpdateCategory**](docs/CategoriesApi.md#updatecategory) | **PUT** /v1/categories/{categoryId} | Update Category +*ClientSideApi* | [**CheckEligibilityClientSide**](docs/ClientSideApi.md#checkeligibilityclientside) | **POST** /client/v1/qualifications | Check Eligibility (client-side) +*ClientSideApi* | [**ListPromotionTiersClientSide**](docs/ClientSideApi.md#listpromotiontiersclientside) | **GET** /client/v1/promotions/tiers | List Promotion Tiers (client-side) +*ClientSideApi* | [**RedeemStackedDiscountsClientSide**](docs/ClientSideApi.md#redeemstackeddiscountsclientside) | **POST** /client/v1/redemptions | Redeem Stackable Discounts (client-side) +*ClientSideApi* | [**TrackCustomEventClientSide**](docs/ClientSideApi.md#trackcustomeventclientside) | **POST** /client/v1/events | Track Custom Event (client-side) +*ClientSideApi* | [**ValidateStackedDiscountsClientSide**](docs/ClientSideApi.md#validatestackeddiscountsclientside) | **POST** /client/v1/validations | Validate Stackable Discounts (client-side) +*CustomersApi* | [**CreateCustomer**](docs/CustomersApi.md#createcustomer) | **POST** /v1/customers | Create Customer +*CustomersApi* | [**CustomerPermanentlyDeletion**](docs/CustomersApi.md#customerpermanentlydeletion) | **POST** /v1/customers/{customerId}/permanent-deletion | Delete Customer Permanently +*CustomersApi* | [**DeleteCustomer**](docs/CustomersApi.md#deletecustomer) | **DELETE** /v1/customers/{customerId} | Delete Customer +*CustomersApi* | [**GetCustomer**](docs/CustomersApi.md#getcustomer) | **GET** /v1/customers/{customerId} | Get Customer +*CustomersApi* | [**ImportCustomersUsingCsv**](docs/CustomersApi.md#importcustomersusingcsv) | **POST** /v1/customers/importCSV | Import and Update Customers using CSV +*CustomersApi* | [**ListCustomerActivity**](docs/CustomersApi.md#listcustomeractivity) | **GET** /v1/customers/{customerId}/activity | List Customer Activity +*CustomersApi* | [**ListCustomerRedeemables**](docs/CustomersApi.md#listcustomerredeemables) | **GET** /v1/customers/{customerId}/redeemables | List Customer's Redeemables +*CustomersApi* | [**ListCustomerSegments**](docs/CustomersApi.md#listcustomersegments) | **GET** /v1/customers/{customerId}/segments | List Customer's Segments +*CustomersApi* | [**ListCustomers**](docs/CustomersApi.md#listcustomers) | **GET** /v1/customers | List Customers +*CustomersApi* | [**UpdateCustomer**](docs/CustomersApi.md#updatecustomer) | **PUT** /v1/customers/{customerId} | Update Customer +*CustomersApi* | [**UpdateCustomersInBulk**](docs/CustomersApi.md#updatecustomersinbulk) | **POST** /v1/customers/bulk/async | Update Customers in Bulk +*CustomersApi* | [**UpdateCustomersMetadataInBulk**](docs/CustomersApi.md#updatecustomersmetadatainbulk) | **POST** /v1/customers/metadata/async | Update Customers' Metadata in Bulk +*EventsApi* | [**TrackCustomEvent**](docs/EventsApi.md#trackcustomevent) | **POST** /v1/events | Track Custom Event +*ExportsApi* | [**CreateExport**](docs/ExportsApi.md#createexport) | **POST** /v1/exports | Create Export +*ExportsApi* | [**DeleteExport**](docs/ExportsApi.md#deleteexport) | **DELETE** /v1/exports/{exportId} | Delete Export +*ExportsApi* | [**DownloadExport**](docs/ExportsApi.md#downloadexport) | **GET** /v1/exports/{export_Id} | Download Export +*ExportsApi* | [**GetExport**](docs/ExportsApi.md#getexport) | **GET** /v1/exports/{exportId} | Get Export +*ExportsApi* | [**ListExports**](docs/ExportsApi.md#listexports) | **GET** /v1/exports | List Exports +*LocationsApi* | [**GetLocation**](docs/LocationsApi.md#getlocation) | **GET** /v1/locations/{locationId} | Get Location +*LocationsApi* | [**ListLocations**](docs/LocationsApi.md#listlocations) | **GET** /v1/locations | List Locations +*LoyaltiesApi* | [**ActivateMemberPendingPoints**](docs/LoyaltiesApi.md#activatememberpendingpoints) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate | Activate Member Pending Points +*LoyaltiesApi* | [**AddMember**](docs/LoyaltiesApi.md#addmember) | **POST** /v1/loyalties/{campaignId}/members | Add Member +*LoyaltiesApi* | [**AdjustMemberPendingPoints**](docs/LoyaltiesApi.md#adjustmemberpendingpoints) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance | Adjust Member Pending Points +*LoyaltiesApi* | [**CancelMemberPendingPoints**](docs/LoyaltiesApi.md#cancelmemberpendingpoints) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel | Cancel Member Pending Points +*LoyaltiesApi* | [**CreateEarningRule**](docs/LoyaltiesApi.md#createearningrule) | **POST** /v1/loyalties/{campaignId}/earning-rules | Create Earning Rule +*LoyaltiesApi* | [**CreateInBulkLoyaltyTiers**](docs/LoyaltiesApi.md#createinbulkloyaltytiers) | **POST** /v1/loyalties/{campaignId}/tiers | Create loyalty tiers +*LoyaltiesApi* | [**CreateLoyaltyProgram**](docs/LoyaltiesApi.md#createloyaltyprogram) | **POST** /v1/loyalties | Create Loyalty Campaign +*LoyaltiesApi* | [**CreatePointsExpirationExport**](docs/LoyaltiesApi.md#createpointsexpirationexport) | **POST** /v1/loyalties/{campaignId}/points-expiration/export | Export Loyalty Campaign Point Expiration +*LoyaltiesApi* | [**CreateRewardAssignment1**](docs/LoyaltiesApi.md#createrewardassignment1) | **POST** /v1/loyalties/{campaignId}/rewards | Create Loyalty Campaign Reward Assignment +*LoyaltiesApi* | [**DeleteEarningRule**](docs/LoyaltiesApi.md#deleteearningrule) | **DELETE** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Delete Earning Rule +*LoyaltiesApi* | [**DeleteLoyaltyProgram**](docs/LoyaltiesApi.md#deleteloyaltyprogram) | **DELETE** /v1/loyalties/{campaignId} | Delete Loyalty Campaign +*LoyaltiesApi* | [**DeleteRewardAssignment1**](docs/LoyaltiesApi.md#deleterewardassignment1) | **DELETE** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Delete Campaign Reward Assignment +*LoyaltiesApi* | [**DisableEarningRule**](docs/LoyaltiesApi.md#disableearningrule) | **POST** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable | Disable Earning Rule +*LoyaltiesApi* | [**EnableEarningRule**](docs/LoyaltiesApi.md#enableearningrule) | **POST** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable | Enable Earning Rule +*LoyaltiesApi* | [**ExportLoyaltyCampaignTransactions**](docs/LoyaltiesApi.md#exportloyaltycampaigntransactions) | **POST** /v1/loyalties/{campaignId}/transactions/export | Export Loyalty Campaign Transactions +*LoyaltiesApi* | [**ExportLoyaltyCardTransactions**](docs/LoyaltiesApi.md#exportloyaltycardtransactions) | **POST** /v1/loyalties/members/{memberId}/transactions/export | Export Loyalty Card Transactions +*LoyaltiesApi* | [**ExportLoyaltyCardTransactions1**](docs/LoyaltiesApi.md#exportloyaltycardtransactions1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | Export Loyalty Card Transactions with campaign ID +*LoyaltiesApi* | [**GetEarningRule**](docs/LoyaltiesApi.md#getearningrule) | **GET** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Get Earning Rule +*LoyaltiesApi* | [**GetLoyaltyProgram**](docs/LoyaltiesApi.md#getloyaltyprogram) | **GET** /v1/loyalties/{campaignId} | Get Loyalty Campaign +*LoyaltiesApi* | [**GetLoyaltyTier**](docs/LoyaltiesApi.md#getloyaltytier) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | Get Loyalty Tier +*LoyaltiesApi* | [**GetMember**](docs/LoyaltiesApi.md#getmember) | **GET** /v1/loyalties/members/{memberId} | Get Member +*LoyaltiesApi* | [**GetMember1**](docs/LoyaltiesApi.md#getmember1) | **GET** /v1/loyalties/{campaignId}/members/{memberId} | Get Member with campaign ID +*LoyaltiesApi* | [**GetRewardAssignment1**](docs/LoyaltiesApi.md#getrewardassignment1) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | Get Campaign Reward Assignments +*LoyaltiesApi* | [**GetRewardAssignment2**](docs/LoyaltiesApi.md#getrewardassignment2) | **GET** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Get Campaign Reward Assignment +*LoyaltiesApi* | [**GetRewardDetails**](docs/LoyaltiesApi.md#getrewarddetails) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | Get Reward Details +*LoyaltiesApi* | [**ListCampaignPendingPoints**](docs/LoyaltiesApi.md#listcampaignpendingpoints) | **GET** /v1/loyalties/{campaignId}/pending-points | List Campaign Pending Points +*LoyaltiesApi* | [**ListEarningRules**](docs/LoyaltiesApi.md#listearningrules) | **GET** /v1/loyalties/{campaignId}/earning-rules | List Earning Rules +*LoyaltiesApi* | [**ListLoyaltyCampaignTransactions**](docs/LoyaltiesApi.md#listloyaltycampaigntransactions) | **GET** /v1/loyalties/{campaignId}/transactions | List Loyalty Campaign Transactions +*LoyaltiesApi* | [**ListLoyaltyCardTransactions**](docs/LoyaltiesApi.md#listloyaltycardtransactions) | **GET** /v1/loyalties/members/{memberId}/transactions | List Loyalty Card Transactions +*LoyaltiesApi* | [**ListLoyaltyCardTransactions1**](docs/LoyaltiesApi.md#listloyaltycardtransactions1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/transactions | List Loyalty Card Transactions with campaign ID +*LoyaltiesApi* | [**ListLoyaltyPrograms**](docs/LoyaltiesApi.md#listloyaltyprograms) | **GET** /v1/loyalties | List Loyalty Campaigns +*LoyaltiesApi* | [**ListLoyaltyTierEarningRules**](docs/LoyaltiesApi.md#listloyaltytierearningrules) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules | List Loyalty Tier Earning Rules +*LoyaltiesApi* | [**ListLoyaltyTierRewards**](docs/LoyaltiesApi.md#listloyaltytierrewards) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards | List Loyalty Tier Rewards +*LoyaltiesApi* | [**ListLoyaltyTiers**](docs/LoyaltiesApi.md#listloyaltytiers) | **GET** /v1/loyalties/{campaignId}/tiers | List Loyalty Tiers +*LoyaltiesApi* | [**ListMemberActivity**](docs/LoyaltiesApi.md#listmemberactivity) | **GET** /v1/loyalties/members/{memberId}/activity | List Member Activity +*LoyaltiesApi* | [**ListMemberActivity1**](docs/LoyaltiesApi.md#listmemberactivity1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/activity | List Member Activity with campaign ID +*LoyaltiesApi* | [**ListMemberLoyaltyTier**](docs/LoyaltiesApi.md#listmemberloyaltytier) | **GET** /v1/loyalties/members/{memberId}/tiers | List Member's Loyalty Tiers +*LoyaltiesApi* | [**ListMemberPendingPoints**](docs/LoyaltiesApi.md#listmemberpendingpoints) | **GET** /v1/loyalties/members/{memberId}/pending-points | List Member Pending Points +*LoyaltiesApi* | [**ListMemberPendingPoints1**](docs/LoyaltiesApi.md#listmemberpendingpoints1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/pending-points | List Member Pending Points with campaign ID +*LoyaltiesApi* | [**ListMemberRewards**](docs/LoyaltiesApi.md#listmemberrewards) | **GET** /v1/loyalties/members/{memberId}/rewards | List Member Rewards +*LoyaltiesApi* | [**ListMembers**](docs/LoyaltiesApi.md#listmembers) | **GET** /v1/loyalties/{campaignId}/members | List Members +*LoyaltiesApi* | [**ListPointsExpiration**](docs/LoyaltiesApi.md#listpointsexpiration) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | List Loyalty Card Point Expiration +*LoyaltiesApi* | [**ListRewardAssignments1**](docs/LoyaltiesApi.md#listrewardassignments1) | **GET** /v1/loyalties/{campaignId}/reward-assignments | List Reward Assignments with campaign ID +*LoyaltiesApi* | [**ListRewardAssignments2**](docs/LoyaltiesApi.md#listrewardassignments2) | **GET** /v1/loyalties/{campaignId}/rewards | List Campaign Rewards +*LoyaltiesApi* | [**RedeemReward**](docs/LoyaltiesApi.md#redeemreward) | **POST** /v1/loyalties/members/{memberId}/redemption | Redeem Reward +*LoyaltiesApi* | [**RedeemReward1**](docs/LoyaltiesApi.md#redeemreward1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/redemption | Redeem Reward with campaign ID +*LoyaltiesApi* | [**TransferPoints**](docs/LoyaltiesApi.md#transferpoints) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/transfers | Transfer Loyalty Points +*LoyaltiesApi* | [**UpdateEarningRule**](docs/LoyaltiesApi.md#updateearningrule) | **PUT** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Update Earning Rule +*LoyaltiesApi* | [**UpdateLoyaltyCardBalance**](docs/LoyaltiesApi.md#updateloyaltycardbalance) | **POST** /v1/loyalties/members/{memberId}/balance | Adjust Loyalty Card Balance +*LoyaltiesApi* | [**UpdateLoyaltyCardBalance1**](docs/LoyaltiesApi.md#updateloyaltycardbalance1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/balance | Adjust Loyalty Card Balance with campaign ID +*LoyaltiesApi* | [**UpdateLoyaltyProgram**](docs/LoyaltiesApi.md#updateloyaltyprogram) | **PUT** /v1/loyalties/{campaignId} | Update Loyalty Campaign +*LoyaltiesApi* | [**UpdateRewardAssignment1**](docs/LoyaltiesApi.md#updaterewardassignment1) | **PUT** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Update Campaign Reward Assignment +*ManagementApi* | [**AssignUser**](docs/ManagementApi.md#assignuser) | **POST** /management/v1/projects/{projectId}/users | Assign User +*ManagementApi* | [**CreateBrand**](docs/ManagementApi.md#createbrand) | **POST** /management/v1/projects/{projectId}/branding | Create Brand +*ManagementApi* | [**CreateCustomEventSchema**](docs/ManagementApi.md#createcustomeventschema) | **POST** /management/v1/projects/{projectId}/custom-event-schemas | Create Custom Event Schema +*ManagementApi* | [**CreateMetadataSchema**](docs/ManagementApi.md#createmetadataschema) | **POST** /management/v1/projects/{projectId}/metadata-schemas | Create Metadata Schema +*ManagementApi* | [**CreateProject**](docs/ManagementApi.md#createproject) | **POST** /management/v1/projects | Create Project +*ManagementApi* | [**CreateStackingRules**](docs/ManagementApi.md#createstackingrules) | **POST** /management/v1/projects/{projectId}/stacking-rules | Create Stacking Rules +*ManagementApi* | [**CreateWebhook**](docs/ManagementApi.md#createwebhook) | **POST** /management/v1/projects/{projectId}/webhooks | Create Webhook +*ManagementApi* | [**DeleteBrand**](docs/ManagementApi.md#deletebrand) | **DELETE** /management/v1/projects/{projectId}/branding/{brandingId} | Delete Brand +*ManagementApi* | [**DeleteCustomEventSchema**](docs/ManagementApi.md#deletecustomeventschema) | **DELETE** /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | Delete Custom Event Schema +*ManagementApi* | [**DeleteMetadataSchema**](docs/ManagementApi.md#deletemetadataschema) | **DELETE** /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | Delete Metadata Schema +*ManagementApi* | [**DeleteProject**](docs/ManagementApi.md#deleteproject) | **DELETE** /management/v1/projects/{projectId} | Delete Project +*ManagementApi* | [**DeleteStackingRules**](docs/ManagementApi.md#deletestackingrules) | **DELETE** /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | Delete Stacking Rules +*ManagementApi* | [**DeleteWebhook**](docs/ManagementApi.md#deletewebhook) | **DELETE** /management/v1/projects/{projectId}/webhooks/{webhookId} | Delete Webhook +*ManagementApi* | [**GetBrand**](docs/ManagementApi.md#getbrand) | **GET** /management/v1/projects/{projectId}/branding/{brandingId} | Get Brand +*ManagementApi* | [**GetCustomEventSchema**](docs/ManagementApi.md#getcustomeventschema) | **GET** /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | Get Custom Event Schema +*ManagementApi* | [**GetMetadataSchema1**](docs/ManagementApi.md#getmetadataschema1) | **GET** /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | Get Metadata Schema +*ManagementApi* | [**GetProject**](docs/ManagementApi.md#getproject) | **GET** /management/v1/projects/{projectId} | Get Project +*ManagementApi* | [**GetStackingRules**](docs/ManagementApi.md#getstackingrules) | **GET** /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | Get Stacking Rules +*ManagementApi* | [**GetUser**](docs/ManagementApi.md#getuser) | **GET** /management/v1/projects/{projectId}/users/{userId} | Get User +*ManagementApi* | [**GetWebhook**](docs/ManagementApi.md#getwebhook) | **GET** /management/v1/projects/{projectId}/webhooks/{webhookId} | Get Webhook +*ManagementApi* | [**InviteUser**](docs/ManagementApi.md#inviteuser) | **POST** /management/v1/projects/users/invite | Invite a New User +*ManagementApi* | [**ListBrands**](docs/ManagementApi.md#listbrands) | **GET** /management/v1/projects/{projectId}/branding | List Brands +*ManagementApi* | [**ListCustomEventSchemas**](docs/ManagementApi.md#listcustomeventschemas) | **GET** /management/v1/projects/{projectId}/custom-event-schemas | List Custom Event Schemas +*ManagementApi* | [**ListMetadataSchemas1**](docs/ManagementApi.md#listmetadataschemas1) | **GET** /management/v1/projects/{projectId}/metadata-schemas | List Metadata Schemas +*ManagementApi* | [**ListProjects**](docs/ManagementApi.md#listprojects) | **GET** /management/v1/projects | List Projects +*ManagementApi* | [**ListStackingRules**](docs/ManagementApi.md#liststackingrules) | **GET** /management/v1/projects/{projectId}/stacking-rules | List Stacking Rules +*ManagementApi* | [**ListUsers**](docs/ManagementApi.md#listusers) | **GET** /management/v1/projects/{projectId}/users | List Users +*ManagementApi* | [**ListWebhooks**](docs/ManagementApi.md#listwebhooks) | **GET** /management/v1/projects/{projectId}/webhooks | List Webhooks +*ManagementApi* | [**ManagementCopyCampaignTemplate**](docs/ManagementApi.md#managementcopycampaigntemplate) | **POST** /management/v1/projects/{projectId}/templates/campaigns/{campaignTemplateId}/copy | Copy Campaign Template to a Project +*ManagementApi* | [**ManagementListCampaignTemplates**](docs/ManagementApi.md#managementlistcampaigntemplates) | **GET** /management/v1/projects/{projectId}/templates/campaigns | List Campaign Templates +*ManagementApi* | [**UnassignUser**](docs/ManagementApi.md#unassignuser) | **DELETE** /management/v1/projects/{projectId}/users/{userId} | Unassign User +*ManagementApi* | [**UpdateBrand**](docs/ManagementApi.md#updatebrand) | **PUT** /management/v1/projects/{projectId}/branding/{brandingId} | Update Brand +*ManagementApi* | [**UpdateCustomEventSchema**](docs/ManagementApi.md#updatecustomeventschema) | **PUT** /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | Update Custom Event Schema +*ManagementApi* | [**UpdateMetadataSchema**](docs/ManagementApi.md#updatemetadataschema) | **PUT** /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | Update Metadata Schema +*ManagementApi* | [**UpdateProject**](docs/ManagementApi.md#updateproject) | **PUT** /management/v1/projects/{projectId} | Update Project +*ManagementApi* | [**UpdateStackingRules**](docs/ManagementApi.md#updatestackingrules) | **PUT** /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | Update Stacking Rules +*ManagementApi* | [**UpdateUser**](docs/ManagementApi.md#updateuser) | **PUT** /management/v1/projects/{projectId}/users/{userId} | Update User +*ManagementApi* | [**UpdateWebhook**](docs/ManagementApi.md#updatewebhook) | **PUT** /management/v1/projects/{projectId}/webhooks/{webhookId} | Update Webhook +*MetadataSchemasApi* | [**GetMetadataSchema**](docs/MetadataSchemasApi.md#getmetadataschema) | **GET** /v1/metadata-schemas/{resource} | Get Metadata Schema +*MetadataSchemasApi* | [**ListMetadataSchemas**](docs/MetadataSchemasApi.md#listmetadataschemas) | **GET** /v1/metadata-schemas | List Metadata Schema Definitions +*OAuthApi* | [**GenerateOauthToken**](docs/OAuthApi.md#generateoauthtoken) | **POST** /v1/oauth/token | Generate OAuth 2.0 Token +*OAuthApi* | [**IntrospectOauthToken**](docs/OAuthApi.md#introspectoauthtoken) | **POST** /v1/oauth/introspect | Introspect OAuth 2.0 Token +*OAuthApi* | [**RevokeOauthToken**](docs/OAuthApi.md#revokeoauthtoken) | **POST** /v1/oauth/token/revoke | Revoke OAuth 2.0 Token +*OrdersApi* | [**CreateOrder**](docs/OrdersApi.md#createorder) | **POST** /v1/orders | Create Order +*OrdersApi* | [**CreateOrderExport**](docs/OrdersApi.md#createorderexport) | **POST** /v1/orders/export | Create Orders Export +*OrdersApi* | [**GetOrder**](docs/OrdersApi.md#getorder) | **GET** /v1/orders/{orderId} | Get Order +*OrdersApi* | [**ImportOrders**](docs/OrdersApi.md#importorders) | **POST** /v1/orders/import | Import Orders +*OrdersApi* | [**ListOrders**](docs/OrdersApi.md#listorders) | **GET** /v1/orders | List Orders +*OrdersApi* | [**UpdateOrder**](docs/OrdersApi.md#updateorder) | **PUT** /v1/orders/{orderId} | Update Order +*ProductCollectionsApi* | [**CreateProductCollection**](docs/ProductCollectionsApi.md#createproductcollection) | **POST** /v1/product-collections | Create Product Collection +*ProductCollectionsApi* | [**DeleteProductCollection**](docs/ProductCollectionsApi.md#deleteproductcollection) | **DELETE** /v1/product-collections/{productCollectionId} | Delete Product Collection +*ProductCollectionsApi* | [**GetProductCollection**](docs/ProductCollectionsApi.md#getproductcollection) | **GET** /v1/product-collections/{productCollectionId} | Get Product Collection +*ProductCollectionsApi* | [**ListProductCollections**](docs/ProductCollectionsApi.md#listproductcollections) | **GET** /v1/product-collections | List Product Collections +*ProductCollectionsApi* | [**ListProductsInCollection**](docs/ProductCollectionsApi.md#listproductsincollection) | **GET** /v1/product-collections/{productCollectionId}/products | List Products in Collection +*ProductsApi* | [**CreateProduct**](docs/ProductsApi.md#createproduct) | **POST** /v1/products | Create Product +*ProductsApi* | [**CreateSku**](docs/ProductsApi.md#createsku) | **POST** /v1/products/{productId}/skus | Create SKU +*ProductsApi* | [**DeleteProduct**](docs/ProductsApi.md#deleteproduct) | **DELETE** /v1/products/{productId} | Delete Product +*ProductsApi* | [**DeleteSku**](docs/ProductsApi.md#deletesku) | **DELETE** /v1/products/{productId}/skus/{skuId} | Delete SKU +*ProductsApi* | [**GetProduct**](docs/ProductsApi.md#getproduct) | **GET** /v1/products/{productId} | Get Product +*ProductsApi* | [**GetSku**](docs/ProductsApi.md#getsku) | **GET** /v1/skus/{skuId} | Get SKU +*ProductsApi* | [**ImportProductsUsingCsv**](docs/ProductsApi.md#importproductsusingcsv) | **POST** /v1/products/importCSV | Import Products using CSV +*ProductsApi* | [**ImportSKUsUsingCsv**](docs/ProductsApi.md#importskususingcsv) | **POST** /v1/skus/importCSV | Import SKUs using CSV +*ProductsApi* | [**ListProducts**](docs/ProductsApi.md#listproducts) | **GET** /v1/products | List Products +*ProductsApi* | [**ListSKUsInProduct**](docs/ProductsApi.md#listskusinproduct) | **GET** /v1/products/{productId}/skus | List SKUs in Product +*ProductsApi* | [**UpdateProduct**](docs/ProductsApi.md#updateproduct) | **PUT** /v1/products/{productId} | Update Product +*ProductsApi* | [**UpdateProductsInBulk**](docs/ProductsApi.md#updateproductsinbulk) | **POST** /v1/products/bulk/async | Update Products in Bulk +*ProductsApi* | [**UpdateProductsMetadataInBulk**](docs/ProductsApi.md#updateproductsmetadatainbulk) | **POST** /v1/products/metadata/async | Update Products' Metadata in Bulk +*ProductsApi* | [**UpdateSku**](docs/ProductsApi.md#updatesku) | **PUT** /v1/products/{productId}/skus/{skuId} | Update SKU +*PromotionsApi* | [**AddPromotionTierToCampaign**](docs/PromotionsApi.md#addpromotiontiertocampaign) | **POST** /v1/promotions/{campaignId}/tiers | Add Promotion Tier to Campaign +*PromotionsApi* | [**CreatePromotionStack**](docs/PromotionsApi.md#createpromotionstack) | **POST** /v1/promotions/{campaignId}/stacks | Create Promotion Stack +*PromotionsApi* | [**DeletePromotionStack**](docs/PromotionsApi.md#deletepromotionstack) | **DELETE** /v1/promotions/{campaignId}/stacks/{stackId} | Delete Promotion Stack +*PromotionsApi* | [**DeletePromotionTier**](docs/PromotionsApi.md#deletepromotiontier) | **DELETE** /v1/promotions/tiers/{promotionTierId} | Delete Promotion Tier +*PromotionsApi* | [**DisablePromotionTier**](docs/PromotionsApi.md#disablepromotiontier) | **POST** /v1/promotions/tiers/{promotionTierId}/disable | Disable Promotion Tier +*PromotionsApi* | [**EnablePromotionTier**](docs/PromotionsApi.md#enablepromotiontier) | **POST** /v1/promotions/tiers/{promotionTierId}/enable | Enable Promotion Tier +*PromotionsApi* | [**GetPromotionStack**](docs/PromotionsApi.md#getpromotionstack) | **GET** /v1/promotions/{campaignId}/stacks/{stackId} | Get Promotion Stack +*PromotionsApi* | [**GetPromotionTier**](docs/PromotionsApi.md#getpromotiontier) | **GET** /v1/promotions/tiers/{promotionTierId} | Get Promotion Tier +*PromotionsApi* | [**ListAllPromotionStacks**](docs/PromotionsApi.md#listallpromotionstacks) | **GET** /v1/promotions/stacks | List Promotion Stacks +*PromotionsApi* | [**ListPromotionStacksInCampaign**](docs/PromotionsApi.md#listpromotionstacksincampaign) | **GET** /v1/promotions/{campaignId}/stacks | List Promotion Stacks in Campaign +*PromotionsApi* | [**ListPromotionTiers**](docs/PromotionsApi.md#listpromotiontiers) | **GET** /v1/promotions/tiers | List Promotion Tiers +*PromotionsApi* | [**ListPromotionTiersFromCampaign**](docs/PromotionsApi.md#listpromotiontiersfromcampaign) | **GET** /v1/promotions/{campaignId}/tiers | List Promotion Tiers from Campaign +*PromotionsApi* | [**UpdatePromotionStack**](docs/PromotionsApi.md#updatepromotionstack) | **PUT** /v1/promotions/{campaignId}/stacks/{stackId} | Update Promotion Stack +*PromotionsApi* | [**UpdatePromotionTier**](docs/PromotionsApi.md#updatepromotiontier) | **PUT** /v1/promotions/tiers/{promotionTierId} | Update Promotion Tier +*PublicationsApi* | [**CreatePublication**](docs/PublicationsApi.md#createpublication) | **POST** /v1/publications | Create Publication +*PublicationsApi* | [**CreatePublication1**](docs/PublicationsApi.md#createpublication1) | **GET** /v1/publications/create | Create Publication with GET +*PublicationsApi* | [**ListPublications**](docs/PublicationsApi.md#listpublications) | **GET** /v1/publications | List Publications +*QualificationsApi* | [**CheckEligibility**](docs/QualificationsApi.md#checkeligibility) | **POST** /v1/qualifications | Check Eligibility +*RedemptionsApi* | [**GetRedemption**](docs/RedemptionsApi.md#getredemption) | **GET** /v1/redemptions/{redemptionId} | Get Redemption +*RedemptionsApi* | [**GetVoucherRedemptions**](docs/RedemptionsApi.md#getvoucherredemptions) | **GET** /v1/vouchers/{code}/redemption | Get Voucher's Redemptions +*RedemptionsApi* | [**ListRedemptions**](docs/RedemptionsApi.md#listredemptions) | **GET** /v1/redemptions | List Redemptions +*RedemptionsApi* | [**RedeemStackedDiscounts**](docs/RedemptionsApi.md#redeemstackeddiscounts) | **POST** /v1/redemptions | Redeem Stackable Discounts +*RedemptionsApi* | [**RollbackRedemption**](docs/RedemptionsApi.md#rollbackredemption) | **POST** /v1/redemptions/{redemptionId}/rollback | Rollback Redemption +*RedemptionsApi* | [**RollbackStackedRedemptions**](docs/RedemptionsApi.md#rollbackstackedredemptions) | **POST** /v1/redemptions/{parentRedemptionId}/rollbacks | Rollback Stackable Redemptions +*ReferralsApi* | [**ReferralsAddHolders**](docs/ReferralsApi.md#referralsaddholders) | **POST** /v1/referrals/members/{memberId}/holders | Add Referral Code Holders +*ReferralsApi* | [**ReferralsAddHolders1**](docs/ReferralsApi.md#referralsaddholders1) | **POST** /v1/referrals/{campaignId}/members/{memberId}/holders | Add Referral Code Holders with Campaign ID +*ReferralsApi* | [**ReferralsCodeHolders**](docs/ReferralsApi.md#referralscodeholders) | **GET** /v1/referrals/{campaignId}/members/{memberId}/holders | List Referral Code Holders with campaign ID +*ReferralsApi* | [**ReferralsCodeHolders1**](docs/ReferralsApi.md#referralscodeholders1) | **GET** /v1/referrals/members/{memberId}/holders | List Referral Code Holders +*ReferralsApi* | [**ReferralsRemoveHolder**](docs/ReferralsApi.md#referralsremoveholder) | **DELETE** /v1/referrals/members/{memberId}/holders/{holderId} | Remove Referral Card Holder +*ReferralsApi* | [**ReferralsRemoveHolder1**](docs/ReferralsApi.md#referralsremoveholder1) | **DELETE** /v1/referrals/{campaignId}/members/{memberId}/holders/{holderId} | Remove Referral Card Holder with campaign ID +*RewardsApi* | [**CreateReward**](docs/RewardsApi.md#createreward) | **POST** /v1/rewards | Create Reward +*RewardsApi* | [**CreateRewardAssignment**](docs/RewardsApi.md#createrewardassignment) | **POST** /v1/rewards/{rewardId}/assignments | Create Reward Assignment +*RewardsApi* | [**DeleteReward**](docs/RewardsApi.md#deletereward) | **DELETE** /v1/rewards/{rewardId} | Delete Reward +*RewardsApi* | [**DeleteRewardAssignment**](docs/RewardsApi.md#deleterewardassignment) | **DELETE** /v1/rewards/{rewardId}/assignments/{assignmentId} | Delete Reward Assignment +*RewardsApi* | [**GetReward**](docs/RewardsApi.md#getreward) | **GET** /v1/rewards/{rewardId} | Get Reward +*RewardsApi* | [**GetRewardAssignment**](docs/RewardsApi.md#getrewardassignment) | **GET** /v1/rewards/{rewardId}/assignments/{assignmentId} | Get Reward Assignment +*RewardsApi* | [**ListRewardAssignments**](docs/RewardsApi.md#listrewardassignments) | **GET** /v1/rewards/{rewardId}/assignments | List Reward Assignments +*RewardsApi* | [**ListRewards**](docs/RewardsApi.md#listrewards) | **GET** /v1/rewards | List Rewards +*RewardsApi* | [**UpdateReward**](docs/RewardsApi.md#updatereward) | **PUT** /v1/rewards/{rewardId} | Update Reward +*RewardsApi* | [**UpdateRewardAssignment**](docs/RewardsApi.md#updaterewardassignment) | **PUT** /v1/rewards/{rewardId}/assignments/{assignmentId} | Update Reward Assignment +*SegmentsApi* | [**CreateSegment**](docs/SegmentsApi.md#createsegment) | **POST** /v1/segments | Create Segment +*SegmentsApi* | [**DeleteSegment**](docs/SegmentsApi.md#deletesegment) | **DELETE** /v1/segments/{segmentId} | Delete Segment +*SegmentsApi* | [**GetSegment**](docs/SegmentsApi.md#getsegment) | **GET** /v1/segments/{segmentId} | Get Segment +*TemplatesApi* | [**AddTierFromTemplate**](docs/TemplatesApi.md#addtierfromtemplate) | **POST** /v1/templates/campaigns/{campaignTemplateId}/tier-setup | Add Promotion Tier From Template +*TemplatesApi* | [**CreateCampaignFromTemplate**](docs/TemplatesApi.md#createcampaignfromtemplate) | **POST** /v1/templates/campaigns/{campaignTemplateId}/campaign-setup | Create Campaign From Template +*TemplatesApi* | [**CreateCampaignTemplate**](docs/TemplatesApi.md#createcampaigntemplate) | **POST** /v1/templates/campaigns | Create Campaign Template +*TemplatesApi* | [**DeleteCampaignTemplate**](docs/TemplatesApi.md#deletecampaigntemplate) | **DELETE** /v1/templates/campaigns/{campaignTemplateId} | Delete Campaign Template +*TemplatesApi* | [**GetCampaignTemplate**](docs/TemplatesApi.md#getcampaigntemplate) | **GET** /v1/templates/campaigns/{campaignTemplateId} | Get Campaign Template +*TemplatesApi* | [**ListCampaignTemplates**](docs/TemplatesApi.md#listcampaigntemplates) | **GET** /v1/templates/campaigns | List Campaign Templates +*TemplatesApi* | [**UpdateCampaignTemplate**](docs/TemplatesApi.md#updatecampaigntemplate) | **PUT** /v1/templates/campaigns/{campaignTemplateId} | Update Campaign Template +*ValidationRulesApi* | [**CreateValidationRuleAssignment**](docs/ValidationRulesApi.md#createvalidationruleassignment) | **POST** /v1/validation-rules/{validationRuleId}/assignments | Create Validation Rules Assignments +*ValidationRulesApi* | [**CreateValidationRules**](docs/ValidationRulesApi.md#createvalidationrules) | **POST** /v1/validation-rules | Create Validation Rules +*ValidationRulesApi* | [**DeleteValidationRuleAssignment**](docs/ValidationRulesApi.md#deletevalidationruleassignment) | **DELETE** /v1/validation-rules/{validationRuleId}/assignments/{assignmentId} | Delete Validation Rule Assignment +*ValidationRulesApi* | [**DeleteValidationRules**](docs/ValidationRulesApi.md#deletevalidationrules) | **DELETE** /v1/validation-rules/{validationRuleId} | Delete Validation Rule +*ValidationRulesApi* | [**GetValidationRule**](docs/ValidationRulesApi.md#getvalidationrule) | **GET** /v1/validation-rules/{validationRuleId} | Get Validation Rule +*ValidationRulesApi* | [**ListValidationRuleAssignments**](docs/ValidationRulesApi.md#listvalidationruleassignments) | **GET** /v1/validation-rules/{validationRuleId}/assignments | List Validation Rule Assignments +*ValidationRulesApi* | [**ListValidationRules**](docs/ValidationRulesApi.md#listvalidationrules) | **GET** /v1/validation-rules | List Validation Rules +*ValidationRulesApi* | [**ListValidationRulesAssignments**](docs/ValidationRulesApi.md#listvalidationrulesassignments) | **GET** /v1/validation-rules-assignments | List Validation Rules' Assignment(s) +*ValidationRulesApi* | [**UpdateValidationRule**](docs/ValidationRulesApi.md#updatevalidationrule) | **PUT** /v1/validation-rules/{validationRuleId} | Update Validation Rule +*ValidationsApi* | [**ValidateStackedDiscounts**](docs/ValidationsApi.md#validatestackeddiscounts) | **POST** /v1/validations | Validate Stackable Discounts +*VouchersApi* | [**CreateVoucher**](docs/VouchersApi.md#createvoucher) | **POST** /v1/vouchers/{code} | Create Voucher +*VouchersApi* | [**DeleteVoucher**](docs/VouchersApi.md#deletevoucher) | **DELETE** /v1/vouchers/{code} | Delete Voucher +*VouchersApi* | [**DisableVoucher**](docs/VouchersApi.md#disablevoucher) | **POST** /v1/vouchers/{code}/disable | Disable Voucher +*VouchersApi* | [**EnableVoucher**](docs/VouchersApi.md#enablevoucher) | **POST** /v1/vouchers/{code}/enable | Enable Voucher +*VouchersApi* | [**ExportVoucherTransactions**](docs/VouchersApi.md#exportvouchertransactions) | **POST** /v1/vouchers/{code}/transactions/export | Export Voucher Transactions +*VouchersApi* | [**GenerateRandomCode**](docs/VouchersApi.md#generaterandomcode) | **POST** /v1/vouchers | Generate Random Code +*VouchersApi* | [**GetVoucher**](docs/VouchersApi.md#getvoucher) | **GET** /v1/vouchers/{code} | Get Voucher +*VouchersApi* | [**ImportVouchers**](docs/VouchersApi.md#importvouchers) | **POST** /v1/vouchers/import | Import Vouchers +*VouchersApi* | [**ImportVouchersUsingCsv**](docs/VouchersApi.md#importvouchersusingcsv) | **POST** /v1/vouchers/importCSV | Import Vouchers using CSV +*VouchersApi* | [**ListVoucherTransactions**](docs/VouchersApi.md#listvouchertransactions) | **GET** /v1/vouchers/{code}/transactions | List Voucher Transactions +*VouchersApi* | [**ListVouchers**](docs/VouchersApi.md#listvouchers) | **GET** /v1/vouchers | List Vouchers +*VouchersApi* | [**ReleaseValidationSession**](docs/VouchersApi.md#releasevalidationsession) | **DELETE** /v1/vouchers/{code}/sessions/{sessionKey} | Release Validation Session +*VouchersApi* | [**UpdateVoucher**](docs/VouchersApi.md#updatevoucher) | **PUT** /v1/vouchers/{code} | Update Voucher +*VouchersApi* | [**UpdateVoucherBalance**](docs/VouchersApi.md#updatevoucherbalance) | **POST** /v1/vouchers/{code}/balance | Adjust Voucher Balance +*VouchersApi* | [**UpdateVouchersInBulk**](docs/VouchersApi.md#updatevouchersinbulk) | **POST** /v1/vouchers/bulk/async | Update Vouchers in Bulk +*VouchersApi* | [**UpdateVouchersMetadataInBulk**](docs/VouchersApi.md#updatevouchersmetadatainbulk) | **POST** /v1/vouchers/metadata/async | Update Vouchers' Metadata in Bulk + + + +## Documentation for Models - [Model.AccessSettings](docs/AccessSettings.md) - [Model.AccessSettingsAssign](docs/AccessSettingsAssign.md) @@ -1892,4 +1897,5 @@ All URIs are relative to `https://api.voucherify.io`. - [Model.VouchersUpdateResponseBodyGift](docs/VouchersUpdateResponseBodyGift.md) - [Model.VouchersUpdateResponseBodyLoyaltyCard](docs/VouchersUpdateResponseBodyLoyaltyCard.md) - [Model.VouchersUpdateResponseBodyPublish](docs/VouchersUpdateResponseBodyPublish.md) - - [Model.VouchersUpdateResponseBodyRedemption](docs/VouchersUpdateResponseBodyRedemption.md) \ No newline at end of file + - [Model.VouchersUpdateResponseBodyRedemption](docs/VouchersUpdateResponseBodyRedemption.md) + diff --git a/src/Voucherify.Test/src/flows/Campaign.cs b/src/Voucherify.Test/src/flows/Campaign.cs index e47ed04b..cd2b575d 100644 --- a/src/Voucherify.Test/src/flows/Campaign.cs +++ b/src/Voucherify.Test/src/flows/Campaign.cs @@ -66,12 +66,12 @@ public async Task getCampaignVouchers(string campaignI public async Task addVoucherToCampaign(string campaignId) { - return await _campaignsApi.AddVouchersToCampaignAsync(campaignId, 1); + return await _campaignsApi.AddVouchersToCampaignAsync(campaignId, new CampaignsVouchersCreateInBulkRequestBody(), 1); } public async Task createBundleOfVouchers(string campaignId, int vouchersCount = 5) { - return await _campaignsApi.AddVouchersToCampaignAsync(campaignId, vouchersCount); + return await _campaignsApi.AddVouchersToCampaignAsync(campaignId, new CampaignsVouchersCreateInBulkRequestBody(), vouchersCount); } } -} \ No newline at end of file +} diff --git a/src/Voucherify.Test/src/flows/Stackable.cs b/src/Voucherify.Test/src/flows/Stackable.cs index 68a126c8..7c46df6d 100644 --- a/src/Voucherify.Test/src/flows/Stackable.cs +++ b/src/Voucherify.Test/src/flows/Stackable.cs @@ -1,5 +1,6 @@ using System; using System.Collections.Generic; +using System.Linq; using System.Threading.Tasks; using Voucherify.Api; using Voucherify.Client; @@ -97,17 +98,26 @@ public async Task RedeemStackedDiscounts(List ListRedemptions() + public async Task ListRedemptions(List voucherCodes) { + if (voucherCodes == null) throw new ArgumentNullException(nameof(voucherCodes)); + + var normalizedVoucherCodes = voucherCodes + .Where(code => !string.IsNullOrWhiteSpace(code)) + .Distinct() + .ToList(); + + if (normalizedVoucherCodes.Count == 0) + throw new ArgumentException("voucherCodes must contain at least one non-empty voucher code.", nameof(voucherCodes)); + var filters = new ParameterFiltersListRedemptions( voucherCode: new ParameterFiltersListRedemptionsVoucherCode( conditions: new FilterConditionsString( - notIn: new List { "123" } + varIn: normalizedVoucherCodes ) ) ); - return await _redemptionsApi.ListRedemptionsAsync( filters: filters ); diff --git a/src/Voucherify.Test/src/tests/OAuth.cs b/src/Voucherify.Test/src/tests/OAuth.cs index 56654efd..dbac21ac 100644 --- a/src/Voucherify.Test/src/tests/OAuth.cs +++ b/src/Voucherify.Test/src/tests/OAuth.cs @@ -215,7 +215,7 @@ public async Task Test_Retrieve_Voucher_From_Campaign_And_Publish_For_Customer() Voucher = _voucher.Code }; - var publication = await _publicationsApi.CreatePublicationAsync(true, publicationsCreateRequestBody); + var publication = await _publicationsApi.CreatePublicationAsync(publicationsCreateRequestBody, true); publication.Should().NotBeNull(); publication.CustomerId.Should().Be(_customer.Id); diff --git a/src/Voucherify.Test/src/tests/Redemptions.cs b/src/Voucherify.Test/src/tests/Redemptions.cs index 8296b492..c57746c4 100644 --- a/src/Voucherify.Test/src/tests/Redemptions.cs +++ b/src/Voucherify.Test/src/tests/Redemptions.cs @@ -1,5 +1,6 @@ using System; using System.Collections.Generic; +using System.Linq; using System.Threading.Tasks; using Xunit; using Voucherify.Model; @@ -8,7 +9,6 @@ namespace Voucherify.Test.Tests { - //TODO: Need a bit of work public class RedemptionsTests { private readonly StackableFlow _stackableFlow; @@ -45,7 +45,7 @@ public async Task ValidateStackedDiscounts() } [Fact] - public async Task RedeemStackedDiscounts() + public async Task RedeemStackedDiscounts_ThenListRedemptions_ByVoucherCodes() { var resultTemp = await _publicationFlow.createAndPublishVoucherForCustomer( TestHelper.GenerateUniqueName("Campaign"), @@ -53,23 +53,25 @@ public async Task RedeemStackedDiscounts() ); var voucherIds = new List { resultTemp.Vouchers[0].Id, resultTemp.Vouchers[1].Id }; + voucherIds.Should().AllSatisfy(id => id.Should().NotBeNullOrWhiteSpace()); - var result = await _stackableFlow.RedeemStackedDiscounts(voucherIds); + var voucherCodes = new List { resultTemp.Vouchers[0].Code, resultTemp.Vouchers[1].Code }; + voucherCodes.Should().AllSatisfy(code => code.Should().NotBeNullOrWhiteSpace()); - result.Should().NotBeNull(); - result.Redemptions.Should().NotBeNull(); - result.Redemptions.Should().HaveCount(voucherIds.Count); - } + var redeemResult = await _stackableFlow.RedeemStackedDiscounts(voucherIds); - [Fact] - public async Task ListRedemptions() - { - var result = await _stackableFlow.ListRedemptions(); + redeemResult.Should().NotBeNull(); + redeemResult.Redemptions.Should().NotBeNull(); + redeemResult.Redemptions.Should().HaveCount(voucherIds.Count); - result.Should().NotBeNull(); - result.Redemptions.Should().NotBeNull(); - result.Redemptions.Should().HaveCountLessThanOrEqualTo(10); - result.Redemptions.Should().HaveCountGreaterThanOrEqualTo(1); + var listResult = await _stackableFlow.ListRedemptions(voucherCodes); + + listResult.Should().NotBeNull(); + listResult.Redemptions.Should().NotBeNull(); + listResult.Redemptions.Should().HaveCountLessThanOrEqualTo(10); + listResult.Redemptions.Should().HaveCountGreaterThanOrEqualTo(1); + + listResult.Redemptions.Should().Contain(r => r.Voucher != null && voucherCodes.Contains(r.Voucher.Code)); } } -} \ No newline at end of file +} diff --git a/src/Voucherify/Api/CampaignsApi.cs b/src/Voucherify/Api/CampaignsApi.cs index ac619d40..8d1ef00a 100644 --- a/src/Voucherify/Api/CampaignsApi.cs +++ b/src/Voucherify/Api/CampaignsApi.cs @@ -37,10 +37,10 @@ public interface ICampaignsApiSync : IApiAccessor /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. /// A custom **code** that identifies the voucher. - /// Specify the voucher parameters that you would like to overwrite. (optional) + /// Specify the voucher parameters that you would like to overwrite. /// Index associated with the operation. /// CampaignsVouchersCreateResponseBody - CampaignsVouchersCreateResponseBody AddVoucherWithSpecificCodeToCampaign(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody = default(CampaignsVouchersCreateRequestBody), int operationIndex = 0); + CampaignsVouchersCreateResponseBody AddVoucherWithSpecificCodeToCampaign(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody, int operationIndex = 0); /// /// Add Voucher with Specific Code to Campaign @@ -51,10 +51,10 @@ public interface ICampaignsApiSync : IApiAccessor /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. /// A custom **code** that identifies the voucher. - /// Specify the voucher parameters that you would like to overwrite. (optional) + /// Specify the voucher parameters that you would like to overwrite. /// Index associated with the operation. /// ApiResponse of CampaignsVouchersCreateResponseBody - ApiResponse AddVoucherWithSpecificCodeToCampaignWithHttpInfo(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody = default(CampaignsVouchersCreateRequestBody), int operationIndex = 0); + ApiResponse AddVoucherWithSpecificCodeToCampaignWithHttpInfo(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody, int operationIndex = 0); /// /// Add Vouchers to Campaign /// @@ -63,11 +63,11 @@ public interface ICampaignsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + /// Specify the voucher parameters that you would like to overwrite. /// Number of vouchers that should be added. (optional) - /// Specify the voucher parameters that you would like to overwrite. (optional) /// Index associated with the operation. /// CampaignsVouchersCreateCombinedResponseBody - CampaignsVouchersCreateCombinedResponseBody AddVouchersToCampaign(string campaignId, int? vouchersCount = default(int?), CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody = default(CampaignsVouchersCreateInBulkRequestBody), int operationIndex = 0); + CampaignsVouchersCreateCombinedResponseBody AddVouchersToCampaign(string campaignId, CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody, int? vouchersCount = default(int?), int operationIndex = 0); /// /// Add Vouchers to Campaign @@ -77,11 +77,11 @@ public interface ICampaignsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + /// Specify the voucher parameters that you would like to overwrite. /// Number of vouchers that should be added. (optional) - /// Specify the voucher parameters that you would like to overwrite. (optional) /// Index associated with the operation. /// ApiResponse of CampaignsVouchersCreateCombinedResponseBody - ApiResponse AddVouchersToCampaignWithHttpInfo(string campaignId, int? vouchersCount = default(int?), CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody = default(CampaignsVouchersCreateInBulkRequestBody), int operationIndex = 0); + ApiResponse AddVouchersToCampaignWithHttpInfo(string campaignId, CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody, int? vouchersCount = default(int?), int operationIndex = 0); /// /// Create Campaign /// @@ -89,10 +89,10 @@ public interface ICampaignsApiSync : IApiAccessor /// Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the campaign that you would like to create. (optional) + /// Specify the details of the campaign that you would like to create. /// Index associated with the operation. /// CampaignsCreateResponseBody - CampaignsCreateResponseBody CreateCampaign(CampaignsCreateRequestBody campaignsCreateRequestBody = default(CampaignsCreateRequestBody), int operationIndex = 0); + CampaignsCreateResponseBody CreateCampaign(CampaignsCreateRequestBody campaignsCreateRequestBody, int operationIndex = 0); /// /// Create Campaign @@ -101,10 +101,10 @@ public interface ICampaignsApiSync : IApiAccessor /// Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the campaign that you would like to create. (optional) + /// Specify the details of the campaign that you would like to create. /// Index associated with the operation. /// ApiResponse of CampaignsCreateResponseBody - ApiResponse CreateCampaignWithHttpInfo(CampaignsCreateRequestBody campaignsCreateRequestBody = default(CampaignsCreateRequestBody), int operationIndex = 0); + ApiResponse CreateCampaignWithHttpInfo(CampaignsCreateRequestBody campaignsCreateRequestBody, int operationIndex = 0); /// /// Delete Campaign /// @@ -184,10 +184,10 @@ public interface ICampaignsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// CampaignsTransactionsExportCreateResponseBody - CampaignsTransactionsExportCreateResponseBody ExportCampaignTransactions(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody = default(CampaignsTransactionsExportCreateRequestBody), int operationIndex = 0); + CampaignsTransactionsExportCreateResponseBody ExportCampaignTransactions(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody, int operationIndex = 0); /// /// Export Campaign Transactions @@ -197,10 +197,10 @@ public interface ICampaignsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// ApiResponse of CampaignsTransactionsExportCreateResponseBody - ApiResponse ExportCampaignTransactionsWithHttpInfo(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody = default(CampaignsTransactionsExportCreateRequestBody), int operationIndex = 0); + ApiResponse ExportCampaignTransactionsWithHttpInfo(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody, int operationIndex = 0); /// /// Get Campaign /// @@ -259,10 +259,10 @@ public interface ICampaignsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. /// Index associated with the operation. /// CampaignsImportCreateResponseBody - CampaignsImportCreateResponseBody ImportVouchersToCampaign(string campaignId, List campaignsImportVoucherItem = default(List), int operationIndex = 0); + CampaignsImportCreateResponseBody ImportVouchersToCampaign(string campaignId, List campaignsImportVoucherItem, int operationIndex = 0); /// /// Import Vouchers to Campaign @@ -272,10 +272,10 @@ public interface ICampaignsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. /// Index associated with the operation. /// ApiResponse of CampaignsImportCreateResponseBody - ApiResponse ImportVouchersToCampaignWithHttpInfo(string campaignId, List campaignsImportVoucherItem = default(List), int operationIndex = 0); + ApiResponse ImportVouchersToCampaignWithHttpInfo(string campaignId, List campaignsImportVoucherItem, int operationIndex = 0); /// /// Import Vouchers to Campaign by CSV /// @@ -379,10 +379,10 @@ public interface ICampaignsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the campaign parameters to be updated. (optional) + /// Specify the campaign parameters to be updated. /// Index associated with the operation. /// CampaignsUpdateResponseBody - CampaignsUpdateResponseBody UpdateCampaign(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody = default(CampaignsUpdateRequestBody), int operationIndex = 0); + CampaignsUpdateResponseBody UpdateCampaign(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody, int operationIndex = 0); /// /// Update Campaign @@ -392,10 +392,10 @@ public interface ICampaignsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the campaign parameters to be updated. (optional) + /// Specify the campaign parameters to be updated. /// Index associated with the operation. /// ApiResponse of CampaignsUpdateResponseBody - ApiResponse UpdateCampaignWithHttpInfo(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody = default(CampaignsUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateCampaignWithHttpInfo(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -414,11 +414,11 @@ public interface ICampaignsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. /// A custom **code** that identifies the voucher. - /// Specify the voucher parameters that you would like to overwrite. (optional) + /// Specify the voucher parameters that you would like to overwrite. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsVouchersCreateResponseBody - System.Threading.Tasks.Task AddVoucherWithSpecificCodeToCampaignAsync(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody = default(CampaignsVouchersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task AddVoucherWithSpecificCodeToCampaignAsync(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Add Voucher with Specific Code to Campaign @@ -429,11 +429,11 @@ public interface ICampaignsApiAsync : IApiAccessor /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. /// A custom **code** that identifies the voucher. - /// Specify the voucher parameters that you would like to overwrite. (optional) + /// Specify the voucher parameters that you would like to overwrite. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsVouchersCreateResponseBody) - System.Threading.Tasks.Task> AddVoucherWithSpecificCodeToCampaignWithHttpInfoAsync(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody = default(CampaignsVouchersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> AddVoucherWithSpecificCodeToCampaignWithHttpInfoAsync(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Add Vouchers to Campaign /// @@ -442,12 +442,12 @@ public interface ICampaignsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + /// Specify the voucher parameters that you would like to overwrite. /// Number of vouchers that should be added. (optional) - /// Specify the voucher parameters that you would like to overwrite. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsVouchersCreateCombinedResponseBody - System.Threading.Tasks.Task AddVouchersToCampaignAsync(string campaignId, int? vouchersCount = default(int?), CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody = default(CampaignsVouchersCreateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task AddVouchersToCampaignAsync(string campaignId, CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody, int? vouchersCount = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Add Vouchers to Campaign @@ -457,12 +457,12 @@ public interface ICampaignsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + /// Specify the voucher parameters that you would like to overwrite. /// Number of vouchers that should be added. (optional) - /// Specify the voucher parameters that you would like to overwrite. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsVouchersCreateCombinedResponseBody) - System.Threading.Tasks.Task> AddVouchersToCampaignWithHttpInfoAsync(string campaignId, int? vouchersCount = default(int?), CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody = default(CampaignsVouchersCreateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> AddVouchersToCampaignWithHttpInfoAsync(string campaignId, CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody, int? vouchersCount = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Campaign /// @@ -470,11 +470,11 @@ public interface ICampaignsApiAsync : IApiAccessor /// Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the campaign that you would like to create. (optional) + /// Specify the details of the campaign that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsCreateResponseBody - System.Threading.Tasks.Task CreateCampaignAsync(CampaignsCreateRequestBody campaignsCreateRequestBody = default(CampaignsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateCampaignAsync(CampaignsCreateRequestBody campaignsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Campaign @@ -483,11 +483,11 @@ public interface ICampaignsApiAsync : IApiAccessor /// Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the campaign that you would like to create. (optional) + /// Specify the details of the campaign that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsCreateResponseBody) - System.Threading.Tasks.Task> CreateCampaignWithHttpInfoAsync(CampaignsCreateRequestBody campaignsCreateRequestBody = default(CampaignsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateCampaignWithHttpInfoAsync(CampaignsCreateRequestBody campaignsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Campaign /// @@ -573,11 +573,11 @@ public interface ICampaignsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsTransactionsExportCreateResponseBody - System.Threading.Tasks.Task ExportCampaignTransactionsAsync(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody = default(CampaignsTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task ExportCampaignTransactionsAsync(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Export Campaign Transactions @@ -587,11 +587,11 @@ public interface ICampaignsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) - System.Threading.Tasks.Task> ExportCampaignTransactionsWithHttpInfoAsync(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody = default(CampaignsTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ExportCampaignTransactionsWithHttpInfoAsync(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Get Campaign /// @@ -654,11 +654,11 @@ public interface ICampaignsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsImportCreateResponseBody - System.Threading.Tasks.Task ImportVouchersToCampaignAsync(string campaignId, List campaignsImportVoucherItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task ImportVouchersToCampaignAsync(string campaignId, List campaignsImportVoucherItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Import Vouchers to Campaign @@ -668,11 +668,11 @@ public interface ICampaignsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsImportCreateResponseBody) - System.Threading.Tasks.Task> ImportVouchersToCampaignWithHttpInfoAsync(string campaignId, List campaignsImportVoucherItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ImportVouchersToCampaignWithHttpInfoAsync(string campaignId, List campaignsImportVoucherItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Import Vouchers to Campaign by CSV /// @@ -782,11 +782,11 @@ public interface ICampaignsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the campaign parameters to be updated. (optional) + /// Specify the campaign parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsUpdateResponseBody - System.Threading.Tasks.Task UpdateCampaignAsync(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody = default(CampaignsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateCampaignAsync(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Campaign @@ -796,11 +796,11 @@ public interface ICampaignsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the campaign parameters to be updated. (optional) + /// Specify the campaign parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsUpdateResponseBody) - System.Threading.Tasks.Task> UpdateCampaignWithHttpInfoAsync(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody = default(CampaignsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateCampaignWithHttpInfoAsync(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -927,10 +927,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. /// A custom **code** that identifies the voucher. - /// Specify the voucher parameters that you would like to overwrite. (optional) + /// Specify the voucher parameters that you would like to overwrite. /// Index associated with the operation. /// CampaignsVouchersCreateResponseBody - public CampaignsVouchersCreateResponseBody AddVoucherWithSpecificCodeToCampaign(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody = default(CampaignsVouchersCreateRequestBody), int operationIndex = 0) + public CampaignsVouchersCreateResponseBody AddVoucherWithSpecificCodeToCampaign(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = AddVoucherWithSpecificCodeToCampaignWithHttpInfo(campaignId, code, campaignsVouchersCreateRequestBody); return localVarResponse.Data; @@ -942,10 +942,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. /// A custom **code** that identifies the voucher. - /// Specify the voucher parameters that you would like to overwrite. (optional) + /// Specify the voucher parameters that you would like to overwrite. /// Index associated with the operation. /// ApiResponse of CampaignsVouchersCreateResponseBody - public Voucherify.Client.ApiResponse AddVoucherWithSpecificCodeToCampaignWithHttpInfo(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody = default(CampaignsVouchersCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse AddVoucherWithSpecificCodeToCampaignWithHttpInfo(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -959,6 +959,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'code' when calling CampaignsApi->AddVoucherWithSpecificCodeToCampaign"); } + // verify the required parameter 'campaignsVouchersCreateRequestBody' is set + if (campaignsVouchersCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignsVouchersCreateRequestBody' when calling CampaignsApi->AddVoucherWithSpecificCodeToCampaign"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1037,11 +1043,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. /// A custom **code** that identifies the voucher. - /// Specify the voucher parameters that you would like to overwrite. (optional) + /// Specify the voucher parameters that you would like to overwrite. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsVouchersCreateResponseBody - public async System.Threading.Tasks.Task AddVoucherWithSpecificCodeToCampaignAsync(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody = default(CampaignsVouchersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task AddVoucherWithSpecificCodeToCampaignAsync(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await AddVoucherWithSpecificCodeToCampaignWithHttpInfoAsync(campaignId, code, campaignsVouchersCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1053,11 +1059,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. /// A custom **code** that identifies the voucher. - /// Specify the voucher parameters that you would like to overwrite. (optional) + /// Specify the voucher parameters that you would like to overwrite. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsVouchersCreateResponseBody) - public async System.Threading.Tasks.Task> AddVoucherWithSpecificCodeToCampaignWithHttpInfoAsync(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody = default(CampaignsVouchersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> AddVoucherWithSpecificCodeToCampaignWithHttpInfoAsync(string campaignId, string code, CampaignsVouchersCreateRequestBody campaignsVouchersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -1071,6 +1077,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'code' when calling CampaignsApi->AddVoucherWithSpecificCodeToCampaign"); } + // verify the required parameter 'campaignsVouchersCreateRequestBody' is set + if (campaignsVouchersCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignsVouchersCreateRequestBody' when calling CampaignsApi->AddVoucherWithSpecificCodeToCampaign"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -1149,13 +1161,13 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + /// Specify the voucher parameters that you would like to overwrite. /// Number of vouchers that should be added. (optional) - /// Specify the voucher parameters that you would like to overwrite. (optional) /// Index associated with the operation. /// CampaignsVouchersCreateCombinedResponseBody - public CampaignsVouchersCreateCombinedResponseBody AddVouchersToCampaign(string campaignId, int? vouchersCount = default(int?), CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody = default(CampaignsVouchersCreateInBulkRequestBody), int operationIndex = 0) + public CampaignsVouchersCreateCombinedResponseBody AddVouchersToCampaign(string campaignId, CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody, int? vouchersCount = default(int?), int operationIndex = 0) { - Voucherify.Client.ApiResponse localVarResponse = AddVouchersToCampaignWithHttpInfo(campaignId, vouchersCount, campaignsVouchersCreateInBulkRequestBody); + Voucherify.Client.ApiResponse localVarResponse = AddVouchersToCampaignWithHttpInfo(campaignId, campaignsVouchersCreateInBulkRequestBody, vouchersCount); return localVarResponse.Data; } @@ -1164,11 +1176,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + /// Specify the voucher parameters that you would like to overwrite. /// Number of vouchers that should be added. (optional) - /// Specify the voucher parameters that you would like to overwrite. (optional) /// Index associated with the operation. /// ApiResponse of CampaignsVouchersCreateCombinedResponseBody - public Voucherify.Client.ApiResponse AddVouchersToCampaignWithHttpInfo(string campaignId, int? vouchersCount = default(int?), CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody = default(CampaignsVouchersCreateInBulkRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse AddVouchersToCampaignWithHttpInfo(string campaignId, CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody, int? vouchersCount = default(int?), int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -1176,6 +1188,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling CampaignsApi->AddVouchersToCampaign"); } + // verify the required parameter 'campaignsVouchersCreateInBulkRequestBody' is set + if (campaignsVouchersCreateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignsVouchersCreateInBulkRequestBody' when calling CampaignsApi->AddVouchersToCampaign"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1256,14 +1274,14 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + /// Specify the voucher parameters that you would like to overwrite. /// Number of vouchers that should be added. (optional) - /// Specify the voucher parameters that you would like to overwrite. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsVouchersCreateCombinedResponseBody - public async System.Threading.Tasks.Task AddVouchersToCampaignAsync(string campaignId, int? vouchersCount = default(int?), CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody = default(CampaignsVouchersCreateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task AddVouchersToCampaignAsync(string campaignId, CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody, int? vouchersCount = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { - Voucherify.Client.ApiResponse localVarResponse = await AddVouchersToCampaignWithHttpInfoAsync(campaignId, vouchersCount, campaignsVouchersCreateInBulkRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); + Voucherify.Client.ApiResponse localVarResponse = await AddVouchersToCampaignWithHttpInfoAsync(campaignId, campaignsVouchersCreateInBulkRequestBody, vouchersCount, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1272,12 +1290,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. + /// Specify the voucher parameters that you would like to overwrite. /// Number of vouchers that should be added. (optional) - /// Specify the voucher parameters that you would like to overwrite. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsVouchersCreateCombinedResponseBody) - public async System.Threading.Tasks.Task> AddVouchersToCampaignWithHttpInfoAsync(string campaignId, int? vouchersCount = default(int?), CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody = default(CampaignsVouchersCreateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> AddVouchersToCampaignWithHttpInfoAsync(string campaignId, CampaignsVouchersCreateInBulkRequestBody campaignsVouchersCreateInBulkRequestBody, int? vouchersCount = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -1285,6 +1303,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling CampaignsApi->AddVouchersToCampaign"); } + // verify the required parameter 'campaignsVouchersCreateInBulkRequestBody' is set + if (campaignsVouchersCreateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignsVouchersCreateInBulkRequestBody' when calling CampaignsApi->AddVouchersToCampaign"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -1365,10 +1389,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the campaign that you would like to create. (optional) + /// Specify the details of the campaign that you would like to create. /// Index associated with the operation. /// CampaignsCreateResponseBody - public CampaignsCreateResponseBody CreateCampaign(CampaignsCreateRequestBody campaignsCreateRequestBody = default(CampaignsCreateRequestBody), int operationIndex = 0) + public CampaignsCreateResponseBody CreateCampaign(CampaignsCreateRequestBody campaignsCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateCampaignWithHttpInfo(campaignsCreateRequestBody); return localVarResponse.Data; @@ -1378,11 +1402,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the campaign that you would like to create. (optional) + /// Specify the details of the campaign that you would like to create. /// Index associated with the operation. /// ApiResponse of CampaignsCreateResponseBody - public Voucherify.Client.ApiResponse CreateCampaignWithHttpInfo(CampaignsCreateRequestBody campaignsCreateRequestBody = default(CampaignsCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateCampaignWithHttpInfo(CampaignsCreateRequestBody campaignsCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'campaignsCreateRequestBody' is set + if (campaignsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignsCreateRequestBody' when calling CampaignsApi->CreateCampaign"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1457,11 +1487,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the campaign that you would like to create. (optional) + /// Specify the details of the campaign that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsCreateResponseBody - public async System.Threading.Tasks.Task CreateCampaignAsync(CampaignsCreateRequestBody campaignsCreateRequestBody = default(CampaignsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateCampaignAsync(CampaignsCreateRequestBody campaignsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateCampaignWithHttpInfoAsync(campaignsCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1471,12 +1501,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Campaign Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. πŸ“˜ Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the [campaign object](/api-reference/campaigns/campaign-object) description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the campaign that you would like to create. (optional) + /// Specify the details of the campaign that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsCreateResponseBody) - public async System.Threading.Tasks.Task> CreateCampaignWithHttpInfoAsync(CampaignsCreateRequestBody campaignsCreateRequestBody = default(CampaignsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateCampaignWithHttpInfoAsync(CampaignsCreateRequestBody campaignsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'campaignsCreateRequestBody' is set + if (campaignsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignsCreateRequestBody' when calling CampaignsApi->CreateCampaign"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2156,10 +2192,10 @@ public Voucherify.Client.ApiResponse EnableCampaignWithHttpInfo(string c /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// CampaignsTransactionsExportCreateResponseBody - public CampaignsTransactionsExportCreateResponseBody ExportCampaignTransactions(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody = default(CampaignsTransactionsExportCreateRequestBody), int operationIndex = 0) + public CampaignsTransactionsExportCreateResponseBody ExportCampaignTransactions(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = ExportCampaignTransactionsWithHttpInfo(campaignId, campaignsTransactionsExportCreateRequestBody); return localVarResponse.Data; @@ -2170,10 +2206,10 @@ public Voucherify.Client.ApiResponse EnableCampaignWithHttpInfo(string c /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// ApiResponse of CampaignsTransactionsExportCreateResponseBody - public Voucherify.Client.ApiResponse ExportCampaignTransactionsWithHttpInfo(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody = default(CampaignsTransactionsExportCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse ExportCampaignTransactionsWithHttpInfo(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -2181,6 +2217,12 @@ public Voucherify.Client.ApiResponse EnableCampaignWithHttpInfo(string c throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling CampaignsApi->ExportCampaignTransactions"); } + // verify the required parameter 'campaignsTransactionsExportCreateRequestBody' is set + if (campaignsTransactionsExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignsTransactionsExportCreateRequestBody' when calling CampaignsApi->ExportCampaignTransactions"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -2257,11 +2299,11 @@ public Voucherify.Client.ApiResponse EnableCampaignWithHttpInfo(string c /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsTransactionsExportCreateResponseBody - public async System.Threading.Tasks.Task ExportCampaignTransactionsAsync(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody = default(CampaignsTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ExportCampaignTransactionsAsync(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await ExportCampaignTransactionsWithHttpInfoAsync(campaignId, campaignsTransactionsExportCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -2272,11 +2314,11 @@ public Voucherify.Client.ApiResponse EnableCampaignWithHttpInfo(string c /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) - public async System.Threading.Tasks.Task> ExportCampaignTransactionsWithHttpInfoAsync(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody = default(CampaignsTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ExportCampaignTransactionsWithHttpInfoAsync(string campaignId, CampaignsTransactionsExportCreateRequestBody campaignsTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -2284,6 +2326,12 @@ public Voucherify.Client.ApiResponse EnableCampaignWithHttpInfo(string c throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling CampaignsApi->ExportCampaignTransactions"); } + // verify the required parameter 'campaignsTransactionsExportCreateRequestBody' is set + if (campaignsTransactionsExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignsTransactionsExportCreateRequestBody' when calling CampaignsApi->ExportCampaignTransactions"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2779,10 +2827,10 @@ public Voucherify.Client.ApiResponse GetCampaignWithHt /// /// Thrown when fails to make API call /// The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. /// Index associated with the operation. /// CampaignsImportCreateResponseBody - public CampaignsImportCreateResponseBody ImportVouchersToCampaign(string campaignId, List campaignsImportVoucherItem = default(List), int operationIndex = 0) + public CampaignsImportCreateResponseBody ImportVouchersToCampaign(string campaignId, List campaignsImportVoucherItem, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = ImportVouchersToCampaignWithHttpInfo(campaignId, campaignsImportVoucherItem); return localVarResponse.Data; @@ -2793,10 +2841,10 @@ public Voucherify.Client.ApiResponse GetCampaignWithHt /// /// Thrown when fails to make API call /// The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. /// Index associated with the operation. /// ApiResponse of CampaignsImportCreateResponseBody - public Voucherify.Client.ApiResponse ImportVouchersToCampaignWithHttpInfo(string campaignId, List campaignsImportVoucherItem = default(List), int operationIndex = 0) + public Voucherify.Client.ApiResponse ImportVouchersToCampaignWithHttpInfo(string campaignId, List campaignsImportVoucherItem, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -2804,6 +2852,12 @@ public Voucherify.Client.ApiResponse GetCampaignWithHt throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling CampaignsApi->ImportVouchersToCampaign"); } + // verify the required parameter 'campaignsImportVoucherItem' is set + if (campaignsImportVoucherItem == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignsImportVoucherItem' when calling CampaignsApi->ImportVouchersToCampaign"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -2880,11 +2934,11 @@ public Voucherify.Client.ApiResponse GetCampaignWithHt /// /// Thrown when fails to make API call /// The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsImportCreateResponseBody - public async System.Threading.Tasks.Task ImportVouchersToCampaignAsync(string campaignId, List campaignsImportVoucherItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ImportVouchersToCampaignAsync(string campaignId, List campaignsImportVoucherItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await ImportVouchersToCampaignWithHttpInfoAsync(campaignId, campaignsImportVoucherItem, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -2895,11 +2949,11 @@ public Voucherify.Client.ApiResponse GetCampaignWithHt /// /// Thrown when fails to make API call /// The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. (optional) + /// Discount type, expiration date and the remaining attributes will be taken from the [Campaign](/api-reference/campaigns/get-campaign) settings. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsImportCreateResponseBody) - public async System.Threading.Tasks.Task> ImportVouchersToCampaignWithHttpInfoAsync(string campaignId, List campaignsImportVoucherItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ImportVouchersToCampaignWithHttpInfoAsync(string campaignId, List campaignsImportVoucherItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -2907,6 +2961,12 @@ public Voucherify.Client.ApiResponse GetCampaignWithHt throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling CampaignsApi->ImportVouchersToCampaign"); } + // verify the required parameter 'campaignsImportVoucherItem' is set + if (campaignsImportVoucherItem == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignsImportVoucherItem' when calling CampaignsApi->ImportVouchersToCampaign"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -3889,10 +3949,10 @@ public Voucherify.Client.ApiResponse GetCampaignWithHt /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the campaign parameters to be updated. (optional) + /// Specify the campaign parameters to be updated. /// Index associated with the operation. /// CampaignsUpdateResponseBody - public CampaignsUpdateResponseBody UpdateCampaign(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody = default(CampaignsUpdateRequestBody), int operationIndex = 0) + public CampaignsUpdateResponseBody UpdateCampaign(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateCampaignWithHttpInfo(campaignId, campaignsUpdateRequestBody); return localVarResponse.Data; @@ -3903,10 +3963,10 @@ public Voucherify.Client.ApiResponse GetCampaignWithHt /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the campaign parameters to be updated. (optional) + /// Specify the campaign parameters to be updated. /// Index associated with the operation. /// ApiResponse of CampaignsUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateCampaignWithHttpInfo(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody = default(CampaignsUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateCampaignWithHttpInfo(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -3914,6 +3974,12 @@ public Voucherify.Client.ApiResponse GetCampaignWithHt throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling CampaignsApi->UpdateCampaign"); } + // verify the required parameter 'campaignsUpdateRequestBody' is set + if (campaignsUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignsUpdateRequestBody' when calling CampaignsApi->UpdateCampaign"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3990,11 +4056,11 @@ public Voucherify.Client.ApiResponse GetCampaignWithHt /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the campaign parameters to be updated. (optional) + /// Specify the campaign parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsUpdateResponseBody - public async System.Threading.Tasks.Task UpdateCampaignAsync(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody = default(CampaignsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateCampaignAsync(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateCampaignWithHttpInfoAsync(campaignId, campaignsUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -4005,11 +4071,11 @@ public Voucherify.Client.ApiResponse GetCampaignWithHt /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the campaign parameters to be updated. (optional) + /// Specify the campaign parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateCampaignWithHttpInfoAsync(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody = default(CampaignsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateCampaignWithHttpInfoAsync(string campaignId, CampaignsUpdateRequestBody campaignsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -4017,6 +4083,12 @@ public Voucherify.Client.ApiResponse GetCampaignWithHt throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling CampaignsApi->UpdateCampaign"); } + // verify the required parameter 'campaignsUpdateRequestBody' is set + if (campaignsUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignsUpdateRequestBody' when calling CampaignsApi->UpdateCampaign"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/CategoriesApi.cs b/src/Voucherify/Api/CategoriesApi.cs index 39d3aa44..3523727d 100644 --- a/src/Voucherify/Api/CategoriesApi.cs +++ b/src/Voucherify/Api/CategoriesApi.cs @@ -35,10 +35,10 @@ public interface ICategoriesApiSync : IApiAccessor /// Create category with a specific name and hierarchy. /// /// Thrown when fails to make API call - /// Specify the details of the category that you would like to create. (optional) + /// Specify the details of the category that you would like to create. /// Index associated with the operation. /// CategoriesCreateResponseBody - CategoriesCreateResponseBody CreateCategory(CategoriesCreateRequestBody categoriesCreateRequestBody = default(CategoriesCreateRequestBody), int operationIndex = 0); + CategoriesCreateResponseBody CreateCategory(CategoriesCreateRequestBody categoriesCreateRequestBody, int operationIndex = 0); /// /// Create Category @@ -47,10 +47,10 @@ public interface ICategoriesApiSync : IApiAccessor /// Create category with a specific name and hierarchy. /// /// Thrown when fails to make API call - /// Specify the details of the category that you would like to create. (optional) + /// Specify the details of the category that you would like to create. /// Index associated with the operation. /// ApiResponse of CategoriesCreateResponseBody - ApiResponse CreateCategoryWithHttpInfo(CategoriesCreateRequestBody categoriesCreateRequestBody = default(CategoriesCreateRequestBody), int operationIndex = 0); + ApiResponse CreateCategoryWithHttpInfo(CategoriesCreateRequestBody categoriesCreateRequestBody, int operationIndex = 0); /// /// Delete Category /// @@ -126,10 +126,10 @@ public interface ICategoriesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique category ID assigned by Voucherify. - /// Specify the details of the category that you would like to update. (optional) + /// Specify the details of the category that you would like to update. /// Index associated with the operation. /// CategoriesUpdateResponseBody - CategoriesUpdateResponseBody UpdateCategory(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody = default(CategoriesUpdateRequestBody), int operationIndex = 0); + CategoriesUpdateResponseBody UpdateCategory(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody, int operationIndex = 0); /// /// Update Category @@ -139,10 +139,10 @@ public interface ICategoriesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique category ID assigned by Voucherify. - /// Specify the details of the category that you would like to update. (optional) + /// Specify the details of the category that you would like to update. /// Index associated with the operation. /// ApiResponse of CategoriesUpdateResponseBody - ApiResponse UpdateCategoryWithHttpInfo(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody = default(CategoriesUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateCategoryWithHttpInfo(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -159,11 +159,11 @@ public interface ICategoriesApiAsync : IApiAccessor /// Create category with a specific name and hierarchy. /// /// Thrown when fails to make API call - /// Specify the details of the category that you would like to create. (optional) + /// Specify the details of the category that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CategoriesCreateResponseBody - System.Threading.Tasks.Task CreateCategoryAsync(CategoriesCreateRequestBody categoriesCreateRequestBody = default(CategoriesCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateCategoryAsync(CategoriesCreateRequestBody categoriesCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Category @@ -172,11 +172,11 @@ public interface ICategoriesApiAsync : IApiAccessor /// Create category with a specific name and hierarchy. /// /// Thrown when fails to make API call - /// Specify the details of the category that you would like to create. (optional) + /// Specify the details of the category that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CategoriesCreateResponseBody) - System.Threading.Tasks.Task> CreateCategoryWithHttpInfoAsync(CategoriesCreateRequestBody categoriesCreateRequestBody = default(CategoriesCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateCategoryWithHttpInfoAsync(CategoriesCreateRequestBody categoriesCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Category /// @@ -258,11 +258,11 @@ public interface ICategoriesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique category ID assigned by Voucherify. - /// Specify the details of the category that you would like to update. (optional) + /// Specify the details of the category that you would like to update. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CategoriesUpdateResponseBody - System.Threading.Tasks.Task UpdateCategoryAsync(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody = default(CategoriesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateCategoryAsync(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Category @@ -272,11 +272,11 @@ public interface ICategoriesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique category ID assigned by Voucherify. - /// Specify the details of the category that you would like to update. (optional) + /// Specify the details of the category that you would like to update. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CategoriesUpdateResponseBody) - System.Threading.Tasks.Task> UpdateCategoryWithHttpInfoAsync(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody = default(CategoriesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateCategoryWithHttpInfoAsync(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -401,10 +401,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Category Create category with a specific name and hierarchy. /// /// Thrown when fails to make API call - /// Specify the details of the category that you would like to create. (optional) + /// Specify the details of the category that you would like to create. /// Index associated with the operation. /// CategoriesCreateResponseBody - public CategoriesCreateResponseBody CreateCategory(CategoriesCreateRequestBody categoriesCreateRequestBody = default(CategoriesCreateRequestBody), int operationIndex = 0) + public CategoriesCreateResponseBody CreateCategory(CategoriesCreateRequestBody categoriesCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateCategoryWithHttpInfo(categoriesCreateRequestBody); return localVarResponse.Data; @@ -414,11 +414,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Category Create category with a specific name and hierarchy. /// /// Thrown when fails to make API call - /// Specify the details of the category that you would like to create. (optional) + /// Specify the details of the category that you would like to create. /// Index associated with the operation. /// ApiResponse of CategoriesCreateResponseBody - public Voucherify.Client.ApiResponse CreateCategoryWithHttpInfo(CategoriesCreateRequestBody categoriesCreateRequestBody = default(CategoriesCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateCategoryWithHttpInfo(CategoriesCreateRequestBody categoriesCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'categoriesCreateRequestBody' is set + if (categoriesCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'categoriesCreateRequestBody' when calling CategoriesApi->CreateCategory"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -493,11 +499,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Category Create category with a specific name and hierarchy. /// /// Thrown when fails to make API call - /// Specify the details of the category that you would like to create. (optional) + /// Specify the details of the category that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CategoriesCreateResponseBody - public async System.Threading.Tasks.Task CreateCategoryAsync(CategoriesCreateRequestBody categoriesCreateRequestBody = default(CategoriesCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateCategoryAsync(CategoriesCreateRequestBody categoriesCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateCategoryWithHttpInfoAsync(categoriesCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -507,12 +513,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Category Create category with a specific name and hierarchy. /// /// Thrown when fails to make API call - /// Specify the details of the category that you would like to create. (optional) + /// Specify the details of the category that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CategoriesCreateResponseBody) - public async System.Threading.Tasks.Task> CreateCategoryWithHttpInfoAsync(CategoriesCreateRequestBody categoriesCreateRequestBody = default(CategoriesCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateCategoryWithHttpInfoAsync(CategoriesCreateRequestBody categoriesCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'categoriesCreateRequestBody' is set + if (categoriesCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'categoriesCreateRequestBody' when calling CategoriesApi->CreateCategory"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -1158,10 +1170,10 @@ public Voucherify.Client.ApiResponse ListCategoriesW /// /// Thrown when fails to make API call /// Unique category ID assigned by Voucherify. - /// Specify the details of the category that you would like to update. (optional) + /// Specify the details of the category that you would like to update. /// Index associated with the operation. /// CategoriesUpdateResponseBody - public CategoriesUpdateResponseBody UpdateCategory(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody = default(CategoriesUpdateRequestBody), int operationIndex = 0) + public CategoriesUpdateResponseBody UpdateCategory(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateCategoryWithHttpInfo(categoryId, categoriesUpdateRequestBody); return localVarResponse.Data; @@ -1172,10 +1184,10 @@ public Voucherify.Client.ApiResponse ListCategoriesW /// /// Thrown when fails to make API call /// Unique category ID assigned by Voucherify. - /// Specify the details of the category that you would like to update. (optional) + /// Specify the details of the category that you would like to update. /// Index associated with the operation. /// ApiResponse of CategoriesUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateCategoryWithHttpInfo(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody = default(CategoriesUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateCategoryWithHttpInfo(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'categoryId' is set if (categoryId == null) @@ -1183,6 +1195,12 @@ public Voucherify.Client.ApiResponse ListCategoriesW throw new Voucherify.Client.ApiException(400, "Missing required parameter 'categoryId' when calling CategoriesApi->UpdateCategory"); } + // verify the required parameter 'categoriesUpdateRequestBody' is set + if (categoriesUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'categoriesUpdateRequestBody' when calling CategoriesApi->UpdateCategory"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1259,11 +1277,11 @@ public Voucherify.Client.ApiResponse ListCategoriesW /// /// Thrown when fails to make API call /// Unique category ID assigned by Voucherify. - /// Specify the details of the category that you would like to update. (optional) + /// Specify the details of the category that you would like to update. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CategoriesUpdateResponseBody - public async System.Threading.Tasks.Task UpdateCategoryAsync(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody = default(CategoriesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateCategoryAsync(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateCategoryWithHttpInfoAsync(categoryId, categoriesUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1274,11 +1292,11 @@ public Voucherify.Client.ApiResponse ListCategoriesW /// /// Thrown when fails to make API call /// Unique category ID assigned by Voucherify. - /// Specify the details of the category that you would like to update. (optional) + /// Specify the details of the category that you would like to update. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CategoriesUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateCategoryWithHttpInfoAsync(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody = default(CategoriesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateCategoryWithHttpInfoAsync(string categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'categoryId' is set if (categoryId == null) @@ -1286,6 +1304,12 @@ public Voucherify.Client.ApiResponse ListCategoriesW throw new Voucherify.Client.ApiException(400, "Missing required parameter 'categoryId' when calling CategoriesApi->UpdateCategory"); } + // verify the required parameter 'categoriesUpdateRequestBody' is set + if (categoriesUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'categoriesUpdateRequestBody' when calling CategoriesApi->UpdateCategory"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/ClientSideApi.cs b/src/Voucherify/Api/ClientSideApi.cs index 72759a04..5abaa9ee 100644 --- a/src/Voucherify/Api/ClientSideApi.cs +++ b/src/Voucherify/Api/ClientSideApi.cs @@ -35,10 +35,10 @@ public interface IClientSideApiSync : IApiAccessor /// Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// ClientQualificationsCheckEligibilityResponseBody - ClientQualificationsCheckEligibilityResponseBody CheckEligibilityClientSide(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody = default(ClientQualificationsCheckEligibilityRequestBody), int operationIndex = 0); + ClientQualificationsCheckEligibilityResponseBody CheckEligibilityClientSide(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody, int operationIndex = 0); /// /// Check Eligibility (client-side) @@ -47,10 +47,10 @@ public interface IClientSideApiSync : IApiAccessor /// Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// ApiResponse of ClientQualificationsCheckEligibilityResponseBody - ApiResponse CheckEligibilityClientSideWithHttpInfo(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody = default(ClientQualificationsCheckEligibilityRequestBody), int operationIndex = 0); + ApiResponse CheckEligibilityClientSideWithHttpInfo(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody, int operationIndex = 0); /// /// List Promotion Tiers (client-side) /// @@ -90,10 +90,10 @@ public interface IClientSideApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// ClientRedemptionsRedeemResponseBody - ClientRedemptionsRedeemResponseBody RedeemStackedDiscountsClientSide(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody = default(ClientRedemptionsRedeemRequestBody), int operationIndex = 0); + ClientRedemptionsRedeemResponseBody RedeemStackedDiscountsClientSide(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody, int operationIndex = 0); /// /// Redeem Stackable Discounts (client-side) @@ -103,10 +103,10 @@ public interface IClientSideApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// ApiResponse of ClientRedemptionsRedeemResponseBody - ApiResponse RedeemStackedDiscountsClientSideWithHttpInfo(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody = default(ClientRedemptionsRedeemRequestBody), int operationIndex = 0); + ApiResponse RedeemStackedDiscountsClientSideWithHttpInfo(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody, int operationIndex = 0); /// /// Track Custom Event (client-side) /// @@ -115,10 +115,10 @@ public interface IClientSideApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// ClientEventsCreateResponseBody - ClientEventsCreateResponseBody TrackCustomEventClientSide(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody = default(ClientEventsCreateRequestBody), int operationIndex = 0); + ClientEventsCreateResponseBody TrackCustomEventClientSide(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody, int operationIndex = 0); /// /// Track Custom Event (client-side) @@ -128,10 +128,10 @@ public interface IClientSideApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// ApiResponse of ClientEventsCreateResponseBody - ApiResponse TrackCustomEventClientSideWithHttpInfo(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody = default(ClientEventsCreateRequestBody), int operationIndex = 0); + ApiResponse TrackCustomEventClientSideWithHttpInfo(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody, int operationIndex = 0); /// /// Validate Stackable Discounts (client-side) /// @@ -140,10 +140,10 @@ public interface IClientSideApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// ClientValidationsValidateResponseBody - ClientValidationsValidateResponseBody ValidateStackedDiscountsClientSide(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody = default(ClientValidationsValidateRequestBody), int operationIndex = 0); + ClientValidationsValidateResponseBody ValidateStackedDiscountsClientSide(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody, int operationIndex = 0); /// /// Validate Stackable Discounts (client-side) @@ -153,10 +153,10 @@ public interface IClientSideApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// ApiResponse of ClientValidationsValidateResponseBody - ApiResponse ValidateStackedDiscountsClientSideWithHttpInfo(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody = default(ClientValidationsValidateRequestBody), int operationIndex = 0); + ApiResponse ValidateStackedDiscountsClientSideWithHttpInfo(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -173,11 +173,11 @@ public interface IClientSideApiAsync : IApiAccessor /// Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ClientQualificationsCheckEligibilityResponseBody - System.Threading.Tasks.Task CheckEligibilityClientSideAsync(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody = default(ClientQualificationsCheckEligibilityRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CheckEligibilityClientSideAsync(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Check Eligibility (client-side) @@ -186,11 +186,11 @@ public interface IClientSideApiAsync : IApiAccessor /// Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ClientQualificationsCheckEligibilityResponseBody) - System.Threading.Tasks.Task> CheckEligibilityClientSideWithHttpInfoAsync(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody = default(ClientQualificationsCheckEligibilityRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CheckEligibilityClientSideWithHttpInfoAsync(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// List Promotion Tiers (client-side) /// @@ -232,11 +232,11 @@ public interface IClientSideApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ClientRedemptionsRedeemResponseBody - System.Threading.Tasks.Task RedeemStackedDiscountsClientSideAsync(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody = default(ClientRedemptionsRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task RedeemStackedDiscountsClientSideAsync(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Redeem Stackable Discounts (client-side) @@ -246,11 +246,11 @@ public interface IClientSideApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ClientRedemptionsRedeemResponseBody) - System.Threading.Tasks.Task> RedeemStackedDiscountsClientSideWithHttpInfoAsync(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody = default(ClientRedemptionsRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> RedeemStackedDiscountsClientSideWithHttpInfoAsync(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Track Custom Event (client-side) /// @@ -259,11 +259,11 @@ public interface IClientSideApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ClientEventsCreateResponseBody - System.Threading.Tasks.Task TrackCustomEventClientSideAsync(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody = default(ClientEventsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task TrackCustomEventClientSideAsync(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Track Custom Event (client-side) @@ -273,11 +273,11 @@ public interface IClientSideApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ClientEventsCreateResponseBody) - System.Threading.Tasks.Task> TrackCustomEventClientSideWithHttpInfoAsync(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody = default(ClientEventsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> TrackCustomEventClientSideWithHttpInfoAsync(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Validate Stackable Discounts (client-side) /// @@ -286,11 +286,11 @@ public interface IClientSideApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ClientValidationsValidateResponseBody - System.Threading.Tasks.Task ValidateStackedDiscountsClientSideAsync(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody = default(ClientValidationsValidateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task ValidateStackedDiscountsClientSideAsync(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Validate Stackable Discounts (client-side) @@ -300,11 +300,11 @@ public interface IClientSideApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ClientValidationsValidateResponseBody) - System.Threading.Tasks.Task> ValidateStackedDiscountsClientSideWithHttpInfoAsync(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody = default(ClientValidationsValidateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ValidateStackedDiscountsClientSideWithHttpInfoAsync(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -429,10 +429,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// ClientQualificationsCheckEligibilityResponseBody - public ClientQualificationsCheckEligibilityResponseBody CheckEligibilityClientSide(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody = default(ClientQualificationsCheckEligibilityRequestBody), int operationIndex = 0) + public ClientQualificationsCheckEligibilityResponseBody CheckEligibilityClientSide(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CheckEligibilityClientSideWithHttpInfo(clientQualificationsCheckEligibilityRequestBody); return localVarResponse.Data; @@ -442,11 +442,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// ApiResponse of ClientQualificationsCheckEligibilityResponseBody - public Voucherify.Client.ApiResponse CheckEligibilityClientSideWithHttpInfo(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody = default(ClientQualificationsCheckEligibilityRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CheckEligibilityClientSideWithHttpInfo(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody, int operationIndex = 0) { + // verify the required parameter 'clientQualificationsCheckEligibilityRequestBody' is set + if (clientQualificationsCheckEligibilityRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'clientQualificationsCheckEligibilityRequestBody' when calling ClientSideApi->CheckEligibilityClientSide"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -521,11 +527,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ClientQualificationsCheckEligibilityResponseBody - public async System.Threading.Tasks.Task CheckEligibilityClientSideAsync(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody = default(ClientQualificationsCheckEligibilityRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CheckEligibilityClientSideAsync(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CheckEligibilityClientSideWithHttpInfoAsync(clientQualificationsCheckEligibilityRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -535,12 +541,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Check Eligibility (client-side) Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility). # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ClientQualificationsCheckEligibilityResponseBody) - public async System.Threading.Tasks.Task> CheckEligibilityClientSideWithHttpInfoAsync(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody = default(ClientQualificationsCheckEligibilityRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CheckEligibilityClientSideWithHttpInfoAsync(ClientQualificationsCheckEligibilityRequestBody clientQualificationsCheckEligibilityRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'clientQualificationsCheckEligibilityRequestBody' is set + if (clientQualificationsCheckEligibilityRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'clientQualificationsCheckEligibilityRequestBody' when calling ClientSideApi->CheckEligibilityClientSide"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -862,10 +874,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// ClientRedemptionsRedeemResponseBody - public ClientRedemptionsRedeemResponseBody RedeemStackedDiscountsClientSide(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody = default(ClientRedemptionsRedeemRequestBody), int operationIndex = 0) + public ClientRedemptionsRedeemResponseBody RedeemStackedDiscountsClientSide(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = RedeemStackedDiscountsClientSideWithHttpInfo(origin, clientRedemptionsRedeemRequestBody); return localVarResponse.Data; @@ -876,10 +888,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// ApiResponse of ClientRedemptionsRedeemResponseBody - public Voucherify.Client.ApiResponse RedeemStackedDiscountsClientSideWithHttpInfo(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody = default(ClientRedemptionsRedeemRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse RedeemStackedDiscountsClientSideWithHttpInfo(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody, int operationIndex = 0) { // verify the required parameter 'origin' is set if (origin == null) @@ -887,6 +899,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'origin' when calling ClientSideApi->RedeemStackedDiscountsClientSide"); } + // verify the required parameter 'clientRedemptionsRedeemRequestBody' is set + if (clientRedemptionsRedeemRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'clientRedemptionsRedeemRequestBody' when calling ClientSideApi->RedeemStackedDiscountsClientSide"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -963,11 +981,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ClientRedemptionsRedeemResponseBody - public async System.Threading.Tasks.Task RedeemStackedDiscountsClientSideAsync(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody = default(ClientRedemptionsRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task RedeemStackedDiscountsClientSideAsync(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await RedeemStackedDiscountsClientSideWithHttpInfoAsync(origin, clientRedemptionsRedeemRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -978,11 +996,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ClientRedemptionsRedeemResponseBody) - public async System.Threading.Tasks.Task> RedeemStackedDiscountsClientSideWithHttpInfoAsync(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody = default(ClientRedemptionsRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> RedeemStackedDiscountsClientSideWithHttpInfoAsync(string origin, ClientRedemptionsRedeemRequestBody clientRedemptionsRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'origin' is set if (origin == null) @@ -990,6 +1008,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'origin' when calling ClientSideApi->RedeemStackedDiscountsClientSide"); } + // verify the required parameter 'clientRedemptionsRedeemRequestBody' is set + if (clientRedemptionsRedeemRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'clientRedemptionsRedeemRequestBody' when calling ClientSideApi->RedeemStackedDiscountsClientSide"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -1067,10 +1091,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// ClientEventsCreateResponseBody - public ClientEventsCreateResponseBody TrackCustomEventClientSide(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody = default(ClientEventsCreateRequestBody), int operationIndex = 0) + public ClientEventsCreateResponseBody TrackCustomEventClientSide(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = TrackCustomEventClientSideWithHttpInfo(origin, clientEventsCreateRequestBody); return localVarResponse.Data; @@ -1081,10 +1105,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// ApiResponse of ClientEventsCreateResponseBody - public Voucherify.Client.ApiResponse TrackCustomEventClientSideWithHttpInfo(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody = default(ClientEventsCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse TrackCustomEventClientSideWithHttpInfo(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'origin' is set if (origin == null) @@ -1092,6 +1116,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'origin' when calling ClientSideApi->TrackCustomEventClientSide"); } + // verify the required parameter 'clientEventsCreateRequestBody' is set + if (clientEventsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'clientEventsCreateRequestBody' when calling ClientSideApi->TrackCustomEventClientSide"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1168,11 +1198,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ClientEventsCreateResponseBody - public async System.Threading.Tasks.Task TrackCustomEventClientSideAsync(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody = default(ClientEventsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task TrackCustomEventClientSideAsync(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await TrackCustomEventClientSideWithHttpInfoAsync(origin, clientEventsCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1183,11 +1213,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ClientEventsCreateResponseBody) - public async System.Threading.Tasks.Task> TrackCustomEventClientSideWithHttpInfoAsync(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody = default(ClientEventsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> TrackCustomEventClientSideWithHttpInfoAsync(string origin, ClientEventsCreateRequestBody clientEventsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'origin' is set if (origin == null) @@ -1195,6 +1225,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'origin' when calling ClientSideApi->TrackCustomEventClientSide"); } + // verify the required parameter 'clientEventsCreateRequestBody' is set + if (clientEventsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'clientEventsCreateRequestBody' when calling ClientSideApi->TrackCustomEventClientSide"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -1272,10 +1308,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// ClientValidationsValidateResponseBody - public ClientValidationsValidateResponseBody ValidateStackedDiscountsClientSide(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody = default(ClientValidationsValidateRequestBody), int operationIndex = 0) + public ClientValidationsValidateResponseBody ValidateStackedDiscountsClientSide(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = ValidateStackedDiscountsClientSideWithHttpInfo(origin, clientValidationsValidateRequestBody); return localVarResponse.Data; @@ -1286,10 +1322,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// ApiResponse of ClientValidationsValidateResponseBody - public Voucherify.Client.ApiResponse ValidateStackedDiscountsClientSideWithHttpInfo(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody = default(ClientValidationsValidateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse ValidateStackedDiscountsClientSideWithHttpInfo(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody, int operationIndex = 0) { // verify the required parameter 'origin' is set if (origin == null) @@ -1297,6 +1333,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'origin' when calling ClientSideApi->ValidateStackedDiscountsClientSide"); } + // verify the required parameter 'clientValidationsValidateRequestBody' is set + if (clientValidationsValidateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'clientValidationsValidateRequestBody' when calling ClientSideApi->ValidateStackedDiscountsClientSide"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1373,11 +1415,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ClientValidationsValidateResponseBody - public async System.Threading.Tasks.Task ValidateStackedDiscountsClientSideAsync(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody = default(ClientValidationsValidateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ValidateStackedDiscountsClientSideAsync(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await ValidateStackedDiscountsClientSideWithHttpInfoAsync(origin, clientValidationsValidateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1388,11 +1430,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Indicates the origin (scheme, hostname, and port). - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ClientValidationsValidateResponseBody) - public async System.Threading.Tasks.Task> ValidateStackedDiscountsClientSideWithHttpInfoAsync(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody = default(ClientValidationsValidateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ValidateStackedDiscountsClientSideWithHttpInfoAsync(string origin, ClientValidationsValidateRequestBody clientValidationsValidateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'origin' is set if (origin == null) @@ -1400,6 +1442,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'origin' when calling ClientSideApi->ValidateStackedDiscountsClientSide"); } + // verify the required parameter 'clientValidationsValidateRequestBody' is set + if (clientValidationsValidateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'clientValidationsValidateRequestBody' when calling ClientSideApi->ValidateStackedDiscountsClientSide"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/CustomersApi.cs b/src/Voucherify/Api/CustomersApi.cs index 80c01490..e50c5d2f 100644 --- a/src/Voucherify/Api/CustomersApi.cs +++ b/src/Voucherify/Api/CustomersApi.cs @@ -35,10 +35,10 @@ public interface ICustomersApiSync : IApiAccessor /// Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. /// /// Thrown when fails to make API call - /// Create a customer with specified parameters. (optional) + /// Create a customer with specified parameters. /// Index associated with the operation. /// CustomersCreateResponseBody - CustomersCreateResponseBody CreateCustomer(CustomersCreateRequestBody customersCreateRequestBody = default(CustomersCreateRequestBody), int operationIndex = 0); + CustomersCreateResponseBody CreateCustomer(CustomersCreateRequestBody customersCreateRequestBody, int operationIndex = 0); /// /// Create Customer @@ -47,10 +47,10 @@ public interface ICustomersApiSync : IApiAccessor /// Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. /// /// Thrown when fails to make API call - /// Create a customer with specified parameters. (optional) + /// Create a customer with specified parameters. /// Index associated with the operation. /// ApiResponse of CustomersCreateResponseBody - ApiResponse CreateCustomerWithHttpInfo(CustomersCreateRequestBody customersCreateRequestBody = default(CustomersCreateRequestBody), int operationIndex = 0); + ApiResponse CreateCustomerWithHttpInfo(CustomersCreateRequestBody customersCreateRequestBody, int operationIndex = 0); /// /// Delete Customer Permanently /// @@ -291,10 +291,10 @@ public interface ICustomersApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A Voucherify customers id or source_id. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// CustomersUpdateResponseBody - CustomersUpdateResponseBody UpdateCustomer(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody = default(CustomersUpdateRequestBody), int operationIndex = 0); + CustomersUpdateResponseBody UpdateCustomer(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody, int operationIndex = 0); /// /// Update Customer @@ -304,10 +304,10 @@ public interface ICustomersApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A Voucherify customers id or source_id. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// ApiResponse of CustomersUpdateResponseBody - ApiResponse UpdateCustomerWithHttpInfo(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody = default(CustomersUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateCustomerWithHttpInfo(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody, int operationIndex = 0); /// /// Update Customers in Bulk /// @@ -315,10 +315,10 @@ public interface ICustomersApiSync : IApiAccessor /// Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the customer fields to be updated in each customer object. (optional) + /// List the customer fields to be updated in each customer object. /// Index associated with the operation. /// CustomersUpdateInBulkResponseBody - CustomersUpdateInBulkResponseBody UpdateCustomersInBulk(List customersUpdateInBulkRequestBody = default(List), int operationIndex = 0); + CustomersUpdateInBulkResponseBody UpdateCustomersInBulk(List customersUpdateInBulkRequestBody, int operationIndex = 0); /// /// Update Customers in Bulk @@ -327,10 +327,10 @@ public interface ICustomersApiSync : IApiAccessor /// Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the customer fields to be updated in each customer object. (optional) + /// List the customer fields to be updated in each customer object. /// Index associated with the operation. /// ApiResponse of CustomersUpdateInBulkResponseBody - ApiResponse UpdateCustomersInBulkWithHttpInfo(List customersUpdateInBulkRequestBody = default(List), int operationIndex = 0); + ApiResponse UpdateCustomersInBulkWithHttpInfo(List customersUpdateInBulkRequestBody, int operationIndex = 0); /// /// Update Customers' Metadata in Bulk /// @@ -338,10 +338,10 @@ public interface ICustomersApiSync : IApiAccessor /// Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the customers you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// CustomersMetadataUpdateInBulkResponseBody - CustomersMetadataUpdateInBulkResponseBody UpdateCustomersMetadataInBulk(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody = default(CustomersMetadataUpdateInBulkRequestBody), int operationIndex = 0); + CustomersMetadataUpdateInBulkResponseBody UpdateCustomersMetadataInBulk(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody, int operationIndex = 0); /// /// Update Customers' Metadata in Bulk @@ -350,10 +350,10 @@ public interface ICustomersApiSync : IApiAccessor /// Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the customers you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// ApiResponse of CustomersMetadataUpdateInBulkResponseBody - ApiResponse UpdateCustomersMetadataInBulkWithHttpInfo(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody = default(CustomersMetadataUpdateInBulkRequestBody), int operationIndex = 0); + ApiResponse UpdateCustomersMetadataInBulkWithHttpInfo(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -370,11 +370,11 @@ public interface ICustomersApiAsync : IApiAccessor /// Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. /// /// Thrown when fails to make API call - /// Create a customer with specified parameters. (optional) + /// Create a customer with specified parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CustomersCreateResponseBody - System.Threading.Tasks.Task CreateCustomerAsync(CustomersCreateRequestBody customersCreateRequestBody = default(CustomersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateCustomerAsync(CustomersCreateRequestBody customersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Customer @@ -383,11 +383,11 @@ public interface ICustomersApiAsync : IApiAccessor /// Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. /// /// Thrown when fails to make API call - /// Create a customer with specified parameters. (optional) + /// Create a customer with specified parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CustomersCreateResponseBody) - System.Threading.Tasks.Task> CreateCustomerWithHttpInfoAsync(CustomersCreateRequestBody customersCreateRequestBody = default(CustomersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateCustomerWithHttpInfoAsync(CustomersCreateRequestBody customersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Customer Permanently /// @@ -644,11 +644,11 @@ public interface ICustomersApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A Voucherify customers id or source_id. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CustomersUpdateResponseBody - System.Threading.Tasks.Task UpdateCustomerAsync(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody = default(CustomersUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateCustomerAsync(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Customer @@ -658,11 +658,11 @@ public interface ICustomersApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A Voucherify customers id or source_id. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CustomersUpdateResponseBody) - System.Threading.Tasks.Task> UpdateCustomerWithHttpInfoAsync(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody = default(CustomersUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateCustomerWithHttpInfoAsync(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Customers in Bulk /// @@ -670,11 +670,11 @@ public interface ICustomersApiAsync : IApiAccessor /// Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the customer fields to be updated in each customer object. (optional) + /// List the customer fields to be updated in each customer object. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CustomersUpdateInBulkResponseBody - System.Threading.Tasks.Task UpdateCustomersInBulkAsync(List customersUpdateInBulkRequestBody = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateCustomersInBulkAsync(List customersUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Customers in Bulk @@ -683,11 +683,11 @@ public interface ICustomersApiAsync : IApiAccessor /// Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the customer fields to be updated in each customer object. (optional) + /// List the customer fields to be updated in each customer object. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CustomersUpdateInBulkResponseBody) - System.Threading.Tasks.Task> UpdateCustomersInBulkWithHttpInfoAsync(List customersUpdateInBulkRequestBody = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateCustomersInBulkWithHttpInfoAsync(List customersUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Customers' Metadata in Bulk /// @@ -695,11 +695,11 @@ public interface ICustomersApiAsync : IApiAccessor /// Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the customers you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CustomersMetadataUpdateInBulkResponseBody - System.Threading.Tasks.Task UpdateCustomersMetadataInBulkAsync(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody = default(CustomersMetadataUpdateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateCustomersMetadataInBulkAsync(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Customers' Metadata in Bulk @@ -708,11 +708,11 @@ public interface ICustomersApiAsync : IApiAccessor /// Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the customers you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CustomersMetadataUpdateInBulkResponseBody) - System.Threading.Tasks.Task> UpdateCustomersMetadataInBulkWithHttpInfoAsync(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody = default(CustomersMetadataUpdateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateCustomersMetadataInBulkWithHttpInfoAsync(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -837,10 +837,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. /// /// Thrown when fails to make API call - /// Create a customer with specified parameters. (optional) + /// Create a customer with specified parameters. /// Index associated with the operation. /// CustomersCreateResponseBody - public CustomersCreateResponseBody CreateCustomer(CustomersCreateRequestBody customersCreateRequestBody = default(CustomersCreateRequestBody), int operationIndex = 0) + public CustomersCreateResponseBody CreateCustomer(CustomersCreateRequestBody customersCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateCustomerWithHttpInfo(customersCreateRequestBody); return localVarResponse.Data; @@ -850,11 +850,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. /// /// Thrown when fails to make API call - /// Create a customer with specified parameters. (optional) + /// Create a customer with specified parameters. /// Index associated with the operation. /// ApiResponse of CustomersCreateResponseBody - public Voucherify.Client.ApiResponse CreateCustomerWithHttpInfo(CustomersCreateRequestBody customersCreateRequestBody = default(CustomersCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateCustomerWithHttpInfo(CustomersCreateRequestBody customersCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'customersCreateRequestBody' is set + if (customersCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'customersCreateRequestBody' when calling CustomersApi->CreateCustomer"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -929,11 +935,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. /// /// Thrown when fails to make API call - /// Create a customer with specified parameters. (optional) + /// Create a customer with specified parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CustomersCreateResponseBody - public async System.Threading.Tasks.Task CreateCustomerAsync(CustomersCreateRequestBody customersCreateRequestBody = default(CustomersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateCustomerAsync(CustomersCreateRequestBody customersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateCustomerWithHttpInfoAsync(customersCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -943,12 +949,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Customer Creates a customer object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the customer database, Voucherify will return a related customer object with updated fields. /// /// Thrown when fails to make API call - /// Create a customer with specified parameters. (optional) + /// Create a customer with specified parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CustomersCreateResponseBody) - public async System.Threading.Tasks.Task> CreateCustomerWithHttpInfoAsync(CustomersCreateRequestBody customersCreateRequestBody = default(CustomersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateCustomerWithHttpInfoAsync(CustomersCreateRequestBody customersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'customersCreateRequestBody' is set + if (customersCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'customersCreateRequestBody' when calling CustomersApi->CreateCustomer"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2945,10 +2957,10 @@ public Voucherify.Client.ApiResponse ListCust /// /// Thrown when fails to make API call /// A Voucherify customers id or source_id. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// CustomersUpdateResponseBody - public CustomersUpdateResponseBody UpdateCustomer(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody = default(CustomersUpdateRequestBody), int operationIndex = 0) + public CustomersUpdateResponseBody UpdateCustomer(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateCustomerWithHttpInfo(customerId, customersUpdateRequestBody); return localVarResponse.Data; @@ -2959,10 +2971,10 @@ public Voucherify.Client.ApiResponse ListCust /// /// Thrown when fails to make API call /// A Voucherify customers id or source_id. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// ApiResponse of CustomersUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateCustomerWithHttpInfo(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody = default(CustomersUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateCustomerWithHttpInfo(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'customerId' is set if (customerId == null) @@ -2970,6 +2982,12 @@ public Voucherify.Client.ApiResponse ListCust throw new Voucherify.Client.ApiException(400, "Missing required parameter 'customerId' when calling CustomersApi->UpdateCustomer"); } + // verify the required parameter 'customersUpdateRequestBody' is set + if (customersUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'customersUpdateRequestBody' when calling CustomersApi->UpdateCustomer"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3046,11 +3064,11 @@ public Voucherify.Client.ApiResponse ListCust /// /// Thrown when fails to make API call /// A Voucherify customers id or source_id. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CustomersUpdateResponseBody - public async System.Threading.Tasks.Task UpdateCustomerAsync(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody = default(CustomersUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateCustomerAsync(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateCustomerWithHttpInfoAsync(customerId, customersUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -3061,11 +3079,11 @@ public Voucherify.Client.ApiResponse ListCust /// /// Thrown when fails to make API call /// A Voucherify customers id or source_id. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CustomersUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateCustomerWithHttpInfoAsync(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody = default(CustomersUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateCustomerWithHttpInfoAsync(string customerId, CustomersUpdateRequestBody customersUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'customerId' is set if (customerId == null) @@ -3073,6 +3091,12 @@ public Voucherify.Client.ApiResponse ListCust throw new Voucherify.Client.ApiException(400, "Missing required parameter 'customerId' when calling CustomersApi->UpdateCustomer"); } + // verify the required parameter 'customersUpdateRequestBody' is set + if (customersUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'customersUpdateRequestBody' when calling CustomersApi->UpdateCustomer"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -3149,10 +3173,10 @@ public Voucherify.Client.ApiResponse ListCust /// Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the customer fields to be updated in each customer object. (optional) + /// List the customer fields to be updated in each customer object. /// Index associated with the operation. /// CustomersUpdateInBulkResponseBody - public CustomersUpdateInBulkResponseBody UpdateCustomersInBulk(List customersUpdateInBulkRequestBody = default(List), int operationIndex = 0) + public CustomersUpdateInBulkResponseBody UpdateCustomersInBulk(List customersUpdateInBulkRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateCustomersInBulkWithHttpInfo(customersUpdateInBulkRequestBody); return localVarResponse.Data; @@ -3162,11 +3186,17 @@ public Voucherify.Client.ApiResponse ListCust /// Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the customer fields to be updated in each customer object. (optional) + /// List the customer fields to be updated in each customer object. /// Index associated with the operation. /// ApiResponse of CustomersUpdateInBulkResponseBody - public Voucherify.Client.ApiResponse UpdateCustomersInBulkWithHttpInfo(List customersUpdateInBulkRequestBody = default(List), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateCustomersInBulkWithHttpInfo(List customersUpdateInBulkRequestBody, int operationIndex = 0) { + // verify the required parameter 'customersUpdateInBulkRequestBody' is set + if (customersUpdateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'customersUpdateInBulkRequestBody' when calling CustomersApi->UpdateCustomersInBulk"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3241,11 +3271,11 @@ public Voucherify.Client.ApiResponse ListCust /// Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the customer fields to be updated in each customer object. (optional) + /// List the customer fields to be updated in each customer object. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CustomersUpdateInBulkResponseBody - public async System.Threading.Tasks.Task UpdateCustomersInBulkAsync(List customersUpdateInBulkRequestBody = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateCustomersInBulkAsync(List customersUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateCustomersInBulkWithHttpInfoAsync(customersUpdateInBulkRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -3255,12 +3285,18 @@ public Voucherify.Client.ApiResponse ListCust /// Update Customers in Bulk Updates customers in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the customer fields to be updated in each customer object. (optional) + /// List the customer fields to be updated in each customer object. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CustomersUpdateInBulkResponseBody) - public async System.Threading.Tasks.Task> UpdateCustomersInBulkWithHttpInfoAsync(List customersUpdateInBulkRequestBody = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateCustomersInBulkWithHttpInfoAsync(List customersUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'customersUpdateInBulkRequestBody' is set + if (customersUpdateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'customersUpdateInBulkRequestBody' when calling CustomersApi->UpdateCustomersInBulk"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -3336,10 +3372,10 @@ public Voucherify.Client.ApiResponse ListCust /// Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the customers you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// CustomersMetadataUpdateInBulkResponseBody - public CustomersMetadataUpdateInBulkResponseBody UpdateCustomersMetadataInBulk(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody = default(CustomersMetadataUpdateInBulkRequestBody), int operationIndex = 0) + public CustomersMetadataUpdateInBulkResponseBody UpdateCustomersMetadataInBulk(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateCustomersMetadataInBulkWithHttpInfo(customersMetadataUpdateInBulkRequestBody); return localVarResponse.Data; @@ -3349,11 +3385,17 @@ public Voucherify.Client.ApiResponse ListCust /// Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the customers you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// ApiResponse of CustomersMetadataUpdateInBulkResponseBody - public Voucherify.Client.ApiResponse UpdateCustomersMetadataInBulkWithHttpInfo(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody = default(CustomersMetadataUpdateInBulkRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateCustomersMetadataInBulkWithHttpInfo(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody, int operationIndex = 0) { + // verify the required parameter 'customersMetadataUpdateInBulkRequestBody' is set + if (customersMetadataUpdateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'customersMetadataUpdateInBulkRequestBody' when calling CustomersApi->UpdateCustomersMetadataInBulk"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3428,11 +3470,11 @@ public Voucherify.Client.ApiResponse ListCust /// Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the customers you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CustomersMetadataUpdateInBulkResponseBody - public async System.Threading.Tasks.Task UpdateCustomersMetadataInBulkAsync(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody = default(CustomersMetadataUpdateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateCustomersMetadataInBulkAsync(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateCustomersMetadataInBulkWithHttpInfoAsync(customersMetadataUpdateInBulkRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -3442,12 +3484,18 @@ public Voucherify.Client.ApiResponse ListCust /// Update Customers' Metadata in Bulk Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the customers you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the customers you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CustomersMetadataUpdateInBulkResponseBody) - public async System.Threading.Tasks.Task> UpdateCustomersMetadataInBulkWithHttpInfoAsync(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody = default(CustomersMetadataUpdateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateCustomersMetadataInBulkWithHttpInfoAsync(CustomersMetadataUpdateInBulkRequestBody customersMetadataUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'customersMetadataUpdateInBulkRequestBody' is set + if (customersMetadataUpdateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'customersMetadataUpdateInBulkRequestBody' when calling CustomersApi->UpdateCustomersMetadataInBulk"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/EventsApi.cs b/src/Voucherify/Api/EventsApi.cs index 2995160a..cf2217de 100644 --- a/src/Voucherify/Api/EventsApi.cs +++ b/src/Voucherify/Api/EventsApi.cs @@ -35,10 +35,10 @@ public interface IEventsApiSync : IApiAccessor /// To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. /// /// Thrown when fails to make API call - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// EventsCreateResponseBody - EventsCreateResponseBody TrackCustomEvent(EventsCreateRequestBody eventsCreateRequestBody = default(EventsCreateRequestBody), int operationIndex = 0); + EventsCreateResponseBody TrackCustomEvent(EventsCreateRequestBody eventsCreateRequestBody, int operationIndex = 0); /// /// Track Custom Event @@ -47,10 +47,10 @@ public interface IEventsApiSync : IApiAccessor /// To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. /// /// Thrown when fails to make API call - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// ApiResponse of EventsCreateResponseBody - ApiResponse TrackCustomEventWithHttpInfo(EventsCreateRequestBody eventsCreateRequestBody = default(EventsCreateRequestBody), int operationIndex = 0); + ApiResponse TrackCustomEventWithHttpInfo(EventsCreateRequestBody eventsCreateRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -67,11 +67,11 @@ public interface IEventsApiAsync : IApiAccessor /// To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. /// /// Thrown when fails to make API call - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of EventsCreateResponseBody - System.Threading.Tasks.Task TrackCustomEventAsync(EventsCreateRequestBody eventsCreateRequestBody = default(EventsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task TrackCustomEventAsync(EventsCreateRequestBody eventsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Track Custom Event @@ -80,11 +80,11 @@ public interface IEventsApiAsync : IApiAccessor /// To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. /// /// Thrown when fails to make API call - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (EventsCreateResponseBody) - System.Threading.Tasks.Task> TrackCustomEventWithHttpInfoAsync(EventsCreateRequestBody eventsCreateRequestBody = default(EventsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> TrackCustomEventWithHttpInfoAsync(EventsCreateRequestBody eventsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -209,10 +209,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. /// /// Thrown when fails to make API call - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// EventsCreateResponseBody - public EventsCreateResponseBody TrackCustomEvent(EventsCreateRequestBody eventsCreateRequestBody = default(EventsCreateRequestBody), int operationIndex = 0) + public EventsCreateResponseBody TrackCustomEvent(EventsCreateRequestBody eventsCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = TrackCustomEventWithHttpInfo(eventsCreateRequestBody); return localVarResponse.Data; @@ -222,11 +222,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. /// /// Thrown when fails to make API call - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// ApiResponse of EventsCreateResponseBody - public Voucherify.Client.ApiResponse TrackCustomEventWithHttpInfo(EventsCreateRequestBody eventsCreateRequestBody = default(EventsCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse TrackCustomEventWithHttpInfo(EventsCreateRequestBody eventsCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'eventsCreateRequestBody' is set + if (eventsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'eventsCreateRequestBody' when calling EventsApi->TrackCustomEvent"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -301,11 +307,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. /// /// Thrown when fails to make API call - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of EventsCreateResponseBody - public async System.Threading.Tasks.Task TrackCustomEventAsync(EventsCreateRequestBody eventsCreateRequestBody = default(EventsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task TrackCustomEventAsync(EventsCreateRequestBody eventsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await TrackCustomEventWithHttpInfoAsync(eventsCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -315,12 +321,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Track Custom Event To track a custom event, you create an event object. The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created. /// /// Thrown when fails to make API call - /// Specify the details of the custom event. (optional) + /// Specify the details of the custom event. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (EventsCreateResponseBody) - public async System.Threading.Tasks.Task> TrackCustomEventWithHttpInfoAsync(EventsCreateRequestBody eventsCreateRequestBody = default(EventsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> TrackCustomEventWithHttpInfoAsync(EventsCreateRequestBody eventsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'eventsCreateRequestBody' is set + if (eventsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'eventsCreateRequestBody' when calling EventsApi->TrackCustomEvent"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/ExportsApi.cs b/src/Voucherify/Api/ExportsApi.cs index 8e2d9059..c38a0e4f 100644 --- a/src/Voucherify/Api/ExportsApi.cs +++ b/src/Voucherify/Api/ExportsApi.cs @@ -35,10 +35,10 @@ public interface IExportsApiSync : IApiAccessor /// Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions /// /// Thrown when fails to make API call - /// Specify the details of the export that you would like to create. (optional) + /// Specify the details of the export that you would like to create. /// Index associated with the operation. /// ExportsCreateResponseBody - ExportsCreateResponseBody CreateExport(ExportsCreateRequestBody exportsCreateRequestBody = default(ExportsCreateRequestBody), int operationIndex = 0); + ExportsCreateResponseBody CreateExport(ExportsCreateRequestBody exportsCreateRequestBody, int operationIndex = 0); /// /// Create Export @@ -47,10 +47,10 @@ public interface IExportsApiSync : IApiAccessor /// Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions /// /// Thrown when fails to make API call - /// Specify the details of the export that you would like to create. (optional) + /// Specify the details of the export that you would like to create. /// Index associated with the operation. /// ApiResponse of ExportsCreateResponseBody - ApiResponse CreateExportWithHttpInfo(ExportsCreateRequestBody exportsCreateRequestBody = default(ExportsCreateRequestBody), int operationIndex = 0); + ApiResponse CreateExportWithHttpInfo(ExportsCreateRequestBody exportsCreateRequestBody, int operationIndex = 0); /// /// Delete Export /// @@ -165,11 +165,11 @@ public interface IExportsApiAsync : IApiAccessor /// Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions /// /// Thrown when fails to make API call - /// Specify the details of the export that you would like to create. (optional) + /// Specify the details of the export that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ExportsCreateResponseBody - System.Threading.Tasks.Task CreateExportAsync(ExportsCreateRequestBody exportsCreateRequestBody = default(ExportsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateExportAsync(ExportsCreateRequestBody exportsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Export @@ -178,11 +178,11 @@ public interface IExportsApiAsync : IApiAccessor /// Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions /// /// Thrown when fails to make API call - /// Specify the details of the export that you would like to create. (optional) + /// Specify the details of the export that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ExportsCreateResponseBody) - System.Threading.Tasks.Task> CreateExportWithHttpInfoAsync(ExportsCreateRequestBody exportsCreateRequestBody = default(ExportsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateExportWithHttpInfoAsync(ExportsCreateRequestBody exportsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Export /// @@ -413,10 +413,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions /// /// Thrown when fails to make API call - /// Specify the details of the export that you would like to create. (optional) + /// Specify the details of the export that you would like to create. /// Index associated with the operation. /// ExportsCreateResponseBody - public ExportsCreateResponseBody CreateExport(ExportsCreateRequestBody exportsCreateRequestBody = default(ExportsCreateRequestBody), int operationIndex = 0) + public ExportsCreateResponseBody CreateExport(ExportsCreateRequestBody exportsCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateExportWithHttpInfo(exportsCreateRequestBody); return localVarResponse.Data; @@ -426,11 +426,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions /// /// Thrown when fails to make API call - /// Specify the details of the export that you would like to create. (optional) + /// Specify the details of the export that you would like to create. /// Index associated with the operation. /// ApiResponse of ExportsCreateResponseBody - public Voucherify.Client.ApiResponse CreateExportWithHttpInfo(ExportsCreateRequestBody exportsCreateRequestBody = default(ExportsCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateExportWithHttpInfo(ExportsCreateRequestBody exportsCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'exportsCreateRequestBody' is set + if (exportsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'exportsCreateRequestBody' when calling ExportsApi->CreateExport"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -505,11 +511,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions /// /// Thrown when fails to make API call - /// Specify the details of the export that you would like to create. (optional) + /// Specify the details of the export that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ExportsCreateResponseBody - public async System.Threading.Tasks.Task CreateExportAsync(ExportsCreateRequestBody exportsCreateRequestBody = default(ExportsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateExportAsync(ExportsCreateRequestBody exportsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateExportWithHttpInfoAsync(exportsCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -519,12 +525,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Export Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku. # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object: πŸ“˜ Date and time in the export API The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders # Vouchers # Publications # Redemptions # Customers # Points Expirations # Gift Card Transactions # Loyalty Card Transactions /// /// Thrown when fails to make API call - /// Specify the details of the export that you would like to create. (optional) + /// Specify the details of the export that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ExportsCreateResponseBody) - public async System.Threading.Tasks.Task> CreateExportWithHttpInfoAsync(ExportsCreateRequestBody exportsCreateRequestBody = default(ExportsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateExportWithHttpInfoAsync(ExportsCreateRequestBody exportsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'exportsCreateRequestBody' is set + if (exportsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'exportsCreateRequestBody' when calling ExportsApi->CreateExport"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/LoyaltiesApi.cs b/src/Voucherify/Api/LoyaltiesApi.cs index 9a408dec..ac077a5f 100644 --- a/src/Voucherify/Api/LoyaltiesApi.cs +++ b/src/Voucherify/Api/LoyaltiesApi.cs @@ -61,10 +61,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID of the loyalty program. - /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. /// Index associated with the operation. /// LoyaltiesMembersCreateResponseBody - LoyaltiesMembersCreateResponseBody AddMember(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody = default(LoyaltiesMembersCreateRequestBody), int operationIndex = 0); + LoyaltiesMembersCreateResponseBody AddMember(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody, int operationIndex = 0); /// /// Add Member @@ -74,10 +74,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID of the loyalty program. - /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersCreateResponseBody - ApiResponse AddMemberWithHttpInfo(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody = default(LoyaltiesMembersCreateRequestBody), int operationIndex = 0); + ApiResponse AddMemberWithHttpInfo(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody, int operationIndex = 0); /// /// Adjust Member Pending Points /// @@ -87,10 +87,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// Unique loyalty card code assigned to a particular customer. /// Unique pending point identifier, assigned by Voucherify. - /// Define the number of pending points to be added or subtracted. (optional) + /// Define the number of pending points to be added or subtracted. /// Index associated with the operation. /// LoyaltiesMembersPendingPointsBalanceResponseBody - LoyaltiesMembersPendingPointsBalanceResponseBody AdjustMemberPendingPoints(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody = default(LoyaltiesMembersPendingPointsBalanceRequestBody), int operationIndex = 0); + LoyaltiesMembersPendingPointsBalanceResponseBody AdjustMemberPendingPoints(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody, int operationIndex = 0); /// /// Adjust Member Pending Points @@ -101,10 +101,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// Unique loyalty card code assigned to a particular customer. /// Unique pending point identifier, assigned by Voucherify. - /// Define the number of pending points to be added or subtracted. (optional) + /// Define the number of pending points to be added or subtracted. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersPendingPointsBalanceResponseBody - ApiResponse AdjustMemberPendingPointsWithHttpInfo(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody = default(LoyaltiesMembersPendingPointsBalanceRequestBody), int operationIndex = 0); + ApiResponse AdjustMemberPendingPointsWithHttpInfo(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody, int operationIndex = 0); /// /// Cancel Member Pending Points /// @@ -138,10 +138,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object /// Index associated with the operation. /// List<LoyaltiesEarningRulesCreateResponseBody> - List CreateEarningRule(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem = default(List), int operationIndex = 0); + List CreateEarningRule(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem, int operationIndex = 0); /// /// Create Earning Rule @@ -151,10 +151,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object /// Index associated with the operation. /// ApiResponse of List<LoyaltiesEarningRulesCreateResponseBody> - ApiResponse> CreateEarningRuleWithHttpInfo(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem = default(List), int operationIndex = 0); + ApiResponse> CreateEarningRuleWithHttpInfo(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem, int operationIndex = 0); /// /// Create loyalty tiers /// @@ -163,10 +163,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique loyalty campaign ID or name. - /// Provide tier definitions you want to add to existing loyalty campaign. (optional) + /// Provide tier definitions you want to add to existing loyalty campaign. /// Index associated with the operation. /// List<LoyaltyTier> - List CreateInBulkLoyaltyTiers(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem = default(List), int operationIndex = 0); + List CreateInBulkLoyaltyTiers(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem, int operationIndex = 0); /// /// Create loyalty tiers @@ -176,10 +176,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique loyalty campaign ID or name. - /// Provide tier definitions you want to add to existing loyalty campaign. (optional) + /// Provide tier definitions you want to add to existing loyalty campaign. /// Index associated with the operation. /// ApiResponse of List<LoyaltyTier> - ApiResponse> CreateInBulkLoyaltyTiersWithHttpInfo(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem = default(List), int operationIndex = 0); + ApiResponse> CreateInBulkLoyaltyTiersWithHttpInfo(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem, int operationIndex = 0); /// /// Create Loyalty Campaign /// @@ -187,10 +187,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. /// /// Thrown when fails to make API call - /// Specify the loyalty campaign details. (optional) + /// Specify the loyalty campaign details. /// Index associated with the operation. /// LoyaltiesCreateCampaignResponseBody - LoyaltiesCreateCampaignResponseBody CreateLoyaltyProgram(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody = default(LoyaltiesCreateCampaignRequestBody), int operationIndex = 0); + LoyaltiesCreateCampaignResponseBody CreateLoyaltyProgram(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody, int operationIndex = 0); /// /// Create Loyalty Campaign @@ -199,10 +199,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. /// /// Thrown when fails to make API call - /// Specify the loyalty campaign details. (optional) + /// Specify the loyalty campaign details. /// Index associated with the operation. /// ApiResponse of LoyaltiesCreateCampaignResponseBody - ApiResponse CreateLoyaltyProgramWithHttpInfo(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody = default(LoyaltiesCreateCampaignRequestBody), int operationIndex = 0); + ApiResponse CreateLoyaltyProgramWithHttpInfo(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody, int operationIndex = 0); /// /// Export Loyalty Campaign Point Expiration /// @@ -211,10 +211,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID or name. - /// Specify the data filters, types of data to return and order in which the results should be returned. (optional) + /// Specify the data filters, types of data to return and order in which the results should be returned. /// Index associated with the operation. /// LoyaltiesPointsExpirationExportCreateResponseBody - LoyaltiesPointsExpirationExportCreateResponseBody CreatePointsExpirationExport(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody = default(LoyaltiesPointsExpirationExportCreateRequestBody), int operationIndex = 0); + LoyaltiesPointsExpirationExportCreateResponseBody CreatePointsExpirationExport(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody, int operationIndex = 0); /// /// Export Loyalty Campaign Point Expiration @@ -224,10 +224,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID or name. - /// Specify the data filters, types of data to return and order in which the results should be returned. (optional) + /// Specify the data filters, types of data to return and order in which the results should be returned. /// Index associated with the operation. /// ApiResponse of LoyaltiesPointsExpirationExportCreateResponseBody - ApiResponse CreatePointsExpirationExportWithHttpInfo(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody = default(LoyaltiesPointsExpirationExportCreateRequestBody), int operationIndex = 0); + ApiResponse CreatePointsExpirationExportWithHttpInfo(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody, int operationIndex = 0); /// /// Create Loyalty Campaign Reward Assignment /// @@ -236,10 +236,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Define the cost of the rewards in loyalty points. (optional) + /// Define the cost of the rewards in loyalty points. /// Index associated with the operation. /// LoyaltiesRewardsCreateAssignmentResponseBody - LoyaltiesRewardsCreateAssignmentResponseBody CreateRewardAssignment1(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody = default(List), int operationIndex = 0); + LoyaltiesRewardsCreateAssignmentResponseBody CreateRewardAssignment1(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody, int operationIndex = 0); /// /// Create Loyalty Campaign Reward Assignment @@ -249,10 +249,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Define the cost of the rewards in loyalty points. (optional) + /// Define the cost of the rewards in loyalty points. /// Index associated with the operation. /// ApiResponse of LoyaltiesRewardsCreateAssignmentResponseBody - ApiResponse CreateRewardAssignment1WithHttpInfo(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody = default(List), int operationIndex = 0); + ApiResponse CreateRewardAssignment1WithHttpInfo(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody, int operationIndex = 0); /// /// Delete Earning Rule /// @@ -386,10 +386,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// CampaignsTransactionsExportCreateResponseBody - CampaignsTransactionsExportCreateResponseBody ExportLoyaltyCampaignTransactions(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody = default(LoyaltiesTransactionsExportCreateRequestBody), int operationIndex = 0); + CampaignsTransactionsExportCreateResponseBody ExportLoyaltyCampaignTransactions(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody, int operationIndex = 0); /// /// Export Loyalty Campaign Transactions @@ -399,10 +399,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// ApiResponse of CampaignsTransactionsExportCreateResponseBody - ApiResponse ExportLoyaltyCampaignTransactionsWithHttpInfo(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody = default(LoyaltiesTransactionsExportCreateRequestBody), int operationIndex = 0); + ApiResponse ExportLoyaltyCampaignTransactionsWithHttpInfo(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody, int operationIndex = 0); /// /// Export Loyalty Card Transactions /// @@ -411,10 +411,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// LoyaltiesMembersTransactionsExportCreateResponseBody - LoyaltiesMembersTransactionsExportCreateResponseBody ExportLoyaltyCardTransactions(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0); + LoyaltiesMembersTransactionsExportCreateResponseBody ExportLoyaltyCardTransactions(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0); /// /// Export Loyalty Card Transactions @@ -424,10 +424,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody - ApiResponse ExportLoyaltyCardTransactionsWithHttpInfo(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0); + ApiResponse ExportLoyaltyCardTransactionsWithHttpInfo(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0); /// /// Export Loyalty Card Transactions with campaign ID /// @@ -437,10 +437,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// LoyaltiesMembersTransactionsExportCreateResponseBody - LoyaltiesMembersTransactionsExportCreateResponseBody ExportLoyaltyCardTransactions1(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0); + LoyaltiesMembersTransactionsExportCreateResponseBody ExportLoyaltyCardTransactions1(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0); /// /// Export Loyalty Card Transactions with campaign ID @@ -451,10 +451,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody - ApiResponse ExportLoyaltyCardTransactions1WithHttpInfo(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0); + ApiResponse ExportLoyaltyCardTransactions1WithHttpInfo(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0); /// /// Get Earning Rule /// @@ -1216,10 +1216,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// LoyaltiesMembersRedemptionRedeemResponseBody - LoyaltiesMembersRedemptionRedeemResponseBody RedeemReward(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0); + LoyaltiesMembersRedemptionRedeemResponseBody RedeemReward(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0); /// /// Redeem Reward @@ -1229,10 +1229,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody - ApiResponse RedeemRewardWithHttpInfo(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0); + ApiResponse RedeemRewardWithHttpInfo(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0); /// /// Redeem Reward with campaign ID /// @@ -1242,10 +1242,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// LoyaltiesMembersRedemptionRedeemResponseBody - LoyaltiesMembersRedemptionRedeemResponseBody RedeemReward1(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0); + LoyaltiesMembersRedemptionRedeemResponseBody RedeemReward1(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0); /// /// Redeem Reward with campaign ID @@ -1256,10 +1256,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody - ApiResponse RedeemReward1WithHttpInfo(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0); + ApiResponse RedeemReward1WithHttpInfo(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0); /// /// Transfer Loyalty Points /// @@ -1269,10 +1269,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). /// A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. /// Index associated with the operation. /// LoyaltiesMembersTransfersCreateResponseBody - LoyaltiesMembersTransfersCreateResponseBody TransferPoints(string campaignId, string memberId, List loyaltiesTransferPoints = default(List), int operationIndex = 0); + LoyaltiesMembersTransfersCreateResponseBody TransferPoints(string campaignId, string memberId, List loyaltiesTransferPoints, int operationIndex = 0); /// /// Transfer Loyalty Points @@ -1283,10 +1283,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). /// A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersTransfersCreateResponseBody - ApiResponse TransferPointsWithHttpInfo(string campaignId, string memberId, List loyaltiesTransferPoints = default(List), int operationIndex = 0); + ApiResponse TransferPointsWithHttpInfo(string campaignId, string memberId, List loyaltiesTransferPoints, int operationIndex = 0); /// /// Update Earning Rule /// @@ -1296,10 +1296,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique earning rule ID. - /// Specify the parameters that you would like to update for the given earning rule. (optional) + /// Specify the parameters that you would like to update for the given earning rule. /// Index associated with the operation. /// LoyaltiesEarningRulesUpdateResponseBody - LoyaltiesEarningRulesUpdateResponseBody UpdateEarningRule(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody = default(LoyaltiesEarningRulesUpdateRequestBody), int operationIndex = 0); + LoyaltiesEarningRulesUpdateResponseBody UpdateEarningRule(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody, int operationIndex = 0); /// /// Update Earning Rule @@ -1310,10 +1310,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique earning rule ID. - /// Specify the parameters that you would like to update for the given earning rule. (optional) + /// Specify the parameters that you would like to update for the given earning rule. /// Index associated with the operation. /// ApiResponse of LoyaltiesEarningRulesUpdateResponseBody - ApiResponse UpdateEarningRuleWithHttpInfo(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody = default(LoyaltiesEarningRulesUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateEarningRuleWithHttpInfo(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody, int operationIndex = 0); /// /// Adjust Loyalty Card Balance /// @@ -1322,10 +1322,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// LoyaltiesMembersBalanceUpdateResponseBody - LoyaltiesMembersBalanceUpdateResponseBody UpdateLoyaltyCardBalance(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0); + LoyaltiesMembersBalanceUpdateResponseBody UpdateLoyaltyCardBalance(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0); /// /// Adjust Loyalty Card Balance @@ -1335,10 +1335,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody - ApiResponse UpdateLoyaltyCardBalanceWithHttpInfo(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateLoyaltyCardBalanceWithHttpInfo(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0); /// /// Adjust Loyalty Card Balance with campaign ID /// @@ -1348,10 +1348,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// LoyaltiesMembersBalanceUpdateResponseBody - LoyaltiesMembersBalanceUpdateResponseBody UpdateLoyaltyCardBalance1(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0); + LoyaltiesMembersBalanceUpdateResponseBody UpdateLoyaltyCardBalance1(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0); /// /// Adjust Loyalty Card Balance with campaign ID @@ -1362,10 +1362,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody - ApiResponse UpdateLoyaltyCardBalance1WithHttpInfo(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateLoyaltyCardBalance1WithHttpInfo(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0); /// /// Update Loyalty Campaign /// @@ -1374,10 +1374,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. /// Index associated with the operation. /// LoyaltiesUpdateCampaignResponseBody - LoyaltiesUpdateCampaignResponseBody UpdateLoyaltyProgram(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody = default(LoyaltiesUpdateCampaignRequestBody), int operationIndex = 0); + LoyaltiesUpdateCampaignResponseBody UpdateLoyaltyProgram(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody, int operationIndex = 0); /// /// Update Loyalty Campaign @@ -1387,10 +1387,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. /// Index associated with the operation. /// ApiResponse of LoyaltiesUpdateCampaignResponseBody - ApiResponse UpdateLoyaltyProgramWithHttpInfo(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody = default(LoyaltiesUpdateCampaignRequestBody), int operationIndex = 0); + ApiResponse UpdateLoyaltyProgramWithHttpInfo(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody, int operationIndex = 0); /// /// Update Campaign Reward Assignment /// @@ -1400,10 +1400,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique reward assignment ID. - /// Update the points cost for the reward assignment. (optional) + /// Update the points cost for the reward assignment. /// Index associated with the operation. /// LoyaltiesRewardsUpdateAssignmentResponseBody - LoyaltiesRewardsUpdateAssignmentResponseBody UpdateRewardAssignment1(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody = default(LoyaltiesRewardsUpdateAssignmentRequestBody), int operationIndex = 0); + LoyaltiesRewardsUpdateAssignmentResponseBody UpdateRewardAssignment1(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody, int operationIndex = 0); /// /// Update Campaign Reward Assignment @@ -1414,10 +1414,10 @@ public interface ILoyaltiesApiSync : IApiAccessor /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique reward assignment ID. - /// Update the points cost for the reward assignment. (optional) + /// Update the points cost for the reward assignment. /// Index associated with the operation. /// ApiResponse of LoyaltiesRewardsUpdateAssignmentResponseBody - ApiResponse UpdateRewardAssignment1WithHttpInfo(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody = default(LoyaltiesRewardsUpdateAssignmentRequestBody), int operationIndex = 0); + ApiResponse UpdateRewardAssignment1WithHttpInfo(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -1462,11 +1462,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID of the loyalty program. - /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersCreateResponseBody - System.Threading.Tasks.Task AddMemberAsync(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody = default(LoyaltiesMembersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task AddMemberAsync(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Add Member @@ -1476,11 +1476,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID of the loyalty program. - /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersCreateResponseBody) - System.Threading.Tasks.Task> AddMemberWithHttpInfoAsync(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody = default(LoyaltiesMembersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> AddMemberWithHttpInfoAsync(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Adjust Member Pending Points /// @@ -1490,11 +1490,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// Unique loyalty card code assigned to a particular customer. /// Unique pending point identifier, assigned by Voucherify. - /// Define the number of pending points to be added or subtracted. (optional) + /// Define the number of pending points to be added or subtracted. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersPendingPointsBalanceResponseBody - System.Threading.Tasks.Task AdjustMemberPendingPointsAsync(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody = default(LoyaltiesMembersPendingPointsBalanceRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task AdjustMemberPendingPointsAsync(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Adjust Member Pending Points @@ -1505,11 +1505,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// Unique loyalty card code assigned to a particular customer. /// Unique pending point identifier, assigned by Voucherify. - /// Define the number of pending points to be added or subtracted. (optional) + /// Define the number of pending points to be added or subtracted. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersPendingPointsBalanceResponseBody) - System.Threading.Tasks.Task> AdjustMemberPendingPointsWithHttpInfoAsync(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody = default(LoyaltiesMembersPendingPointsBalanceRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> AdjustMemberPendingPointsWithHttpInfoAsync(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Cancel Member Pending Points /// @@ -1545,11 +1545,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of List<LoyaltiesEarningRulesCreateResponseBody> - System.Threading.Tasks.Task> CreateEarningRuleAsync(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateEarningRuleAsync(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Earning Rule @@ -1559,11 +1559,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (List<LoyaltiesEarningRulesCreateResponseBody>) - System.Threading.Tasks.Task>> CreateEarningRuleWithHttpInfoAsync(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task>> CreateEarningRuleWithHttpInfoAsync(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create loyalty tiers /// @@ -1572,11 +1572,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique loyalty campaign ID or name. - /// Provide tier definitions you want to add to existing loyalty campaign. (optional) + /// Provide tier definitions you want to add to existing loyalty campaign. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of List<LoyaltyTier> - System.Threading.Tasks.Task> CreateInBulkLoyaltyTiersAsync(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateInBulkLoyaltyTiersAsync(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create loyalty tiers @@ -1586,11 +1586,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique loyalty campaign ID or name. - /// Provide tier definitions you want to add to existing loyalty campaign. (optional) + /// Provide tier definitions you want to add to existing loyalty campaign. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (List<LoyaltyTier>) - System.Threading.Tasks.Task>> CreateInBulkLoyaltyTiersWithHttpInfoAsync(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task>> CreateInBulkLoyaltyTiersWithHttpInfoAsync(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Loyalty Campaign /// @@ -1598,11 +1598,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. /// /// Thrown when fails to make API call - /// Specify the loyalty campaign details. (optional) + /// Specify the loyalty campaign details. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesCreateCampaignResponseBody - System.Threading.Tasks.Task CreateLoyaltyProgramAsync(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody = default(LoyaltiesCreateCampaignRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateLoyaltyProgramAsync(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Loyalty Campaign @@ -1611,11 +1611,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. /// /// Thrown when fails to make API call - /// Specify the loyalty campaign details. (optional) + /// Specify the loyalty campaign details. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesCreateCampaignResponseBody) - System.Threading.Tasks.Task> CreateLoyaltyProgramWithHttpInfoAsync(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody = default(LoyaltiesCreateCampaignRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateLoyaltyProgramWithHttpInfoAsync(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Export Loyalty Campaign Point Expiration /// @@ -1624,11 +1624,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID or name. - /// Specify the data filters, types of data to return and order in which the results should be returned. (optional) + /// Specify the data filters, types of data to return and order in which the results should be returned. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesPointsExpirationExportCreateResponseBody - System.Threading.Tasks.Task CreatePointsExpirationExportAsync(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody = default(LoyaltiesPointsExpirationExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreatePointsExpirationExportAsync(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Export Loyalty Campaign Point Expiration @@ -1638,11 +1638,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID or name. - /// Specify the data filters, types of data to return and order in which the results should be returned. (optional) + /// Specify the data filters, types of data to return and order in which the results should be returned. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesPointsExpirationExportCreateResponseBody) - System.Threading.Tasks.Task> CreatePointsExpirationExportWithHttpInfoAsync(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody = default(LoyaltiesPointsExpirationExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreatePointsExpirationExportWithHttpInfoAsync(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Loyalty Campaign Reward Assignment /// @@ -1651,11 +1651,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Define the cost of the rewards in loyalty points. (optional) + /// Define the cost of the rewards in loyalty points. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesRewardsCreateAssignmentResponseBody - System.Threading.Tasks.Task CreateRewardAssignment1Async(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateRewardAssignment1Async(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Loyalty Campaign Reward Assignment @@ -1665,11 +1665,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Define the cost of the rewards in loyalty points. (optional) + /// Define the cost of the rewards in loyalty points. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesRewardsCreateAssignmentResponseBody) - System.Threading.Tasks.Task> CreateRewardAssignment1WithHttpInfoAsync(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateRewardAssignment1WithHttpInfoAsync(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Earning Rule /// @@ -1813,11 +1813,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsTransactionsExportCreateResponseBody - System.Threading.Tasks.Task ExportLoyaltyCampaignTransactionsAsync(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody = default(LoyaltiesTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task ExportLoyaltyCampaignTransactionsAsync(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Export Loyalty Campaign Transactions @@ -1827,11 +1827,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) - System.Threading.Tasks.Task> ExportLoyaltyCampaignTransactionsWithHttpInfoAsync(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody = default(LoyaltiesTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ExportLoyaltyCampaignTransactionsWithHttpInfoAsync(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Export Loyalty Card Transactions /// @@ -1840,11 +1840,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersTransactionsExportCreateResponseBody - System.Threading.Tasks.Task ExportLoyaltyCardTransactionsAsync(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task ExportLoyaltyCardTransactionsAsync(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Export Loyalty Card Transactions @@ -1854,11 +1854,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) - System.Threading.Tasks.Task> ExportLoyaltyCardTransactionsWithHttpInfoAsync(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ExportLoyaltyCardTransactionsWithHttpInfoAsync(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Export Loyalty Card Transactions with campaign ID /// @@ -1868,11 +1868,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersTransactionsExportCreateResponseBody - System.Threading.Tasks.Task ExportLoyaltyCardTransactions1Async(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task ExportLoyaltyCardTransactions1Async(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Export Loyalty Card Transactions with campaign ID @@ -1883,11 +1883,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) - System.Threading.Tasks.Task> ExportLoyaltyCardTransactions1WithHttpInfoAsync(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ExportLoyaltyCardTransactions1WithHttpInfoAsync(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Get Earning Rule /// @@ -2703,11 +2703,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersRedemptionRedeemResponseBody - System.Threading.Tasks.Task RedeemRewardAsync(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task RedeemRewardAsync(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Redeem Reward @@ -2717,11 +2717,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) - System.Threading.Tasks.Task> RedeemRewardWithHttpInfoAsync(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> RedeemRewardWithHttpInfoAsync(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Redeem Reward with campaign ID /// @@ -2731,11 +2731,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersRedemptionRedeemResponseBody - System.Threading.Tasks.Task RedeemReward1Async(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task RedeemReward1Async(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Redeem Reward with campaign ID @@ -2746,11 +2746,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) - System.Threading.Tasks.Task> RedeemReward1WithHttpInfoAsync(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> RedeemReward1WithHttpInfoAsync(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Transfer Loyalty Points /// @@ -2760,11 +2760,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). /// A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersTransfersCreateResponseBody - System.Threading.Tasks.Task TransferPointsAsync(string campaignId, string memberId, List loyaltiesTransferPoints = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task TransferPointsAsync(string campaignId, string memberId, List loyaltiesTransferPoints, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Transfer Loyalty Points @@ -2775,11 +2775,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). /// A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersTransfersCreateResponseBody) - System.Threading.Tasks.Task> TransferPointsWithHttpInfoAsync(string campaignId, string memberId, List loyaltiesTransferPoints = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> TransferPointsWithHttpInfoAsync(string campaignId, string memberId, List loyaltiesTransferPoints, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Earning Rule /// @@ -2789,11 +2789,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique earning rule ID. - /// Specify the parameters that you would like to update for the given earning rule. (optional) + /// Specify the parameters that you would like to update for the given earning rule. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesEarningRulesUpdateResponseBody - System.Threading.Tasks.Task UpdateEarningRuleAsync(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody = default(LoyaltiesEarningRulesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateEarningRuleAsync(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Earning Rule @@ -2804,11 +2804,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique earning rule ID. - /// Specify the parameters that you would like to update for the given earning rule. (optional) + /// Specify the parameters that you would like to update for the given earning rule. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesEarningRulesUpdateResponseBody) - System.Threading.Tasks.Task> UpdateEarningRuleWithHttpInfoAsync(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody = default(LoyaltiesEarningRulesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateEarningRuleWithHttpInfoAsync(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Adjust Loyalty Card Balance /// @@ -2817,11 +2817,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersBalanceUpdateResponseBody - System.Threading.Tasks.Task UpdateLoyaltyCardBalanceAsync(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateLoyaltyCardBalanceAsync(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Adjust Loyalty Card Balance @@ -2831,11 +2831,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) - System.Threading.Tasks.Task> UpdateLoyaltyCardBalanceWithHttpInfoAsync(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateLoyaltyCardBalanceWithHttpInfoAsync(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Adjust Loyalty Card Balance with campaign ID /// @@ -2845,11 +2845,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersBalanceUpdateResponseBody - System.Threading.Tasks.Task UpdateLoyaltyCardBalance1Async(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateLoyaltyCardBalance1Async(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Adjust Loyalty Card Balance with campaign ID @@ -2860,11 +2860,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) - System.Threading.Tasks.Task> UpdateLoyaltyCardBalance1WithHttpInfoAsync(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateLoyaltyCardBalance1WithHttpInfoAsync(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Loyalty Campaign /// @@ -2873,11 +2873,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesUpdateCampaignResponseBody - System.Threading.Tasks.Task UpdateLoyaltyProgramAsync(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody = default(LoyaltiesUpdateCampaignRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateLoyaltyProgramAsync(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Loyalty Campaign @@ -2887,11 +2887,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesUpdateCampaignResponseBody) - System.Threading.Tasks.Task> UpdateLoyaltyProgramWithHttpInfoAsync(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody = default(LoyaltiesUpdateCampaignRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateLoyaltyProgramWithHttpInfoAsync(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Campaign Reward Assignment /// @@ -2901,11 +2901,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique reward assignment ID. - /// Update the points cost for the reward assignment. (optional) + /// Update the points cost for the reward assignment. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesRewardsUpdateAssignmentResponseBody - System.Threading.Tasks.Task UpdateRewardAssignment1Async(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody = default(LoyaltiesRewardsUpdateAssignmentRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateRewardAssignment1Async(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Campaign Reward Assignment @@ -2916,11 +2916,11 @@ public interface ILoyaltiesApiAsync : IApiAccessor /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique reward assignment ID. - /// Update the points cost for the reward assignment. (optional) + /// Update the points cost for the reward assignment. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesRewardsUpdateAssignmentResponseBody) - System.Threading.Tasks.Task> UpdateRewardAssignment1WithHttpInfoAsync(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody = default(LoyaltiesRewardsUpdateAssignmentRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateRewardAssignment1WithHttpInfoAsync(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -3261,10 +3261,10 @@ public Voucherify.Client.ApiResponse /// Thrown when fails to make API call /// Unique campaign ID of the loyalty program. - /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. /// Index associated with the operation. /// LoyaltiesMembersCreateResponseBody - public LoyaltiesMembersCreateResponseBody AddMember(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody = default(LoyaltiesMembersCreateRequestBody), int operationIndex = 0) + public LoyaltiesMembersCreateResponseBody AddMember(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = AddMemberWithHttpInfo(campaignId, loyaltiesMembersCreateRequestBody); return localVarResponse.Data; @@ -3275,10 +3275,10 @@ public Voucherify.Client.ApiResponse /// Thrown when fails to make API call /// Unique campaign ID of the loyalty program. - /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersCreateResponseBody - public Voucherify.Client.ApiResponse AddMemberWithHttpInfo(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody = default(LoyaltiesMembersCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse AddMemberWithHttpInfo(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -3286,6 +3286,12 @@ public Voucherify.Client.ApiResponseAddMember"); } + // verify the required parameter 'loyaltiesMembersCreateRequestBody' is set + if (loyaltiesMembersCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersCreateRequestBody' when calling LoyaltiesApi->AddMember"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3362,11 +3368,11 @@ public Voucherify.Client.ApiResponse /// Thrown when fails to make API call /// Unique campaign ID of the loyalty program. - /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersCreateResponseBody - public async System.Threading.Tasks.Task AddMemberAsync(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody = default(LoyaltiesMembersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task AddMemberAsync(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await AddMemberWithHttpInfoAsync(campaignId, loyaltiesMembersCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -3377,11 +3383,11 @@ public Voucherify.Client.ApiResponse /// Thrown when fails to make API call /// Unique campaign ID of the loyalty program. - /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. (optional) + /// Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the [List Publications](/api-reference/publications/list-publications) endpoint. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersCreateResponseBody) - public async System.Threading.Tasks.Task> AddMemberWithHttpInfoAsync(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody = default(LoyaltiesMembersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> AddMemberWithHttpInfoAsync(string campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -3389,6 +3395,12 @@ public Voucherify.Client.ApiResponseAddMember"); } + // verify the required parameter 'loyaltiesMembersCreateRequestBody' is set + if (loyaltiesMembersCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersCreateRequestBody' when calling LoyaltiesApi->AddMember"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -3467,10 +3479,10 @@ public Voucherify.Client.ApiResponseThrown when fails to make API call /// Unique loyalty card code assigned to a particular customer. /// Unique pending point identifier, assigned by Voucherify. - /// Define the number of pending points to be added or subtracted. (optional) + /// Define the number of pending points to be added or subtracted. /// Index associated with the operation. /// LoyaltiesMembersPendingPointsBalanceResponseBody - public LoyaltiesMembersPendingPointsBalanceResponseBody AdjustMemberPendingPoints(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody = default(LoyaltiesMembersPendingPointsBalanceRequestBody), int operationIndex = 0) + public LoyaltiesMembersPendingPointsBalanceResponseBody AdjustMemberPendingPoints(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = AdjustMemberPendingPointsWithHttpInfo(memberId, pendingPointsId, loyaltiesMembersPendingPointsBalanceRequestBody); return localVarResponse.Data; @@ -3482,10 +3494,10 @@ public Voucherify.Client.ApiResponseThrown when fails to make API call /// Unique loyalty card code assigned to a particular customer. /// Unique pending point identifier, assigned by Voucherify. - /// Define the number of pending points to be added or subtracted. (optional) + /// Define the number of pending points to be added or subtracted. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersPendingPointsBalanceResponseBody - public Voucherify.Client.ApiResponse AdjustMemberPendingPointsWithHttpInfo(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody = default(LoyaltiesMembersPendingPointsBalanceRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse AdjustMemberPendingPointsWithHttpInfo(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody, int operationIndex = 0) { // verify the required parameter 'memberId' is set if (memberId == null) @@ -3499,6 +3511,12 @@ public Voucherify.Client.ApiResponseAdjustMemberPendingPoints"); } + // verify the required parameter 'loyaltiesMembersPendingPointsBalanceRequestBody' is set + if (loyaltiesMembersPendingPointsBalanceRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersPendingPointsBalanceRequestBody' when calling LoyaltiesApi->AdjustMemberPendingPoints"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3577,11 +3595,11 @@ public Voucherify.Client.ApiResponseThrown when fails to make API call /// Unique loyalty card code assigned to a particular customer. /// Unique pending point identifier, assigned by Voucherify. - /// Define the number of pending points to be added or subtracted. (optional) + /// Define the number of pending points to be added or subtracted. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersPendingPointsBalanceResponseBody - public async System.Threading.Tasks.Task AdjustMemberPendingPointsAsync(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody = default(LoyaltiesMembersPendingPointsBalanceRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task AdjustMemberPendingPointsAsync(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await AdjustMemberPendingPointsWithHttpInfoAsync(memberId, pendingPointsId, loyaltiesMembersPendingPointsBalanceRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -3593,11 +3611,11 @@ public Voucherify.Client.ApiResponseThrown when fails to make API call /// Unique loyalty card code assigned to a particular customer. /// Unique pending point identifier, assigned by Voucherify. - /// Define the number of pending points to be added or subtracted. (optional) + /// Define the number of pending points to be added or subtracted. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersPendingPointsBalanceResponseBody) - public async System.Threading.Tasks.Task> AdjustMemberPendingPointsWithHttpInfoAsync(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody = default(LoyaltiesMembersPendingPointsBalanceRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> AdjustMemberPendingPointsWithHttpInfoAsync(string memberId, string pendingPointsId, LoyaltiesMembersPendingPointsBalanceRequestBody loyaltiesMembersPendingPointsBalanceRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'memberId' is set if (memberId == null) @@ -3611,6 +3629,12 @@ public Voucherify.Client.ApiResponseAdjustMemberPendingPoints"); } + // verify the required parameter 'loyaltiesMembersPendingPointsBalanceRequestBody' is set + if (loyaltiesMembersPendingPointsBalanceRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersPendingPointsBalanceRequestBody' when calling LoyaltiesApi->AdjustMemberPendingPoints"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -3900,10 +3924,10 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object /// Index associated with the operation. /// List<LoyaltiesEarningRulesCreateResponseBody> - public List CreateEarningRule(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem = default(List), int operationIndex = 0) + public List CreateEarningRule(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem, int operationIndex = 0) { Voucherify.Client.ApiResponse> localVarResponse = CreateEarningRuleWithHttpInfo(campaignId, loyaltiesEarningRulesCreateRequestBodyItem); return localVarResponse.Data; @@ -3914,10 +3938,10 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object /// Index associated with the operation. /// ApiResponse of List<LoyaltiesEarningRulesCreateResponseBody> - public Voucherify.Client.ApiResponse> CreateEarningRuleWithHttpInfo(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem = default(List), int operationIndex = 0) + public Voucherify.Client.ApiResponse> CreateEarningRuleWithHttpInfo(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -3925,6 +3949,12 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling LoyaltiesApi->CreateEarningRule"); } + // verify the required parameter 'loyaltiesEarningRulesCreateRequestBodyItem' is set + if (loyaltiesEarningRulesCreateRequestBodyItem == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesEarningRulesCreateRequestBodyItem' when calling LoyaltiesApi->CreateEarningRule"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -4001,11 +4031,11 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of List<LoyaltiesEarningRulesCreateResponseBody> - public async System.Threading.Tasks.Task> CreateEarningRuleAsync(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateEarningRuleAsync(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse> localVarResponse = await CreateEarningRuleWithHttpInfoAsync(campaignId, loyaltiesEarningRulesCreateRequestBodyItem, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -4016,11 +4046,11 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional) + /// Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (List<LoyaltiesEarningRulesCreateResponseBody>) - public async System.Threading.Tasks.Task>> CreateEarningRuleWithHttpInfoAsync(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task>> CreateEarningRuleWithHttpInfoAsync(string campaignId, List loyaltiesEarningRulesCreateRequestBodyItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -4028,6 +4058,12 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling LoyaltiesApi->CreateEarningRule"); } + // verify the required parameter 'loyaltiesEarningRulesCreateRequestBodyItem' is set + if (loyaltiesEarningRulesCreateRequestBodyItem == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesEarningRulesCreateRequestBodyItem' when calling LoyaltiesApi->CreateEarningRule"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -4105,10 +4141,10 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// Unique loyalty campaign ID or name. - /// Provide tier definitions you want to add to existing loyalty campaign. (optional) + /// Provide tier definitions you want to add to existing loyalty campaign. /// Index associated with the operation. /// List<LoyaltyTier> - public List CreateInBulkLoyaltyTiers(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem = default(List), int operationIndex = 0) + public List CreateInBulkLoyaltyTiers(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem, int operationIndex = 0) { Voucherify.Client.ApiResponse> localVarResponse = CreateInBulkLoyaltyTiersWithHttpInfo(campaignId, loyaltiesTiersCreateInBulkRequestBodyItem); return localVarResponse.Data; @@ -4119,10 +4155,10 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// Unique loyalty campaign ID or name. - /// Provide tier definitions you want to add to existing loyalty campaign. (optional) + /// Provide tier definitions you want to add to existing loyalty campaign. /// Index associated with the operation. /// ApiResponse of List<LoyaltyTier> - public Voucherify.Client.ApiResponse> CreateInBulkLoyaltyTiersWithHttpInfo(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem = default(List), int operationIndex = 0) + public Voucherify.Client.ApiResponse> CreateInBulkLoyaltyTiersWithHttpInfo(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -4130,6 +4166,12 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling LoyaltiesApi->CreateInBulkLoyaltyTiers"); } + // verify the required parameter 'loyaltiesTiersCreateInBulkRequestBodyItem' is set + if (loyaltiesTiersCreateInBulkRequestBodyItem == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesTiersCreateInBulkRequestBodyItem' when calling LoyaltiesApi->CreateInBulkLoyaltyTiers"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -4206,11 +4248,11 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// Unique loyalty campaign ID or name. - /// Provide tier definitions you want to add to existing loyalty campaign. (optional) + /// Provide tier definitions you want to add to existing loyalty campaign. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of List<LoyaltyTier> - public async System.Threading.Tasks.Task> CreateInBulkLoyaltyTiersAsync(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateInBulkLoyaltyTiersAsync(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse> localVarResponse = await CreateInBulkLoyaltyTiersWithHttpInfoAsync(campaignId, loyaltiesTiersCreateInBulkRequestBodyItem, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -4221,11 +4263,11 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// Unique loyalty campaign ID or name. - /// Provide tier definitions you want to add to existing loyalty campaign. (optional) + /// Provide tier definitions you want to add to existing loyalty campaign. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (List<LoyaltyTier>) - public async System.Threading.Tasks.Task>> CreateInBulkLoyaltyTiersWithHttpInfoAsync(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task>> CreateInBulkLoyaltyTiersWithHttpInfoAsync(string campaignId, List loyaltiesTiersCreateInBulkRequestBodyItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -4233,6 +4275,12 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling LoyaltiesApi->CreateInBulkLoyaltyTiers"); } + // verify the required parameter 'loyaltiesTiersCreateInBulkRequestBodyItem' is set + if (loyaltiesTiersCreateInBulkRequestBodyItem == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesTiersCreateInBulkRequestBodyItem' when calling LoyaltiesApi->CreateInBulkLoyaltyTiers"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -4309,10 +4357,10 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. /// /// Thrown when fails to make API call - /// Specify the loyalty campaign details. (optional) + /// Specify the loyalty campaign details. /// Index associated with the operation. /// LoyaltiesCreateCampaignResponseBody - public LoyaltiesCreateCampaignResponseBody CreateLoyaltyProgram(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody = default(LoyaltiesCreateCampaignRequestBody), int operationIndex = 0) + public LoyaltiesCreateCampaignResponseBody CreateLoyaltyProgram(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateLoyaltyProgramWithHttpInfo(loyaltiesCreateCampaignRequestBody); return localVarResponse.Data; @@ -4322,11 +4370,17 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. /// /// Thrown when fails to make API call - /// Specify the loyalty campaign details. (optional) + /// Specify the loyalty campaign details. /// Index associated with the operation. /// ApiResponse of LoyaltiesCreateCampaignResponseBody - public Voucherify.Client.ApiResponse CreateLoyaltyProgramWithHttpInfo(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody = default(LoyaltiesCreateCampaignRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateLoyaltyProgramWithHttpInfo(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody, int operationIndex = 0) { + // verify the required parameter 'loyaltiesCreateCampaignRequestBody' is set + if (loyaltiesCreateCampaignRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesCreateCampaignRequestBody' when calling LoyaltiesApi->CreateLoyaltyProgram"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -4401,11 +4455,11 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. /// /// Thrown when fails to make API call - /// Specify the loyalty campaign details. (optional) + /// Specify the loyalty campaign details. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesCreateCampaignResponseBody - public async System.Threading.Tasks.Task CreateLoyaltyProgramAsync(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody = default(LoyaltiesCreateCampaignRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateLoyaltyProgramAsync(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateLoyaltyProgramWithHttpInfoAsync(loyaltiesCreateCampaignRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -4415,12 +4469,18 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// Create Loyalty Campaign Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. πŸ“˜ Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asynchronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. /// /// Thrown when fails to make API call - /// Specify the loyalty campaign details. (optional) + /// Specify the loyalty campaign details. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesCreateCampaignResponseBody) - public async System.Threading.Tasks.Task> CreateLoyaltyProgramWithHttpInfoAsync(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody = default(LoyaltiesCreateCampaignRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateLoyaltyProgramWithHttpInfoAsync(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'loyaltiesCreateCampaignRequestBody' is set + if (loyaltiesCreateCampaignRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesCreateCampaignRequestBody' when calling LoyaltiesApi->CreateLoyaltyProgram"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -4497,10 +4557,10 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// Unique campaign ID or name. - /// Specify the data filters, types of data to return and order in which the results should be returned. (optional) + /// Specify the data filters, types of data to return and order in which the results should be returned. /// Index associated with the operation. /// LoyaltiesPointsExpirationExportCreateResponseBody - public LoyaltiesPointsExpirationExportCreateResponseBody CreatePointsExpirationExport(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody = default(LoyaltiesPointsExpirationExportCreateRequestBody), int operationIndex = 0) + public LoyaltiesPointsExpirationExportCreateResponseBody CreatePointsExpirationExport(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreatePointsExpirationExportWithHttpInfo(campaignId, loyaltiesPointsExpirationExportCreateRequestBody); return localVarResponse.Data; @@ -4511,10 +4571,10 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// Unique campaign ID or name. - /// Specify the data filters, types of data to return and order in which the results should be returned. (optional) + /// Specify the data filters, types of data to return and order in which the results should be returned. /// Index associated with the operation. /// ApiResponse of LoyaltiesPointsExpirationExportCreateResponseBody - public Voucherify.Client.ApiResponse CreatePointsExpirationExportWithHttpInfo(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody = default(LoyaltiesPointsExpirationExportCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreatePointsExpirationExportWithHttpInfo(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -4522,6 +4582,12 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling LoyaltiesApi->CreatePointsExpirationExport"); } + // verify the required parameter 'loyaltiesPointsExpirationExportCreateRequestBody' is set + if (loyaltiesPointsExpirationExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesPointsExpirationExportCreateRequestBody' when calling LoyaltiesApi->CreatePointsExpirationExport"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -4598,11 +4664,11 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// Unique campaign ID or name. - /// Specify the data filters, types of data to return and order in which the results should be returned. (optional) + /// Specify the data filters, types of data to return and order in which the results should be returned. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesPointsExpirationExportCreateResponseBody - public async System.Threading.Tasks.Task CreatePointsExpirationExportAsync(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody = default(LoyaltiesPointsExpirationExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreatePointsExpirationExportAsync(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreatePointsExpirationExportWithHttpInfoAsync(campaignId, loyaltiesPointsExpirationExportCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -4613,11 +4679,11 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// Unique campaign ID or name. - /// Specify the data filters, types of data to return and order in which the results should be returned. (optional) + /// Specify the data filters, types of data to return and order in which the results should be returned. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesPointsExpirationExportCreateResponseBody) - public async System.Threading.Tasks.Task> CreatePointsExpirationExportWithHttpInfoAsync(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody = default(LoyaltiesPointsExpirationExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreatePointsExpirationExportWithHttpInfoAsync(string campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -4625,6 +4691,12 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling LoyaltiesApi->CreatePointsExpirationExport"); } + // verify the required parameter 'loyaltiesPointsExpirationExportCreateRequestBody' is set + if (loyaltiesPointsExpirationExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesPointsExpirationExportCreateRequestBody' when calling LoyaltiesApi->CreatePointsExpirationExport"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -4702,10 +4774,10 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Define the cost of the rewards in loyalty points. (optional) + /// Define the cost of the rewards in loyalty points. /// Index associated with the operation. /// LoyaltiesRewardsCreateAssignmentResponseBody - public LoyaltiesRewardsCreateAssignmentResponseBody CreateRewardAssignment1(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody = default(List), int operationIndex = 0) + public LoyaltiesRewardsCreateAssignmentResponseBody CreateRewardAssignment1(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateRewardAssignment1WithHttpInfo(campaignId, loyaltiesRewardsCreateAssignmentItemRequestBody); return localVarResponse.Data; @@ -4716,10 +4788,10 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Define the cost of the rewards in loyalty points. (optional) + /// Define the cost of the rewards in loyalty points. /// Index associated with the operation. /// ApiResponse of LoyaltiesRewardsCreateAssignmentResponseBody - public Voucherify.Client.ApiResponse CreateRewardAssignment1WithHttpInfo(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody = default(List), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateRewardAssignment1WithHttpInfo(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -4727,6 +4799,12 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling LoyaltiesApi->CreateRewardAssignment1"); } + // verify the required parameter 'loyaltiesRewardsCreateAssignmentItemRequestBody' is set + if (loyaltiesRewardsCreateAssignmentItemRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesRewardsCreateAssignmentItemRequestBody' when calling LoyaltiesApi->CreateRewardAssignment1"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -4803,11 +4881,11 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Define the cost of the rewards in loyalty points. (optional) + /// Define the cost of the rewards in loyalty points. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesRewardsCreateAssignmentResponseBody - public async System.Threading.Tasks.Task CreateRewardAssignment1Async(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateRewardAssignment1Async(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateRewardAssignment1WithHttpInfoAsync(campaignId, loyaltiesRewardsCreateAssignmentItemRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -4818,11 +4896,11 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn /// /// Thrown when fails to make API call /// Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Define the cost of the rewards in loyalty points. (optional) + /// Define the cost of the rewards in loyalty points. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesRewardsCreateAssignmentResponseBody) - public async System.Threading.Tasks.Task> CreateRewardAssignment1WithHttpInfoAsync(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateRewardAssignment1WithHttpInfoAsync(string campaignId, List loyaltiesRewardsCreateAssignmentItemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -4830,6 +4908,12 @@ public Voucherify.Client.ApiResponse CancelMemberPendingPointsWithHttpIn throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling LoyaltiesApi->CreateRewardAssignment1"); } + // verify the required parameter 'loyaltiesRewardsCreateAssignmentItemRequestBody' is set + if (loyaltiesRewardsCreateAssignmentItemRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesRewardsCreateAssignmentItemRequestBody' when calling LoyaltiesApi->CreateRewardAssignment1"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -5968,10 +6052,10 @@ public Voucherify.Client.ApiResponse En /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// CampaignsTransactionsExportCreateResponseBody - public CampaignsTransactionsExportCreateResponseBody ExportLoyaltyCampaignTransactions(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody = default(LoyaltiesTransactionsExportCreateRequestBody), int operationIndex = 0) + public CampaignsTransactionsExportCreateResponseBody ExportLoyaltyCampaignTransactions(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = ExportLoyaltyCampaignTransactionsWithHttpInfo(campaignId, loyaltiesTransactionsExportCreateRequestBody); return localVarResponse.Data; @@ -5982,10 +6066,10 @@ public Voucherify.Client.ApiResponse En /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// ApiResponse of CampaignsTransactionsExportCreateResponseBody - public Voucherify.Client.ApiResponse ExportLoyaltyCampaignTransactionsWithHttpInfo(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody = default(LoyaltiesTransactionsExportCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse ExportLoyaltyCampaignTransactionsWithHttpInfo(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -5993,6 +6077,12 @@ public Voucherify.Client.ApiResponse En throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling LoyaltiesApi->ExportLoyaltyCampaignTransactions"); } + // verify the required parameter 'loyaltiesTransactionsExportCreateRequestBody' is set + if (loyaltiesTransactionsExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesTransactionsExportCreateRequestBody' when calling LoyaltiesApi->ExportLoyaltyCampaignTransactions"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -6069,11 +6159,11 @@ public Voucherify.Client.ApiResponse En /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of CampaignsTransactionsExportCreateResponseBody - public async System.Threading.Tasks.Task ExportLoyaltyCampaignTransactionsAsync(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody = default(LoyaltiesTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ExportLoyaltyCampaignTransactionsAsync(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await ExportLoyaltyCampaignTransactionsWithHttpInfoAsync(campaignId, loyaltiesTransactionsExportCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -6084,11 +6174,11 @@ public Voucherify.Client.ApiResponse En /// /// Thrown when fails to make API call /// You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. - /// Specify the parameters for the transaction export. (optional) + /// Specify the parameters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (CampaignsTransactionsExportCreateResponseBody) - public async System.Threading.Tasks.Task> ExportLoyaltyCampaignTransactionsWithHttpInfoAsync(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody = default(LoyaltiesTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ExportLoyaltyCampaignTransactionsWithHttpInfoAsync(string campaignId, LoyaltiesTransactionsExportCreateRequestBody loyaltiesTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -6096,6 +6186,12 @@ public Voucherify.Client.ApiResponse En throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling LoyaltiesApi->ExportLoyaltyCampaignTransactions"); } + // verify the required parameter 'loyaltiesTransactionsExportCreateRequestBody' is set + if (loyaltiesTransactionsExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesTransactionsExportCreateRequestBody' when calling LoyaltiesApi->ExportLoyaltyCampaignTransactions"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -6173,10 +6269,10 @@ public Voucherify.Client.ApiResponse En /// /// Thrown when fails to make API call /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// LoyaltiesMembersTransactionsExportCreateResponseBody - public LoyaltiesMembersTransactionsExportCreateResponseBody ExportLoyaltyCardTransactions(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0) + public LoyaltiesMembersTransactionsExportCreateResponseBody ExportLoyaltyCardTransactions(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = ExportLoyaltyCardTransactionsWithHttpInfo(memberId, loyaltiesMembersTransactionsExportCreateRequestBody); return localVarResponse.Data; @@ -6187,10 +6283,10 @@ public Voucherify.Client.ApiResponse En /// /// Thrown when fails to make API call /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody - public Voucherify.Client.ApiResponse ExportLoyaltyCardTransactionsWithHttpInfo(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse ExportLoyaltyCardTransactionsWithHttpInfo(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'memberId' is set if (memberId == null) @@ -6198,6 +6294,12 @@ public Voucherify.Client.ApiResponse En throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->ExportLoyaltyCardTransactions"); } + // verify the required parameter 'loyaltiesMembersTransactionsExportCreateRequestBody' is set + if (loyaltiesMembersTransactionsExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersTransactionsExportCreateRequestBody' when calling LoyaltiesApi->ExportLoyaltyCardTransactions"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -6274,11 +6376,11 @@ public Voucherify.Client.ApiResponse En /// /// Thrown when fails to make API call /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersTransactionsExportCreateResponseBody - public async System.Threading.Tasks.Task ExportLoyaltyCardTransactionsAsync(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ExportLoyaltyCardTransactionsAsync(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await ExportLoyaltyCardTransactionsWithHttpInfoAsync(memberId, loyaltiesMembersTransactionsExportCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -6289,11 +6391,11 @@ public Voucherify.Client.ApiResponse En /// /// Thrown when fails to make API call /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) - public async System.Threading.Tasks.Task> ExportLoyaltyCardTransactionsWithHttpInfoAsync(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ExportLoyaltyCardTransactionsWithHttpInfoAsync(string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'memberId' is set if (memberId == null) @@ -6301,6 +6403,12 @@ public Voucherify.Client.ApiResponse En throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->ExportLoyaltyCardTransactions"); } + // verify the required parameter 'loyaltiesMembersTransactionsExportCreateRequestBody' is set + if (loyaltiesMembersTransactionsExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersTransactionsExportCreateRequestBody' when calling LoyaltiesApi->ExportLoyaltyCardTransactions"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -6379,10 +6487,10 @@ public Voucherify.Client.ApiResponse En /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// LoyaltiesMembersTransactionsExportCreateResponseBody - public LoyaltiesMembersTransactionsExportCreateResponseBody ExportLoyaltyCardTransactions1(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0) + public LoyaltiesMembersTransactionsExportCreateResponseBody ExportLoyaltyCardTransactions1(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = ExportLoyaltyCardTransactions1WithHttpInfo(campaignId, memberId, loyaltiesMembersTransactionsExportCreateRequestBody); return localVarResponse.Data; @@ -6394,10 +6502,10 @@ public Voucherify.Client.ApiResponse En /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersTransactionsExportCreateResponseBody - public Voucherify.Client.ApiResponse ExportLoyaltyCardTransactions1WithHttpInfo(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse ExportLoyaltyCardTransactions1WithHttpInfo(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -6411,6 +6519,12 @@ public Voucherify.Client.ApiResponse En throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->ExportLoyaltyCardTransactions1"); } + // verify the required parameter 'loyaltiesMembersTransactionsExportCreateRequestBody' is set + if (loyaltiesMembersTransactionsExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersTransactionsExportCreateRequestBody' when calling LoyaltiesApi->ExportLoyaltyCardTransactions1"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -6489,11 +6603,11 @@ public Voucherify.Client.ApiResponse En /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersTransactionsExportCreateResponseBody - public async System.Threading.Tasks.Task ExportLoyaltyCardTransactions1Async(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ExportLoyaltyCardTransactions1Async(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await ExportLoyaltyCardTransactions1WithHttpInfoAsync(campaignId, memberId, loyaltiesMembersTransactionsExportCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -6505,11 +6619,11 @@ public Voucherify.Client.ApiResponse En /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. /// A unique code identifying the loyalty card that you are looking to export transaction data for. - /// Specify the parameters and filters for the transaction export. (optional) + /// Specify the parameters and filters for the transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersTransactionsExportCreateResponseBody) - public async System.Threading.Tasks.Task> ExportLoyaltyCardTransactions1WithHttpInfoAsync(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody = default(LoyaltiesMembersTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ExportLoyaltyCardTransactions1WithHttpInfoAsync(string campaignId, string memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -6523,6 +6637,12 @@ public Voucherify.Client.ApiResponse En throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->ExportLoyaltyCardTransactions1"); } + // verify the required parameter 'loyaltiesMembersTransactionsExportCreateRequestBody' is set + if (loyaltiesMembersTransactionsExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersTransactionsExportCreateRequestBody' when calling LoyaltiesApi->ExportLoyaltyCardTransactions1"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -12856,10 +12976,10 @@ public Voucherify.Client.ApiResponse List /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// LoyaltiesMembersRedemptionRedeemResponseBody - public LoyaltiesMembersRedemptionRedeemResponseBody RedeemReward(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0) + public LoyaltiesMembersRedemptionRedeemResponseBody RedeemReward(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = RedeemRewardWithHttpInfo(memberId, loyaltiesMembersRedemptionRedeemRequestBody); return localVarResponse.Data; @@ -12870,10 +12990,10 @@ public Voucherify.Client.ApiResponse List /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody - public Voucherify.Client.ApiResponse RedeemRewardWithHttpInfo(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse RedeemRewardWithHttpInfo(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0) { // verify the required parameter 'memberId' is set if (memberId == null) @@ -12881,6 +13001,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->RedeemReward"); } + // verify the required parameter 'loyaltiesMembersRedemptionRedeemRequestBody' is set + if (loyaltiesMembersRedemptionRedeemRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersRedemptionRedeemRequestBody' when calling LoyaltiesApi->RedeemReward"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -12957,11 +13083,11 @@ public Voucherify.Client.ApiResponse List /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersRedemptionRedeemResponseBody - public async System.Threading.Tasks.Task RedeemRewardAsync(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task RedeemRewardAsync(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await RedeemRewardWithHttpInfoAsync(memberId, loyaltiesMembersRedemptionRedeemRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -12972,11 +13098,11 @@ public Voucherify.Client.ApiResponse List /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) - public async System.Threading.Tasks.Task> RedeemRewardWithHttpInfoAsync(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> RedeemRewardWithHttpInfoAsync(string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'memberId' is set if (memberId == null) @@ -12984,6 +13110,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->RedeemReward"); } + // verify the required parameter 'loyaltiesMembersRedemptionRedeemRequestBody' is set + if (loyaltiesMembersRedemptionRedeemRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersRedemptionRedeemRequestBody' when calling LoyaltiesApi->RedeemReward"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -13062,10 +13194,10 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// LoyaltiesMembersRedemptionRedeemResponseBody - public LoyaltiesMembersRedemptionRedeemResponseBody RedeemReward1(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0) + public LoyaltiesMembersRedemptionRedeemResponseBody RedeemReward1(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = RedeemReward1WithHttpInfo(campaignId, memberId, loyaltiesMembersRedemptionRedeemRequestBody); return localVarResponse.Data; @@ -13077,10 +13209,10 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersRedemptionRedeemResponseBody - public Voucherify.Client.ApiResponse RedeemReward1WithHttpInfo(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse RedeemReward1WithHttpInfo(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -13094,6 +13226,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->RedeemReward1"); } + // verify the required parameter 'loyaltiesMembersRedemptionRedeemRequestBody' is set + if (loyaltiesMembersRedemptionRedeemRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersRedemptionRedeemRequestBody' when calling LoyaltiesApi->RedeemReward1"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -13172,11 +13310,11 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersRedemptionRedeemResponseBody - public async System.Threading.Tasks.Task RedeemReward1Async(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task RedeemReward1Async(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await RedeemReward1WithHttpInfoAsync(campaignId, memberId, loyaltiesMembersRedemptionRedeemRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -13188,11 +13326,11 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional) + /// Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersRedemptionRedeemResponseBody) - public async System.Threading.Tasks.Task> RedeemReward1WithHttpInfoAsync(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody = default(LoyaltiesMembersRedemptionRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> RedeemReward1WithHttpInfoAsync(string campaignId, string memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -13206,6 +13344,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->RedeemReward1"); } + // verify the required parameter 'loyaltiesMembersRedemptionRedeemRequestBody' is set + if (loyaltiesMembersRedemptionRedeemRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersRedemptionRedeemRequestBody' when calling LoyaltiesApi->RedeemReward1"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -13285,10 +13429,10 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). /// A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. /// Index associated with the operation. /// LoyaltiesMembersTransfersCreateResponseBody - public LoyaltiesMembersTransfersCreateResponseBody TransferPoints(string campaignId, string memberId, List loyaltiesTransferPoints = default(List), int operationIndex = 0) + public LoyaltiesMembersTransfersCreateResponseBody TransferPoints(string campaignId, string memberId, List loyaltiesTransferPoints, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = TransferPointsWithHttpInfo(campaignId, memberId, loyaltiesTransferPoints); return localVarResponse.Data; @@ -13300,10 +13444,10 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). /// A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersTransfersCreateResponseBody - public Voucherify.Client.ApiResponse TransferPointsWithHttpInfo(string campaignId, string memberId, List loyaltiesTransferPoints = default(List), int operationIndex = 0) + public Voucherify.Client.ApiResponse TransferPointsWithHttpInfo(string campaignId, string memberId, List loyaltiesTransferPoints, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -13317,6 +13461,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->TransferPoints"); } + // verify the required parameter 'loyaltiesTransferPoints' is set + if (loyaltiesTransferPoints == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesTransferPoints' when calling LoyaltiesApi->TransferPoints"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -13395,11 +13545,11 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). /// A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersTransfersCreateResponseBody - public async System.Threading.Tasks.Task TransferPointsAsync(string campaignId, string memberId, List loyaltiesTransferPoints = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task TransferPointsAsync(string campaignId, string memberId, List loyaltiesTransferPoints, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await TransferPointsWithHttpInfoAsync(campaignId, memberId, loyaltiesTransferPoints, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -13411,11 +13561,11 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). /// A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). - /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional) + /// Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersTransfersCreateResponseBody) - public async System.Threading.Tasks.Task> TransferPointsWithHttpInfoAsync(string campaignId, string memberId, List loyaltiesTransferPoints = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> TransferPointsWithHttpInfoAsync(string campaignId, string memberId, List loyaltiesTransferPoints, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -13429,6 +13579,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->TransferPoints"); } + // verify the required parameter 'loyaltiesTransferPoints' is set + if (loyaltiesTransferPoints == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesTransferPoints' when calling LoyaltiesApi->TransferPoints"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -13508,10 +13664,10 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique earning rule ID. - /// Specify the parameters that you would like to update for the given earning rule. (optional) + /// Specify the parameters that you would like to update for the given earning rule. /// Index associated with the operation. /// LoyaltiesEarningRulesUpdateResponseBody - public LoyaltiesEarningRulesUpdateResponseBody UpdateEarningRule(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody = default(LoyaltiesEarningRulesUpdateRequestBody), int operationIndex = 0) + public LoyaltiesEarningRulesUpdateResponseBody UpdateEarningRule(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateEarningRuleWithHttpInfo(campaignId, earningRuleId, loyaltiesEarningRulesUpdateRequestBody); return localVarResponse.Data; @@ -13523,10 +13679,10 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique earning rule ID. - /// Specify the parameters that you would like to update for the given earning rule. (optional) + /// Specify the parameters that you would like to update for the given earning rule. /// Index associated with the operation. /// ApiResponse of LoyaltiesEarningRulesUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateEarningRuleWithHttpInfo(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody = default(LoyaltiesEarningRulesUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateEarningRuleWithHttpInfo(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -13540,6 +13696,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'earningRuleId' when calling LoyaltiesApi->UpdateEarningRule"); } + // verify the required parameter 'loyaltiesEarningRulesUpdateRequestBody' is set + if (loyaltiesEarningRulesUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesEarningRulesUpdateRequestBody' when calling LoyaltiesApi->UpdateEarningRule"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -13618,11 +13780,11 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique earning rule ID. - /// Specify the parameters that you would like to update for the given earning rule. (optional) + /// Specify the parameters that you would like to update for the given earning rule. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesEarningRulesUpdateResponseBody - public async System.Threading.Tasks.Task UpdateEarningRuleAsync(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody = default(LoyaltiesEarningRulesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateEarningRuleAsync(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateEarningRuleWithHttpInfoAsync(campaignId, earningRuleId, loyaltiesEarningRulesUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -13634,11 +13796,11 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique earning rule ID. - /// Specify the parameters that you would like to update for the given earning rule. (optional) + /// Specify the parameters that you would like to update for the given earning rule. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesEarningRulesUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateEarningRuleWithHttpInfoAsync(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody = default(LoyaltiesEarningRulesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateEarningRuleWithHttpInfoAsync(string campaignId, string earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -13652,6 +13814,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'earningRuleId' when calling LoyaltiesApi->UpdateEarningRule"); } + // verify the required parameter 'loyaltiesEarningRulesUpdateRequestBody' is set + if (loyaltiesEarningRulesUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesEarningRulesUpdateRequestBody' when calling LoyaltiesApi->UpdateEarningRule"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -13730,10 +13898,10 @@ public Voucherify.Client.ApiResponse List /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// LoyaltiesMembersBalanceUpdateResponseBody - public LoyaltiesMembersBalanceUpdateResponseBody UpdateLoyaltyCardBalance(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0) + public LoyaltiesMembersBalanceUpdateResponseBody UpdateLoyaltyCardBalance(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateLoyaltyCardBalanceWithHttpInfo(memberId, loyaltiesMembersBalanceUpdateRequestBody); return localVarResponse.Data; @@ -13744,10 +13912,10 @@ public Voucherify.Client.ApiResponse List /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateLoyaltyCardBalanceWithHttpInfo(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateLoyaltyCardBalanceWithHttpInfo(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'memberId' is set if (memberId == null) @@ -13755,6 +13923,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->UpdateLoyaltyCardBalance"); } + // verify the required parameter 'loyaltiesMembersBalanceUpdateRequestBody' is set + if (loyaltiesMembersBalanceUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersBalanceUpdateRequestBody' when calling LoyaltiesApi->UpdateLoyaltyCardBalance"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -13831,11 +14005,11 @@ public Voucherify.Client.ApiResponse List /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersBalanceUpdateResponseBody - public async System.Threading.Tasks.Task UpdateLoyaltyCardBalanceAsync(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateLoyaltyCardBalanceAsync(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateLoyaltyCardBalanceWithHttpInfoAsync(memberId, loyaltiesMembersBalanceUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -13846,11 +14020,11 @@ public Voucherify.Client.ApiResponse List /// /// Thrown when fails to make API call /// Unique loyalty card assigned to a particular customer. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateLoyaltyCardBalanceWithHttpInfoAsync(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateLoyaltyCardBalanceWithHttpInfoAsync(string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'memberId' is set if (memberId == null) @@ -13858,6 +14032,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->UpdateLoyaltyCardBalance"); } + // verify the required parameter 'loyaltiesMembersBalanceUpdateRequestBody' is set + if (loyaltiesMembersBalanceUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersBalanceUpdateRequestBody' when calling LoyaltiesApi->UpdateLoyaltyCardBalance"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -13936,10 +14116,10 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// LoyaltiesMembersBalanceUpdateResponseBody - public LoyaltiesMembersBalanceUpdateResponseBody UpdateLoyaltyCardBalance1(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0) + public LoyaltiesMembersBalanceUpdateResponseBody UpdateLoyaltyCardBalance1(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateLoyaltyCardBalance1WithHttpInfo(campaignId, memberId, loyaltiesMembersBalanceUpdateRequestBody); return localVarResponse.Data; @@ -13951,10 +14131,10 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// ApiResponse of LoyaltiesMembersBalanceUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateLoyaltyCardBalance1WithHttpInfo(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateLoyaltyCardBalance1WithHttpInfo(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -13968,6 +14148,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->UpdateLoyaltyCardBalance1"); } + // verify the required parameter 'loyaltiesMembersBalanceUpdateRequestBody' is set + if (loyaltiesMembersBalanceUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersBalanceUpdateRequestBody' when calling LoyaltiesApi->UpdateLoyaltyCardBalance1"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -14046,11 +14232,11 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesMembersBalanceUpdateResponseBody - public async System.Threading.Tasks.Task UpdateLoyaltyCardBalance1Async(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateLoyaltyCardBalance1Async(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateLoyaltyCardBalance1WithHttpInfoAsync(campaignId, memberId, loyaltiesMembersBalanceUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -14062,11 +14248,11 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// Unique campaign ID. /// A code that identifies the loyalty card. - /// Specify the point adjustment along with the expiration mechanism. (optional) + /// Specify the point adjustment along with the expiration mechanism. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesMembersBalanceUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateLoyaltyCardBalance1WithHttpInfoAsync(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody = default(LoyaltiesMembersBalanceUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateLoyaltyCardBalance1WithHttpInfoAsync(string campaignId, string memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -14080,6 +14266,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling LoyaltiesApi->UpdateLoyaltyCardBalance1"); } + // verify the required parameter 'loyaltiesMembersBalanceUpdateRequestBody' is set + if (loyaltiesMembersBalanceUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesMembersBalanceUpdateRequestBody' when calling LoyaltiesApi->UpdateLoyaltyCardBalance1"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -14158,10 +14350,10 @@ public Voucherify.Client.ApiResponse List /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. /// Index associated with the operation. /// LoyaltiesUpdateCampaignResponseBody - public LoyaltiesUpdateCampaignResponseBody UpdateLoyaltyProgram(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody = default(LoyaltiesUpdateCampaignRequestBody), int operationIndex = 0) + public LoyaltiesUpdateCampaignResponseBody UpdateLoyaltyProgram(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateLoyaltyProgramWithHttpInfo(campaignId, loyaltiesUpdateCampaignRequestBody); return localVarResponse.Data; @@ -14172,10 +14364,10 @@ public Voucherify.Client.ApiResponse List /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. /// Index associated with the operation. /// ApiResponse of LoyaltiesUpdateCampaignResponseBody - public Voucherify.Client.ApiResponse UpdateLoyaltyProgramWithHttpInfo(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody = default(LoyaltiesUpdateCampaignRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateLoyaltyProgramWithHttpInfo(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -14183,6 +14375,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling LoyaltiesApi->UpdateLoyaltyProgram"); } + // verify the required parameter 'loyaltiesUpdateCampaignRequestBody' is set + if (loyaltiesUpdateCampaignRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesUpdateCampaignRequestBody' when calling LoyaltiesApi->UpdateLoyaltyProgram"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -14259,11 +14457,11 @@ public Voucherify.Client.ApiResponse List /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesUpdateCampaignResponseBody - public async System.Threading.Tasks.Task UpdateLoyaltyProgramAsync(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody = default(LoyaltiesUpdateCampaignRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateLoyaltyProgramAsync(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateLoyaltyProgramWithHttpInfoAsync(campaignId, loyaltiesUpdateCampaignRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -14274,11 +14472,11 @@ public Voucherify.Client.ApiResponse List /// /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. - /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional) + /// Specify the new values for the parameters that you would like to update for the given loyalty campaign. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesUpdateCampaignResponseBody) - public async System.Threading.Tasks.Task> UpdateLoyaltyProgramWithHttpInfoAsync(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody = default(LoyaltiesUpdateCampaignRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateLoyaltyProgramWithHttpInfoAsync(string campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -14286,6 +14484,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling LoyaltiesApi->UpdateLoyaltyProgram"); } + // verify the required parameter 'loyaltiesUpdateCampaignRequestBody' is set + if (loyaltiesUpdateCampaignRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesUpdateCampaignRequestBody' when calling LoyaltiesApi->UpdateLoyaltyProgram"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -14364,10 +14568,10 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique reward assignment ID. - /// Update the points cost for the reward assignment. (optional) + /// Update the points cost for the reward assignment. /// Index associated with the operation. /// LoyaltiesRewardsUpdateAssignmentResponseBody - public LoyaltiesRewardsUpdateAssignmentResponseBody UpdateRewardAssignment1(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody = default(LoyaltiesRewardsUpdateAssignmentRequestBody), int operationIndex = 0) + public LoyaltiesRewardsUpdateAssignmentResponseBody UpdateRewardAssignment1(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateRewardAssignment1WithHttpInfo(campaignId, assignmentId, loyaltiesRewardsUpdateAssignmentRequestBody); return localVarResponse.Data; @@ -14379,10 +14583,10 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique reward assignment ID. - /// Update the points cost for the reward assignment. (optional) + /// Update the points cost for the reward assignment. /// Index associated with the operation. /// ApiResponse of LoyaltiesRewardsUpdateAssignmentResponseBody - public Voucherify.Client.ApiResponse UpdateRewardAssignment1WithHttpInfo(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody = default(LoyaltiesRewardsUpdateAssignmentRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateRewardAssignment1WithHttpInfo(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -14396,6 +14600,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'assignmentId' when calling LoyaltiesApi->UpdateRewardAssignment1"); } + // verify the required parameter 'loyaltiesRewardsUpdateAssignmentRequestBody' is set + if (loyaltiesRewardsUpdateAssignmentRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesRewardsUpdateAssignmentRequestBody' when calling LoyaltiesApi->UpdateRewardAssignment1"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -14474,11 +14684,11 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique reward assignment ID. - /// Update the points cost for the reward assignment. (optional) + /// Update the points cost for the reward assignment. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of LoyaltiesRewardsUpdateAssignmentResponseBody - public async System.Threading.Tasks.Task UpdateRewardAssignment1Async(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody = default(LoyaltiesRewardsUpdateAssignmentRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateRewardAssignment1Async(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateRewardAssignment1WithHttpInfoAsync(campaignId, assignmentId, loyaltiesRewardsUpdateAssignmentRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -14490,11 +14700,11 @@ public Voucherify.Client.ApiResponse List /// Thrown when fails to make API call /// The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. /// A unique reward assignment ID. - /// Update the points cost for the reward assignment. (optional) + /// Update the points cost for the reward assignment. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (LoyaltiesRewardsUpdateAssignmentResponseBody) - public async System.Threading.Tasks.Task> UpdateRewardAssignment1WithHttpInfoAsync(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody = default(LoyaltiesRewardsUpdateAssignmentRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateRewardAssignment1WithHttpInfoAsync(string campaignId, string assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -14508,6 +14718,12 @@ public Voucherify.Client.ApiResponse List throw new Voucherify.Client.ApiException(400, "Missing required parameter 'assignmentId' when calling LoyaltiesApi->UpdateRewardAssignment1"); } + // verify the required parameter 'loyaltiesRewardsUpdateAssignmentRequestBody' is set + if (loyaltiesRewardsUpdateAssignmentRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'loyaltiesRewardsUpdateAssignmentRequestBody' when calling LoyaltiesApi->UpdateRewardAssignment1"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/ManagementApi.cs b/src/Voucherify/Api/ManagementApi.cs index 08b44c70..32924764 100644 --- a/src/Voucherify/Api/ManagementApi.cs +++ b/src/Voucherify/Api/ManagementApi.cs @@ -36,10 +36,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the user details. (optional) + /// Defines the user details. /// Index associated with the operation. /// ManagementProjectsUsersAssignResponseBody - ManagementProjectsUsersAssignResponseBody AssignUser(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody = default(ManagementProjectsUsersAssignRequestBody), int operationIndex = 0); + ManagementProjectsUsersAssignResponseBody AssignUser(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody, int operationIndex = 0); /// /// Assign User @@ -49,10 +49,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the user details. (optional) + /// Defines the user details. /// Index associated with the operation. /// ApiResponse of ManagementProjectsUsersAssignResponseBody - ApiResponse AssignUserWithHttpInfo(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody = default(ManagementProjectsUsersAssignRequestBody), int operationIndex = 0); + ApiResponse AssignUserWithHttpInfo(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody, int operationIndex = 0); /// /// Create Brand /// @@ -61,10 +61,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a brand configuration. (optional) + /// Defines a brand configuration. /// Index associated with the operation. /// ManagementProjectsBrandingCreateResponseBody - ManagementProjectsBrandingCreateResponseBody CreateBrand(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody = default(ManagementProjectsBrandingCreateRequestBody), int operationIndex = 0); + ManagementProjectsBrandingCreateResponseBody CreateBrand(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody, int operationIndex = 0); /// /// Create Brand @@ -74,10 +74,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a brand configuration. (optional) + /// Defines a brand configuration. /// Index associated with the operation. /// ApiResponse of ManagementProjectsBrandingCreateResponseBody - ApiResponse CreateBrandWithHttpInfo(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody = default(ManagementProjectsBrandingCreateRequestBody), int operationIndex = 0); + ApiResponse CreateBrandWithHttpInfo(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody, int operationIndex = 0); /// /// Create Custom Event Schema /// @@ -86,10 +86,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the custom event schema. (optional) + /// Defines the custom event schema. /// Index associated with the operation. /// ManagementProjectsCustomEventSchemasCreateResponseBody - ManagementProjectsCustomEventSchemasCreateResponseBody CreateCustomEventSchema(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody = default(ManagementProjectsCustomEventSchemasCreateRequestBody), int operationIndex = 0); + ManagementProjectsCustomEventSchemasCreateResponseBody CreateCustomEventSchema(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody, int operationIndex = 0); /// /// Create Custom Event Schema @@ -99,10 +99,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the custom event schema. (optional) + /// Defines the custom event schema. /// Index associated with the operation. /// ApiResponse of ManagementProjectsCustomEventSchemasCreateResponseBody - ApiResponse CreateCustomEventSchemaWithHttpInfo(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody = default(ManagementProjectsCustomEventSchemasCreateRequestBody), int operationIndex = 0); + ApiResponse CreateCustomEventSchemaWithHttpInfo(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody, int operationIndex = 0); /// /// Create Metadata Schema /// @@ -111,10 +111,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the metadata schema. (optional) + /// Defines the metadata schema. /// Index associated with the operation. /// ManagementProjectsMetadataSchemasCreateResponseBody - ManagementProjectsMetadataSchemasCreateResponseBody CreateMetadataSchema(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody = default(ManagementProjectsMetadataSchemasCreateRequestBody), int operationIndex = 0); + ManagementProjectsMetadataSchemasCreateResponseBody CreateMetadataSchema(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody, int operationIndex = 0); /// /// Create Metadata Schema @@ -124,10 +124,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the metadata schema. (optional) + /// Defines the metadata schema. /// Index associated with the operation. /// ApiResponse of ManagementProjectsMetadataSchemasCreateResponseBody - ApiResponse CreateMetadataSchemaWithHttpInfo(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody = default(ManagementProjectsMetadataSchemasCreateRequestBody), int operationIndex = 0); + ApiResponse CreateMetadataSchemaWithHttpInfo(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody, int operationIndex = 0); /// /// Create Project /// @@ -135,10 +135,10 @@ public interface IManagementApiSync : IApiAccessor /// Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. /// /// Thrown when fails to make API call - /// Define project details. (optional) + /// Define project details. /// Index associated with the operation. /// ManagementProjectsCreateResponseBody - ManagementProjectsCreateResponseBody CreateProject(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody = default(ManagementProjectsCreateRequestBody), int operationIndex = 0); + ManagementProjectsCreateResponseBody CreateProject(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody, int operationIndex = 0); /// /// Create Project @@ -147,10 +147,10 @@ public interface IManagementApiSync : IApiAccessor /// Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. /// /// Thrown when fails to make API call - /// Define project details. (optional) + /// Define project details. /// Index associated with the operation. /// ApiResponse of ManagementProjectsCreateResponseBody - ApiResponse CreateProjectWithHttpInfo(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody = default(ManagementProjectsCreateRequestBody), int operationIndex = 0); + ApiResponse CreateProjectWithHttpInfo(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody, int operationIndex = 0); /// /// Create Stacking Rules /// @@ -159,10 +159,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the stacking rule parameters. (optional) + /// Defines the stacking rule parameters. /// Index associated with the operation. /// ManagementProjectsStackingRulesCreateResponseBody - ManagementProjectsStackingRulesCreateResponseBody CreateStackingRules(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody = default(ManagementProjectsStackingRulesCreateRequestBody), int operationIndex = 0); + ManagementProjectsStackingRulesCreateResponseBody CreateStackingRules(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody, int operationIndex = 0); /// /// Create Stacking Rules @@ -172,10 +172,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the stacking rule parameters. (optional) + /// Defines the stacking rule parameters. /// Index associated with the operation. /// ApiResponse of ManagementProjectsStackingRulesCreateResponseBody - ApiResponse CreateStackingRulesWithHttpInfo(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody = default(ManagementProjectsStackingRulesCreateRequestBody), int operationIndex = 0); + ApiResponse CreateStackingRulesWithHttpInfo(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody, int operationIndex = 0); /// /// Create Webhook /// @@ -184,10 +184,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a webhook configuration. (optional) + /// Defines a webhook configuration. /// Index associated with the operation. /// ManagementProjectsWebhooksCreateResponseBody - ManagementProjectsWebhooksCreateResponseBody CreateWebhook(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody = default(ManagementProjectsWebhooksCreateRequestBody), int operationIndex = 0); + ManagementProjectsWebhooksCreateResponseBody CreateWebhook(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody, int operationIndex = 0); /// /// Create Webhook @@ -197,10 +197,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a webhook configuration. (optional) + /// Defines a webhook configuration. /// Index associated with the operation. /// ApiResponse of ManagementProjectsWebhooksCreateResponseBody - ApiResponse CreateWebhookWithHttpInfo(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody = default(ManagementProjectsWebhooksCreateRequestBody), int operationIndex = 0); + ApiResponse CreateWebhookWithHttpInfo(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody, int operationIndex = 0); /// /// Delete Brand /// @@ -529,10 +529,10 @@ public interface IManagementApiSync : IApiAccessor /// Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. /// /// Thrown when fails to make API call - /// Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + /// Defines the details of the invitation, the project, and roles to which the user will be assigned. /// Index associated with the operation. /// - void InviteUser(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody = default(ManagementProjectsUsersInviteCreateRequestBody), int operationIndex = 0); + void InviteUser(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody, int operationIndex = 0); /// /// Invite a New User @@ -541,10 +541,10 @@ public interface IManagementApiSync : IApiAccessor /// Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. /// /// Thrown when fails to make API call - /// Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + /// Defines the details of the invitation, the project, and roles to which the user will be assigned. /// Index associated with the operation. /// ApiResponse of Object(void) - ApiResponse InviteUserWithHttpInfo(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody = default(ManagementProjectsUsersInviteCreateRequestBody), int operationIndex = 0); + ApiResponse InviteUserWithHttpInfo(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody, int operationIndex = 0); /// /// List Brands /// @@ -713,10 +713,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the campaign template. - /// Determines the details about the template in the destination project as well as the destination project itself. (optional) + /// Determines the details about the template in the destination project as well as the destination project itself. /// Index associated with the operation. /// ManagementProjectsTemplatesCampaignsCopyCreateResponseBody - ManagementProjectsTemplatesCampaignsCopyCreateResponseBody ManagementCopyCampaignTemplate(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody = default(ManagementProjectsTemplatesCampaignsCopyCreateRequestBody), int operationIndex = 0); + ManagementProjectsTemplatesCampaignsCopyCreateResponseBody ManagementCopyCampaignTemplate(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody, int operationIndex = 0); /// /// Copy Campaign Template to a Project @@ -727,10 +727,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the campaign template. - /// Determines the details about the template in the destination project as well as the destination project itself. (optional) + /// Determines the details about the template in the destination project as well as the destination project itself. /// Index associated with the operation. /// ApiResponse of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody - ApiResponse ManagementCopyCampaignTemplateWithHttpInfo(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody = default(ManagementProjectsTemplatesCampaignsCopyCreateRequestBody), int operationIndex = 0); + ApiResponse ManagementCopyCampaignTemplateWithHttpInfo(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody, int operationIndex = 0); /// /// List Campaign Templates /// @@ -798,10 +798,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the brand configuration. - /// Defines the brand configuration to be updated. (optional) + /// Defines the brand configuration to be updated. /// Index associated with the operation. /// ManagementProjectsBrandingUpdateResponseBody - ManagementProjectsBrandingUpdateResponseBody UpdateBrand(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody = default(ManagementProjectsBrandingUpdateRequestBody), int operationIndex = 0); + ManagementProjectsBrandingUpdateResponseBody UpdateBrand(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody, int operationIndex = 0); /// /// Update Brand @@ -812,10 +812,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the brand configuration. - /// Defines the brand configuration to be updated. (optional) + /// Defines the brand configuration to be updated. /// Index associated with the operation. /// ApiResponse of ManagementProjectsBrandingUpdateResponseBody - ApiResponse UpdateBrandWithHttpInfo(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody = default(ManagementProjectsBrandingUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateBrandWithHttpInfo(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody, int operationIndex = 0); /// /// Update Custom Event Schema /// @@ -825,10 +825,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the custom event schema. - /// Defines the custom event schema to be updated. (optional) + /// Defines the custom event schema to be updated. /// Index associated with the operation. /// ManagementProjectsCustomEventSchemasUpdateResponseBody - ManagementProjectsCustomEventSchemasUpdateResponseBody UpdateCustomEventSchema(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody = default(ManagementProjectsCustomEventSchemasUpdateRequestBody), int operationIndex = 0); + ManagementProjectsCustomEventSchemasUpdateResponseBody UpdateCustomEventSchema(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody, int operationIndex = 0); /// /// Update Custom Event Schema @@ -839,10 +839,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the custom event schema. - /// Defines the custom event schema to be updated. (optional) + /// Defines the custom event schema to be updated. /// Index associated with the operation. /// ApiResponse of ManagementProjectsCustomEventSchemasUpdateResponseBody - ApiResponse UpdateCustomEventSchemaWithHttpInfo(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody = default(ManagementProjectsCustomEventSchemasUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateCustomEventSchemaWithHttpInfo(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody, int operationIndex = 0); /// /// Update Metadata Schema /// @@ -852,10 +852,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the metadata schema. - /// Defines the metadata schema to be updated. (optional) + /// Defines the metadata schema to be updated. /// Index associated with the operation. /// ManagementProjectsMetadataSchemasUpdateResponseBody - ManagementProjectsMetadataSchemasUpdateResponseBody UpdateMetadataSchema(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody = default(ManagementProjectsMetadataSchemasUpdateRequestBody), int operationIndex = 0); + ManagementProjectsMetadataSchemasUpdateResponseBody UpdateMetadataSchema(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody, int operationIndex = 0); /// /// Update Metadata Schema @@ -866,10 +866,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the metadata schema. - /// Defines the metadata schema to be updated. (optional) + /// Defines the metadata schema to be updated. /// Index associated with the operation. /// ApiResponse of ManagementProjectsMetadataSchemasUpdateResponseBody - ApiResponse UpdateMetadataSchemaWithHttpInfo(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody = default(ManagementProjectsMetadataSchemasUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateMetadataSchemaWithHttpInfo(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody, int operationIndex = 0); /// /// Update Project /// @@ -878,10 +878,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Define the project details to be updated. (optional) + /// Define the project details to be updated. /// Index associated with the operation. /// ManagementProjectsUpdateResponseBody - ManagementProjectsUpdateResponseBody UpdateProject(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody = default(ManagementProjectsUpdateRequestBody), int operationIndex = 0); + ManagementProjectsUpdateResponseBody UpdateProject(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody, int operationIndex = 0); /// /// Update Project @@ -891,10 +891,10 @@ public interface IManagementApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Define the project details to be updated. (optional) + /// Define the project details to be updated. /// Index associated with the operation. /// ApiResponse of ManagementProjectsUpdateResponseBody - ApiResponse UpdateProjectWithHttpInfo(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody = default(ManagementProjectsUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateProjectWithHttpInfo(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody, int operationIndex = 0); /// /// Update Stacking Rules /// @@ -904,10 +904,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the stacking rules. - /// Defines the stacking rules to be updated. (optional) + /// Defines the stacking rules to be updated. /// Index associated with the operation. /// ManagementProjectsStackingRulesUpdateResponseBody - ManagementProjectsStackingRulesUpdateResponseBody UpdateStackingRules(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody = default(ManagementProjectsStackingRulesUpdateRequestBody), int operationIndex = 0); + ManagementProjectsStackingRulesUpdateResponseBody UpdateStackingRules(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody, int operationIndex = 0); /// /// Update Stacking Rules @@ -918,10 +918,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the stacking rules. - /// Defines the stacking rules to be updated. (optional) + /// Defines the stacking rules to be updated. /// Index associated with the operation. /// ApiResponse of ManagementProjectsStackingRulesUpdateResponseBody - ApiResponse UpdateStackingRulesWithHttpInfo(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody = default(ManagementProjectsStackingRulesUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateStackingRulesWithHttpInfo(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody, int operationIndex = 0); /// /// Update User /// @@ -931,10 +931,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the user. Alternatively, provide the users login. - /// Defines the users new role. (optional) + /// Defines the users new role. /// Index associated with the operation. /// ManagementProjectsUsersUpdateRoleResponseBody - ManagementProjectsUsersUpdateRoleResponseBody UpdateUser(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody = default(ManagementProjectsUsersUpdateRoleRequestBody), int operationIndex = 0); + ManagementProjectsUsersUpdateRoleResponseBody UpdateUser(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody, int operationIndex = 0); /// /// Update User @@ -945,10 +945,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the user. Alternatively, provide the users login. - /// Defines the users new role. (optional) + /// Defines the users new role. /// Index associated with the operation. /// ApiResponse of ManagementProjectsUsersUpdateRoleResponseBody - ApiResponse UpdateUserWithHttpInfo(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody = default(ManagementProjectsUsersUpdateRoleRequestBody), int operationIndex = 0); + ApiResponse UpdateUserWithHttpInfo(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody, int operationIndex = 0); /// /// Update Webhook /// @@ -958,10 +958,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the webhook configuration. - /// Defines the webhook configuration to be updated. (optional) + /// Defines the webhook configuration to be updated. /// Index associated with the operation. /// ManagementProjectsWebhooksUpdateResponseBody - ManagementProjectsWebhooksUpdateResponseBody UpdateWebhook(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody = default(ManagementProjectsWebhooksUpdateRequestBody), int operationIndex = 0); + ManagementProjectsWebhooksUpdateResponseBody UpdateWebhook(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody, int operationIndex = 0); /// /// Update Webhook @@ -972,10 +972,10 @@ public interface IManagementApiSync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the webhook configuration. - /// Defines the webhook configuration to be updated. (optional) + /// Defines the webhook configuration to be updated. /// Index associated with the operation. /// ApiResponse of ManagementProjectsWebhooksUpdateResponseBody - ApiResponse UpdateWebhookWithHttpInfo(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody = default(ManagementProjectsWebhooksUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateWebhookWithHttpInfo(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -993,11 +993,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the user details. (optional) + /// Defines the user details. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsUsersAssignResponseBody - System.Threading.Tasks.Task AssignUserAsync(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody = default(ManagementProjectsUsersAssignRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task AssignUserAsync(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Assign User @@ -1007,11 +1007,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the user details. (optional) + /// Defines the user details. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsUsersAssignResponseBody) - System.Threading.Tasks.Task> AssignUserWithHttpInfoAsync(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody = default(ManagementProjectsUsersAssignRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> AssignUserWithHttpInfoAsync(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Brand /// @@ -1020,11 +1020,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a brand configuration. (optional) + /// Defines a brand configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsBrandingCreateResponseBody - System.Threading.Tasks.Task CreateBrandAsync(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody = default(ManagementProjectsBrandingCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateBrandAsync(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Brand @@ -1034,11 +1034,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a brand configuration. (optional) + /// Defines a brand configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsBrandingCreateResponseBody) - System.Threading.Tasks.Task> CreateBrandWithHttpInfoAsync(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody = default(ManagementProjectsBrandingCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateBrandWithHttpInfoAsync(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Custom Event Schema /// @@ -1047,11 +1047,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the custom event schema. (optional) + /// Defines the custom event schema. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsCustomEventSchemasCreateResponseBody - System.Threading.Tasks.Task CreateCustomEventSchemaAsync(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody = default(ManagementProjectsCustomEventSchemasCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateCustomEventSchemaAsync(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Custom Event Schema @@ -1061,11 +1061,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the custom event schema. (optional) + /// Defines the custom event schema. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsCustomEventSchemasCreateResponseBody) - System.Threading.Tasks.Task> CreateCustomEventSchemaWithHttpInfoAsync(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody = default(ManagementProjectsCustomEventSchemasCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateCustomEventSchemaWithHttpInfoAsync(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Metadata Schema /// @@ -1074,11 +1074,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the metadata schema. (optional) + /// Defines the metadata schema. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsMetadataSchemasCreateResponseBody - System.Threading.Tasks.Task CreateMetadataSchemaAsync(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody = default(ManagementProjectsMetadataSchemasCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateMetadataSchemaAsync(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Metadata Schema @@ -1088,11 +1088,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the metadata schema. (optional) + /// Defines the metadata schema. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsMetadataSchemasCreateResponseBody) - System.Threading.Tasks.Task> CreateMetadataSchemaWithHttpInfoAsync(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody = default(ManagementProjectsMetadataSchemasCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateMetadataSchemaWithHttpInfoAsync(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Project /// @@ -1100,11 +1100,11 @@ public interface IManagementApiAsync : IApiAccessor /// Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. /// /// Thrown when fails to make API call - /// Define project details. (optional) + /// Define project details. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsCreateResponseBody - System.Threading.Tasks.Task CreateProjectAsync(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody = default(ManagementProjectsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateProjectAsync(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Project @@ -1113,11 +1113,11 @@ public interface IManagementApiAsync : IApiAccessor /// Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. /// /// Thrown when fails to make API call - /// Define project details. (optional) + /// Define project details. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsCreateResponseBody) - System.Threading.Tasks.Task> CreateProjectWithHttpInfoAsync(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody = default(ManagementProjectsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateProjectWithHttpInfoAsync(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Stacking Rules /// @@ -1126,11 +1126,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the stacking rule parameters. (optional) + /// Defines the stacking rule parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsStackingRulesCreateResponseBody - System.Threading.Tasks.Task CreateStackingRulesAsync(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody = default(ManagementProjectsStackingRulesCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateStackingRulesAsync(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Stacking Rules @@ -1140,11 +1140,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the stacking rule parameters. (optional) + /// Defines the stacking rule parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsStackingRulesCreateResponseBody) - System.Threading.Tasks.Task> CreateStackingRulesWithHttpInfoAsync(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody = default(ManagementProjectsStackingRulesCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateStackingRulesWithHttpInfoAsync(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Webhook /// @@ -1153,11 +1153,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a webhook configuration. (optional) + /// Defines a webhook configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsWebhooksCreateResponseBody - System.Threading.Tasks.Task CreateWebhookAsync(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody = default(ManagementProjectsWebhooksCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateWebhookAsync(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Webhook @@ -1167,11 +1167,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a webhook configuration. (optional) + /// Defines a webhook configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsWebhooksCreateResponseBody) - System.Threading.Tasks.Task> CreateWebhookWithHttpInfoAsync(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody = default(ManagementProjectsWebhooksCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateWebhookWithHttpInfoAsync(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Brand /// @@ -1526,11 +1526,11 @@ public interface IManagementApiAsync : IApiAccessor /// Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. /// /// Thrown when fails to make API call - /// Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + /// Defines the details of the invitation, the project, and roles to which the user will be assigned. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of void - System.Threading.Tasks.Task InviteUserAsync(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody = default(ManagementProjectsUsersInviteCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task InviteUserAsync(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Invite a New User @@ -1539,11 +1539,11 @@ public interface IManagementApiAsync : IApiAccessor /// Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. /// /// Thrown when fails to make API call - /// Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + /// Defines the details of the invitation, the project, and roles to which the user will be assigned. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse - System.Threading.Tasks.Task> InviteUserWithHttpInfoAsync(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody = default(ManagementProjectsUsersInviteCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> InviteUserWithHttpInfoAsync(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// List Brands /// @@ -1726,11 +1726,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the campaign template. - /// Determines the details about the template in the destination project as well as the destination project itself. (optional) + /// Determines the details about the template in the destination project as well as the destination project itself. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody - System.Threading.Tasks.Task ManagementCopyCampaignTemplateAsync(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody = default(ManagementProjectsTemplatesCampaignsCopyCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task ManagementCopyCampaignTemplateAsync(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Copy Campaign Template to a Project @@ -1741,11 +1741,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the campaign template. - /// Determines the details about the template in the destination project as well as the destination project itself. (optional) + /// Determines the details about the template in the destination project as well as the destination project itself. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsTemplatesCampaignsCopyCreateResponseBody) - System.Threading.Tasks.Task> ManagementCopyCampaignTemplateWithHttpInfoAsync(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody = default(ManagementProjectsTemplatesCampaignsCopyCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ManagementCopyCampaignTemplateWithHttpInfoAsync(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// List Campaign Templates /// @@ -1817,11 +1817,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the brand configuration. - /// Defines the brand configuration to be updated. (optional) + /// Defines the brand configuration to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsBrandingUpdateResponseBody - System.Threading.Tasks.Task UpdateBrandAsync(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody = default(ManagementProjectsBrandingUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateBrandAsync(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Brand @@ -1832,11 +1832,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the brand configuration. - /// Defines the brand configuration to be updated. (optional) + /// Defines the brand configuration to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsBrandingUpdateResponseBody) - System.Threading.Tasks.Task> UpdateBrandWithHttpInfoAsync(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody = default(ManagementProjectsBrandingUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateBrandWithHttpInfoAsync(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Custom Event Schema /// @@ -1846,11 +1846,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the custom event schema. - /// Defines the custom event schema to be updated. (optional) + /// Defines the custom event schema to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsCustomEventSchemasUpdateResponseBody - System.Threading.Tasks.Task UpdateCustomEventSchemaAsync(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody = default(ManagementProjectsCustomEventSchemasUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateCustomEventSchemaAsync(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Custom Event Schema @@ -1861,11 +1861,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the custom event schema. - /// Defines the custom event schema to be updated. (optional) + /// Defines the custom event schema to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsCustomEventSchemasUpdateResponseBody) - System.Threading.Tasks.Task> UpdateCustomEventSchemaWithHttpInfoAsync(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody = default(ManagementProjectsCustomEventSchemasUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateCustomEventSchemaWithHttpInfoAsync(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Metadata Schema /// @@ -1875,11 +1875,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the metadata schema. - /// Defines the metadata schema to be updated. (optional) + /// Defines the metadata schema to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsMetadataSchemasUpdateResponseBody - System.Threading.Tasks.Task UpdateMetadataSchemaAsync(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody = default(ManagementProjectsMetadataSchemasUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateMetadataSchemaAsync(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Metadata Schema @@ -1890,11 +1890,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the metadata schema. - /// Defines the metadata schema to be updated. (optional) + /// Defines the metadata schema to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsMetadataSchemasUpdateResponseBody) - System.Threading.Tasks.Task> UpdateMetadataSchemaWithHttpInfoAsync(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody = default(ManagementProjectsMetadataSchemasUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateMetadataSchemaWithHttpInfoAsync(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Project /// @@ -1903,11 +1903,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Define the project details to be updated. (optional) + /// Define the project details to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsUpdateResponseBody - System.Threading.Tasks.Task UpdateProjectAsync(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody = default(ManagementProjectsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateProjectAsync(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Project @@ -1917,11 +1917,11 @@ public interface IManagementApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Define the project details to be updated. (optional) + /// Define the project details to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsUpdateResponseBody) - System.Threading.Tasks.Task> UpdateProjectWithHttpInfoAsync(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody = default(ManagementProjectsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateProjectWithHttpInfoAsync(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Stacking Rules /// @@ -1931,11 +1931,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the stacking rules. - /// Defines the stacking rules to be updated. (optional) + /// Defines the stacking rules to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsStackingRulesUpdateResponseBody - System.Threading.Tasks.Task UpdateStackingRulesAsync(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody = default(ManagementProjectsStackingRulesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateStackingRulesAsync(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Stacking Rules @@ -1946,11 +1946,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the stacking rules. - /// Defines the stacking rules to be updated. (optional) + /// Defines the stacking rules to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsStackingRulesUpdateResponseBody) - System.Threading.Tasks.Task> UpdateStackingRulesWithHttpInfoAsync(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody = default(ManagementProjectsStackingRulesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateStackingRulesWithHttpInfoAsync(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update User /// @@ -1960,11 +1960,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the user. Alternatively, provide the users login. - /// Defines the users new role. (optional) + /// Defines the users new role. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsUsersUpdateRoleResponseBody - System.Threading.Tasks.Task UpdateUserAsync(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody = default(ManagementProjectsUsersUpdateRoleRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateUserAsync(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update User @@ -1975,11 +1975,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the user. Alternatively, provide the users login. - /// Defines the users new role. (optional) + /// Defines the users new role. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsUsersUpdateRoleResponseBody) - System.Threading.Tasks.Task> UpdateUserWithHttpInfoAsync(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody = default(ManagementProjectsUsersUpdateRoleRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateUserWithHttpInfoAsync(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Webhook /// @@ -1989,11 +1989,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the webhook configuration. - /// Defines the webhook configuration to be updated. (optional) + /// Defines the webhook configuration to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsWebhooksUpdateResponseBody - System.Threading.Tasks.Task UpdateWebhookAsync(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody = default(ManagementProjectsWebhooksUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateWebhookAsync(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Webhook @@ -2004,11 +2004,11 @@ public interface IManagementApiAsync : IApiAccessor /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the webhook configuration. - /// Defines the webhook configuration to be updated. (optional) + /// Defines the webhook configuration to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsWebhooksUpdateResponseBody) - System.Threading.Tasks.Task> UpdateWebhookWithHttpInfoAsync(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody = default(ManagementProjectsWebhooksUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateWebhookWithHttpInfoAsync(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -2134,10 +2134,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the user details. (optional) + /// Defines the user details. /// Index associated with the operation. /// ManagementProjectsUsersAssignResponseBody - public ManagementProjectsUsersAssignResponseBody AssignUser(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody = default(ManagementProjectsUsersAssignRequestBody), int operationIndex = 0) + public ManagementProjectsUsersAssignResponseBody AssignUser(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = AssignUserWithHttpInfo(projectId, managementProjectsUsersAssignRequestBody); return localVarResponse.Data; @@ -2148,10 +2148,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the user details. (optional) + /// Defines the user details. /// Index associated with the operation. /// ApiResponse of ManagementProjectsUsersAssignResponseBody - public Voucherify.Client.ApiResponse AssignUserWithHttpInfo(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody = default(ManagementProjectsUsersAssignRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse AssignUserWithHttpInfo(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -2159,6 +2159,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->AssignUser"); } + // verify the required parameter 'managementProjectsUsersAssignRequestBody' is set + if (managementProjectsUsersAssignRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsUsersAssignRequestBody' when calling ManagementApi->AssignUser"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -2219,11 +2225,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the user details. (optional) + /// Defines the user details. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsUsersAssignResponseBody - public async System.Threading.Tasks.Task AssignUserAsync(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody = default(ManagementProjectsUsersAssignRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task AssignUserAsync(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await AssignUserWithHttpInfoAsync(projectId, managementProjectsUsersAssignRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -2234,11 +2240,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the user details. (optional) + /// Defines the user details. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsUsersAssignResponseBody) - public async System.Threading.Tasks.Task> AssignUserWithHttpInfoAsync(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody = default(ManagementProjectsUsersAssignRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> AssignUserWithHttpInfoAsync(string projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -2246,6 +2252,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->AssignUser"); } + // verify the required parameter 'managementProjectsUsersAssignRequestBody' is set + if (managementProjectsUsersAssignRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsUsersAssignRequestBody' when calling ManagementApi->AssignUser"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2307,10 +2319,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a brand configuration. (optional) + /// Defines a brand configuration. /// Index associated with the operation. /// ManagementProjectsBrandingCreateResponseBody - public ManagementProjectsBrandingCreateResponseBody CreateBrand(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody = default(ManagementProjectsBrandingCreateRequestBody), int operationIndex = 0) + public ManagementProjectsBrandingCreateResponseBody CreateBrand(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateBrandWithHttpInfo(projectId, managementProjectsBrandingCreateRequestBody); return localVarResponse.Data; @@ -2321,10 +2333,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a brand configuration. (optional) + /// Defines a brand configuration. /// Index associated with the operation. /// ApiResponse of ManagementProjectsBrandingCreateResponseBody - public Voucherify.Client.ApiResponse CreateBrandWithHttpInfo(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody = default(ManagementProjectsBrandingCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateBrandWithHttpInfo(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -2332,6 +2344,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->CreateBrand"); } + // verify the required parameter 'managementProjectsBrandingCreateRequestBody' is set + if (managementProjectsBrandingCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsBrandingCreateRequestBody' when calling ManagementApi->CreateBrand"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -2392,11 +2410,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a brand configuration. (optional) + /// Defines a brand configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsBrandingCreateResponseBody - public async System.Threading.Tasks.Task CreateBrandAsync(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody = default(ManagementProjectsBrandingCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateBrandAsync(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateBrandWithHttpInfoAsync(projectId, managementProjectsBrandingCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -2407,11 +2425,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a brand configuration. (optional) + /// Defines a brand configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsBrandingCreateResponseBody) - public async System.Threading.Tasks.Task> CreateBrandWithHttpInfoAsync(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody = default(ManagementProjectsBrandingCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateBrandWithHttpInfoAsync(string projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -2419,6 +2437,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->CreateBrand"); } + // verify the required parameter 'managementProjectsBrandingCreateRequestBody' is set + if (managementProjectsBrandingCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsBrandingCreateRequestBody' when calling ManagementApi->CreateBrand"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2480,10 +2504,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the custom event schema. (optional) + /// Defines the custom event schema. /// Index associated with the operation. /// ManagementProjectsCustomEventSchemasCreateResponseBody - public ManagementProjectsCustomEventSchemasCreateResponseBody CreateCustomEventSchema(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody = default(ManagementProjectsCustomEventSchemasCreateRequestBody), int operationIndex = 0) + public ManagementProjectsCustomEventSchemasCreateResponseBody CreateCustomEventSchema(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateCustomEventSchemaWithHttpInfo(projectId, managementProjectsCustomEventSchemasCreateRequestBody); return localVarResponse.Data; @@ -2494,10 +2518,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the custom event schema. (optional) + /// Defines the custom event schema. /// Index associated with the operation. /// ApiResponse of ManagementProjectsCustomEventSchemasCreateResponseBody - public Voucherify.Client.ApiResponse CreateCustomEventSchemaWithHttpInfo(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody = default(ManagementProjectsCustomEventSchemasCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateCustomEventSchemaWithHttpInfo(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -2505,6 +2529,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->CreateCustomEventSchema"); } + // verify the required parameter 'managementProjectsCustomEventSchemasCreateRequestBody' is set + if (managementProjectsCustomEventSchemasCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsCustomEventSchemasCreateRequestBody' when calling ManagementApi->CreateCustomEventSchema"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -2565,11 +2595,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the custom event schema. (optional) + /// Defines the custom event schema. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsCustomEventSchemasCreateResponseBody - public async System.Threading.Tasks.Task CreateCustomEventSchemaAsync(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody = default(ManagementProjectsCustomEventSchemasCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateCustomEventSchemaAsync(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateCustomEventSchemaWithHttpInfoAsync(projectId, managementProjectsCustomEventSchemasCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -2580,11 +2610,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the custom event schema. (optional) + /// Defines the custom event schema. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsCustomEventSchemasCreateResponseBody) - public async System.Threading.Tasks.Task> CreateCustomEventSchemaWithHttpInfoAsync(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody = default(ManagementProjectsCustomEventSchemasCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateCustomEventSchemaWithHttpInfoAsync(string projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -2592,6 +2622,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->CreateCustomEventSchema"); } + // verify the required parameter 'managementProjectsCustomEventSchemasCreateRequestBody' is set + if (managementProjectsCustomEventSchemasCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsCustomEventSchemasCreateRequestBody' when calling ManagementApi->CreateCustomEventSchema"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2653,10 +2689,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the metadata schema. (optional) + /// Defines the metadata schema. /// Index associated with the operation. /// ManagementProjectsMetadataSchemasCreateResponseBody - public ManagementProjectsMetadataSchemasCreateResponseBody CreateMetadataSchema(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody = default(ManagementProjectsMetadataSchemasCreateRequestBody), int operationIndex = 0) + public ManagementProjectsMetadataSchemasCreateResponseBody CreateMetadataSchema(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateMetadataSchemaWithHttpInfo(projectId, managementProjectsMetadataSchemasCreateRequestBody); return localVarResponse.Data; @@ -2667,10 +2703,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the metadata schema. (optional) + /// Defines the metadata schema. /// Index associated with the operation. /// ApiResponse of ManagementProjectsMetadataSchemasCreateResponseBody - public Voucherify.Client.ApiResponse CreateMetadataSchemaWithHttpInfo(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody = default(ManagementProjectsMetadataSchemasCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateMetadataSchemaWithHttpInfo(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -2678,6 +2714,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->CreateMetadataSchema"); } + // verify the required parameter 'managementProjectsMetadataSchemasCreateRequestBody' is set + if (managementProjectsMetadataSchemasCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsMetadataSchemasCreateRequestBody' when calling ManagementApi->CreateMetadataSchema"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -2738,11 +2780,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the metadata schema. (optional) + /// Defines the metadata schema. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsMetadataSchemasCreateResponseBody - public async System.Threading.Tasks.Task CreateMetadataSchemaAsync(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody = default(ManagementProjectsMetadataSchemasCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateMetadataSchemaAsync(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateMetadataSchemaWithHttpInfoAsync(projectId, managementProjectsMetadataSchemasCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -2753,11 +2795,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the metadata schema. (optional) + /// Defines the metadata schema. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsMetadataSchemasCreateResponseBody) - public async System.Threading.Tasks.Task> CreateMetadataSchemaWithHttpInfoAsync(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody = default(ManagementProjectsMetadataSchemasCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateMetadataSchemaWithHttpInfoAsync(string projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -2765,6 +2807,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->CreateMetadataSchema"); } + // verify the required parameter 'managementProjectsMetadataSchemasCreateRequestBody' is set + if (managementProjectsMetadataSchemasCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsMetadataSchemasCreateRequestBody' when calling ManagementApi->CreateMetadataSchema"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2825,10 +2873,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. /// /// Thrown when fails to make API call - /// Define project details. (optional) + /// Define project details. /// Index associated with the operation. /// ManagementProjectsCreateResponseBody - public ManagementProjectsCreateResponseBody CreateProject(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody = default(ManagementProjectsCreateRequestBody), int operationIndex = 0) + public ManagementProjectsCreateResponseBody CreateProject(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateProjectWithHttpInfo(managementProjectsCreateRequestBody); return localVarResponse.Data; @@ -2838,11 +2886,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. /// /// Thrown when fails to make API call - /// Define project details. (optional) + /// Define project details. /// Index associated with the operation. /// ApiResponse of ManagementProjectsCreateResponseBody - public Voucherify.Client.ApiResponse CreateProjectWithHttpInfo(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody = default(ManagementProjectsCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateProjectWithHttpInfo(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'managementProjectsCreateRequestBody' is set + if (managementProjectsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsCreateRequestBody' when calling ManagementApi->CreateProject"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -2901,11 +2955,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. /// /// Thrown when fails to make API call - /// Define project details. (optional) + /// Define project details. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsCreateResponseBody - public async System.Threading.Tasks.Task CreateProjectAsync(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody = default(ManagementProjectsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateProjectAsync(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateProjectWithHttpInfoAsync(managementProjectsCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -2915,12 +2969,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default. /// /// Thrown when fails to make API call - /// Define project details. (optional) + /// Define project details. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsCreateResponseBody) - public async System.Threading.Tasks.Task> CreateProjectWithHttpInfoAsync(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody = default(ManagementProjectsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateProjectWithHttpInfoAsync(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'managementProjectsCreateRequestBody' is set + if (managementProjectsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsCreateRequestBody' when calling ManagementApi->CreateProject"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2981,10 +3041,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the stacking rule parameters. (optional) + /// Defines the stacking rule parameters. /// Index associated with the operation. /// ManagementProjectsStackingRulesCreateResponseBody - public ManagementProjectsStackingRulesCreateResponseBody CreateStackingRules(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody = default(ManagementProjectsStackingRulesCreateRequestBody), int operationIndex = 0) + public ManagementProjectsStackingRulesCreateResponseBody CreateStackingRules(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateStackingRulesWithHttpInfo(projectId, managementProjectsStackingRulesCreateRequestBody); return localVarResponse.Data; @@ -2995,10 +3055,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the stacking rule parameters. (optional) + /// Defines the stacking rule parameters. /// Index associated with the operation. /// ApiResponse of ManagementProjectsStackingRulesCreateResponseBody - public Voucherify.Client.ApiResponse CreateStackingRulesWithHttpInfo(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody = default(ManagementProjectsStackingRulesCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateStackingRulesWithHttpInfo(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -3006,6 +3066,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->CreateStackingRules"); } + // verify the required parameter 'managementProjectsStackingRulesCreateRequestBody' is set + if (managementProjectsStackingRulesCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsStackingRulesCreateRequestBody' when calling ManagementApi->CreateStackingRules"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3066,11 +3132,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the stacking rule parameters. (optional) + /// Defines the stacking rule parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsStackingRulesCreateResponseBody - public async System.Threading.Tasks.Task CreateStackingRulesAsync(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody = default(ManagementProjectsStackingRulesCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateStackingRulesAsync(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateStackingRulesWithHttpInfoAsync(projectId, managementProjectsStackingRulesCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -3081,11 +3147,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines the stacking rule parameters. (optional) + /// Defines the stacking rule parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsStackingRulesCreateResponseBody) - public async System.Threading.Tasks.Task> CreateStackingRulesWithHttpInfoAsync(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody = default(ManagementProjectsStackingRulesCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateStackingRulesWithHttpInfoAsync(string projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -3093,6 +3159,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->CreateStackingRules"); } + // verify the required parameter 'managementProjectsStackingRulesCreateRequestBody' is set + if (managementProjectsStackingRulesCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsStackingRulesCreateRequestBody' when calling ManagementApi->CreateStackingRules"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -3154,10 +3226,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a webhook configuration. (optional) + /// Defines a webhook configuration. /// Index associated with the operation. /// ManagementProjectsWebhooksCreateResponseBody - public ManagementProjectsWebhooksCreateResponseBody CreateWebhook(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody = default(ManagementProjectsWebhooksCreateRequestBody), int operationIndex = 0) + public ManagementProjectsWebhooksCreateResponseBody CreateWebhook(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateWebhookWithHttpInfo(projectId, managementProjectsWebhooksCreateRequestBody); return localVarResponse.Data; @@ -3168,10 +3240,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a webhook configuration. (optional) + /// Defines a webhook configuration. /// Index associated with the operation. /// ApiResponse of ManagementProjectsWebhooksCreateResponseBody - public Voucherify.Client.ApiResponse CreateWebhookWithHttpInfo(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody = default(ManagementProjectsWebhooksCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateWebhookWithHttpInfo(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -3179,6 +3251,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->CreateWebhook"); } + // verify the required parameter 'managementProjectsWebhooksCreateRequestBody' is set + if (managementProjectsWebhooksCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsWebhooksCreateRequestBody' when calling ManagementApi->CreateWebhook"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3239,11 +3317,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a webhook configuration. (optional) + /// Defines a webhook configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsWebhooksCreateResponseBody - public async System.Threading.Tasks.Task CreateWebhookAsync(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody = default(ManagementProjectsWebhooksCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateWebhookAsync(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateWebhookWithHttpInfoAsync(projectId, managementProjectsWebhooksCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -3254,11 +3332,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Defines a webhook configuration. (optional) + /// Defines a webhook configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsWebhooksCreateResponseBody) - public async System.Threading.Tasks.Task> CreateWebhookWithHttpInfoAsync(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody = default(ManagementProjectsWebhooksCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateWebhookWithHttpInfoAsync(string projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -3266,6 +3344,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->CreateWebhook"); } + // verify the required parameter 'managementProjectsWebhooksCreateRequestBody' is set + if (managementProjectsWebhooksCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsWebhooksCreateRequestBody' when calling ManagementApi->CreateWebhook"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -5645,10 +5729,10 @@ public Voucherify.Client.ApiResponse /// Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. /// /// Thrown when fails to make API call - /// Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + /// Defines the details of the invitation, the project, and roles to which the user will be assigned. /// Index associated with the operation. /// - public void InviteUser(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody = default(ManagementProjectsUsersInviteCreateRequestBody), int operationIndex = 0) + public void InviteUser(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody, int operationIndex = 0) { InviteUserWithHttpInfo(managementProjectsUsersInviteCreateRequestBody); } @@ -5657,11 +5741,17 @@ public Voucherify.Client.ApiResponse /// Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. /// /// Thrown when fails to make API call - /// Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + /// Defines the details of the invitation, the project, and roles to which the user will be assigned. /// Index associated with the operation. /// ApiResponse of Object(void) - public Voucherify.Client.ApiResponse InviteUserWithHttpInfo(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody = default(ManagementProjectsUsersInviteCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse InviteUserWithHttpInfo(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'managementProjectsUsersInviteCreateRequestBody' is set + if (managementProjectsUsersInviteCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsUsersInviteCreateRequestBody' when calling ManagementApi->InviteUser"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -5719,11 +5809,11 @@ public Voucherify.Client.ApiResponse /// Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. /// /// Thrown when fails to make API call - /// Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + /// Defines the details of the invitation, the project, and roles to which the user will be assigned. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of void - public async System.Threading.Tasks.Task InviteUserAsync(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody = default(ManagementProjectsUsersInviteCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task InviteUserAsync(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { await InviteUserWithHttpInfoAsync(managementProjectsUsersInviteCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); } @@ -5732,12 +5822,18 @@ public Voucherify.Client.ApiResponse /// Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles. /// /// Thrown when fails to make API call - /// Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional) + /// Defines the details of the invitation, the project, and roles to which the user will be assigned. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse - public async System.Threading.Tasks.Task> InviteUserWithHttpInfoAsync(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody = default(ManagementProjectsUsersInviteCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> InviteUserWithHttpInfoAsync(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'managementProjectsUsersInviteCreateRequestBody' is set + if (managementProjectsUsersInviteCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsUsersInviteCreateRequestBody' when calling ManagementApi->InviteUser"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -6935,10 +7031,10 @@ public Voucherify.Client.ApiResponse /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the campaign template. - /// Determines the details about the template in the destination project as well as the destination project itself. (optional) + /// Determines the details about the template in the destination project as well as the destination project itself. /// Index associated with the operation. /// ManagementProjectsTemplatesCampaignsCopyCreateResponseBody - public ManagementProjectsTemplatesCampaignsCopyCreateResponseBody ManagementCopyCampaignTemplate(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody = default(ManagementProjectsTemplatesCampaignsCopyCreateRequestBody), int operationIndex = 0) + public ManagementProjectsTemplatesCampaignsCopyCreateResponseBody ManagementCopyCampaignTemplate(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = ManagementCopyCampaignTemplateWithHttpInfo(projectId, campaignTemplateId, managementProjectsTemplatesCampaignsCopyCreateRequestBody); return localVarResponse.Data; @@ -6950,10 +7046,10 @@ public Voucherify.Client.ApiResponse /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the campaign template. - /// Determines the details about the template in the destination project as well as the destination project itself. (optional) + /// Determines the details about the template in the destination project as well as the destination project itself. /// Index associated with the operation. /// ApiResponse of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody - public Voucherify.Client.ApiResponse ManagementCopyCampaignTemplateWithHttpInfo(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody = default(ManagementProjectsTemplatesCampaignsCopyCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse ManagementCopyCampaignTemplateWithHttpInfo(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -6967,6 +7063,12 @@ public Voucherify.Client.ApiResponse throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignTemplateId' when calling ManagementApi->ManagementCopyCampaignTemplate"); } + // verify the required parameter 'managementProjectsTemplatesCampaignsCopyCreateRequestBody' is set + if (managementProjectsTemplatesCampaignsCopyCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsTemplatesCampaignsCopyCreateRequestBody' when calling ManagementApi->ManagementCopyCampaignTemplate"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -7029,11 +7131,11 @@ public Voucherify.Client.ApiResponse /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the campaign template. - /// Determines the details about the template in the destination project as well as the destination project itself. (optional) + /// Determines the details about the template in the destination project as well as the destination project itself. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsTemplatesCampaignsCopyCreateResponseBody - public async System.Threading.Tasks.Task ManagementCopyCampaignTemplateAsync(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody = default(ManagementProjectsTemplatesCampaignsCopyCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ManagementCopyCampaignTemplateAsync(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await ManagementCopyCampaignTemplateWithHttpInfoAsync(projectId, campaignTemplateId, managementProjectsTemplatesCampaignsCopyCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -7045,11 +7147,11 @@ public Voucherify.Client.ApiResponse /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the campaign template. - /// Determines the details about the template in the destination project as well as the destination project itself. (optional) + /// Determines the details about the template in the destination project as well as the destination project itself. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsTemplatesCampaignsCopyCreateResponseBody) - public async System.Threading.Tasks.Task> ManagementCopyCampaignTemplateWithHttpInfoAsync(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody = default(ManagementProjectsTemplatesCampaignsCopyCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ManagementCopyCampaignTemplateWithHttpInfoAsync(string projectId, string campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -7063,6 +7165,12 @@ public Voucherify.Client.ApiResponse throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignTemplateId' when calling ManagementApi->ManagementCopyCampaignTemplate"); } + // verify the required parameter 'managementProjectsTemplatesCampaignsCopyCreateRequestBody' is set + if (managementProjectsTemplatesCampaignsCopyCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsTemplatesCampaignsCopyCreateRequestBody' when calling ManagementApi->ManagementCopyCampaignTemplate"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -7560,10 +7668,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the brand configuration. - /// Defines the brand configuration to be updated. (optional) + /// Defines the brand configuration to be updated. /// Index associated with the operation. /// ManagementProjectsBrandingUpdateResponseBody - public ManagementProjectsBrandingUpdateResponseBody UpdateBrand(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody = default(ManagementProjectsBrandingUpdateRequestBody), int operationIndex = 0) + public ManagementProjectsBrandingUpdateResponseBody UpdateBrand(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateBrandWithHttpInfo(projectId, brandingId, managementProjectsBrandingUpdateRequestBody); return localVarResponse.Data; @@ -7575,10 +7683,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the brand configuration. - /// Defines the brand configuration to be updated. (optional) + /// Defines the brand configuration to be updated. /// Index associated with the operation. /// ApiResponse of ManagementProjectsBrandingUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateBrandWithHttpInfo(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody = default(ManagementProjectsBrandingUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateBrandWithHttpInfo(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -7592,6 +7700,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'brandingId' when calling ManagementApi->UpdateBrand"); } + // verify the required parameter 'managementProjectsBrandingUpdateRequestBody' is set + if (managementProjectsBrandingUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsBrandingUpdateRequestBody' when calling ManagementApi->UpdateBrand"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -7654,11 +7768,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the brand configuration. - /// Defines the brand configuration to be updated. (optional) + /// Defines the brand configuration to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsBrandingUpdateResponseBody - public async System.Threading.Tasks.Task UpdateBrandAsync(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody = default(ManagementProjectsBrandingUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateBrandAsync(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateBrandWithHttpInfoAsync(projectId, brandingId, managementProjectsBrandingUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -7670,11 +7784,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the brand configuration. - /// Defines the brand configuration to be updated. (optional) + /// Defines the brand configuration to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsBrandingUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateBrandWithHttpInfoAsync(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody = default(ManagementProjectsBrandingUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateBrandWithHttpInfoAsync(string projectId, string brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -7688,6 +7802,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'brandingId' when calling ManagementApi->UpdateBrand"); } + // verify the required parameter 'managementProjectsBrandingUpdateRequestBody' is set + if (managementProjectsBrandingUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsBrandingUpdateRequestBody' when calling ManagementApi->UpdateBrand"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -7751,10 +7871,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the custom event schema. - /// Defines the custom event schema to be updated. (optional) + /// Defines the custom event schema to be updated. /// Index associated with the operation. /// ManagementProjectsCustomEventSchemasUpdateResponseBody - public ManagementProjectsCustomEventSchemasUpdateResponseBody UpdateCustomEventSchema(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody = default(ManagementProjectsCustomEventSchemasUpdateRequestBody), int operationIndex = 0) + public ManagementProjectsCustomEventSchemasUpdateResponseBody UpdateCustomEventSchema(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateCustomEventSchemaWithHttpInfo(projectId, customEventSchemaId, managementProjectsCustomEventSchemasUpdateRequestBody); return localVarResponse.Data; @@ -7766,10 +7886,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the custom event schema. - /// Defines the custom event schema to be updated. (optional) + /// Defines the custom event schema to be updated. /// Index associated with the operation. /// ApiResponse of ManagementProjectsCustomEventSchemasUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateCustomEventSchemaWithHttpInfo(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody = default(ManagementProjectsCustomEventSchemasUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateCustomEventSchemaWithHttpInfo(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -7783,6 +7903,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'customEventSchemaId' when calling ManagementApi->UpdateCustomEventSchema"); } + // verify the required parameter 'managementProjectsCustomEventSchemasUpdateRequestBody' is set + if (managementProjectsCustomEventSchemasUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsCustomEventSchemasUpdateRequestBody' when calling ManagementApi->UpdateCustomEventSchema"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -7845,11 +7971,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the custom event schema. - /// Defines the custom event schema to be updated. (optional) + /// Defines the custom event schema to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsCustomEventSchemasUpdateResponseBody - public async System.Threading.Tasks.Task UpdateCustomEventSchemaAsync(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody = default(ManagementProjectsCustomEventSchemasUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateCustomEventSchemaAsync(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateCustomEventSchemaWithHttpInfoAsync(projectId, customEventSchemaId, managementProjectsCustomEventSchemasUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -7861,11 +7987,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the custom event schema. - /// Defines the custom event schema to be updated. (optional) + /// Defines the custom event schema to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsCustomEventSchemasUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateCustomEventSchemaWithHttpInfoAsync(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody = default(ManagementProjectsCustomEventSchemasUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateCustomEventSchemaWithHttpInfoAsync(string projectId, string customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -7879,6 +8005,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'customEventSchemaId' when calling ManagementApi->UpdateCustomEventSchema"); } + // verify the required parameter 'managementProjectsCustomEventSchemasUpdateRequestBody' is set + if (managementProjectsCustomEventSchemasUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsCustomEventSchemasUpdateRequestBody' when calling ManagementApi->UpdateCustomEventSchema"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -7942,10 +8074,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the metadata schema. - /// Defines the metadata schema to be updated. (optional) + /// Defines the metadata schema to be updated. /// Index associated with the operation. /// ManagementProjectsMetadataSchemasUpdateResponseBody - public ManagementProjectsMetadataSchemasUpdateResponseBody UpdateMetadataSchema(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody = default(ManagementProjectsMetadataSchemasUpdateRequestBody), int operationIndex = 0) + public ManagementProjectsMetadataSchemasUpdateResponseBody UpdateMetadataSchema(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateMetadataSchemaWithHttpInfo(projectId, metadataSchemaId, managementProjectsMetadataSchemasUpdateRequestBody); return localVarResponse.Data; @@ -7957,10 +8089,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the metadata schema. - /// Defines the metadata schema to be updated. (optional) + /// Defines the metadata schema to be updated. /// Index associated with the operation. /// ApiResponse of ManagementProjectsMetadataSchemasUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateMetadataSchemaWithHttpInfo(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody = default(ManagementProjectsMetadataSchemasUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateMetadataSchemaWithHttpInfo(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -7974,6 +8106,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'metadataSchemaId' when calling ManagementApi->UpdateMetadataSchema"); } + // verify the required parameter 'managementProjectsMetadataSchemasUpdateRequestBody' is set + if (managementProjectsMetadataSchemasUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsMetadataSchemasUpdateRequestBody' when calling ManagementApi->UpdateMetadataSchema"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -8036,11 +8174,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the metadata schema. - /// Defines the metadata schema to be updated. (optional) + /// Defines the metadata schema to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsMetadataSchemasUpdateResponseBody - public async System.Threading.Tasks.Task UpdateMetadataSchemaAsync(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody = default(ManagementProjectsMetadataSchemasUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateMetadataSchemaAsync(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateMetadataSchemaWithHttpInfoAsync(projectId, metadataSchemaId, managementProjectsMetadataSchemasUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -8052,11 +8190,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the metadata schema. - /// Defines the metadata schema to be updated. (optional) + /// Defines the metadata schema to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsMetadataSchemasUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateMetadataSchemaWithHttpInfoAsync(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody = default(ManagementProjectsMetadataSchemasUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateMetadataSchemaWithHttpInfoAsync(string projectId, string metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -8070,6 +8208,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'metadataSchemaId' when calling ManagementApi->UpdateMetadataSchema"); } + // verify the required parameter 'managementProjectsMetadataSchemasUpdateRequestBody' is set + if (managementProjectsMetadataSchemasUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsMetadataSchemasUpdateRequestBody' when calling ManagementApi->UpdateMetadataSchema"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -8132,10 +8276,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Define the project details to be updated. (optional) + /// Define the project details to be updated. /// Index associated with the operation. /// ManagementProjectsUpdateResponseBody - public ManagementProjectsUpdateResponseBody UpdateProject(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody = default(ManagementProjectsUpdateRequestBody), int operationIndex = 0) + public ManagementProjectsUpdateResponseBody UpdateProject(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateProjectWithHttpInfo(projectId, managementProjectsUpdateRequestBody); return localVarResponse.Data; @@ -8146,10 +8290,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Define the project details to be updated. (optional) + /// Define the project details to be updated. /// Index associated with the operation. /// ApiResponse of ManagementProjectsUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateProjectWithHttpInfo(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody = default(ManagementProjectsUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateProjectWithHttpInfo(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -8157,6 +8301,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->UpdateProject"); } + // verify the required parameter 'managementProjectsUpdateRequestBody' is set + if (managementProjectsUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsUpdateRequestBody' when calling ManagementApi->UpdateProject"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -8217,11 +8367,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Define the project details to be updated. (optional) + /// Define the project details to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsUpdateResponseBody - public async System.Threading.Tasks.Task UpdateProjectAsync(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody = default(ManagementProjectsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateProjectAsync(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateProjectWithHttpInfoAsync(projectId, managementProjectsUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -8232,11 +8382,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// /// Thrown when fails to make API call /// Provide the unique identifier of the project. - /// Define the project details to be updated. (optional) + /// Define the project details to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateProjectWithHttpInfoAsync(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody = default(ManagementProjectsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateProjectWithHttpInfoAsync(string projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -8244,6 +8394,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'projectId' when calling ManagementApi->UpdateProject"); } + // verify the required parameter 'managementProjectsUpdateRequestBody' is set + if (managementProjectsUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsUpdateRequestBody' when calling ManagementApi->UpdateProject"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -8306,10 +8462,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the stacking rules. - /// Defines the stacking rules to be updated. (optional) + /// Defines the stacking rules to be updated. /// Index associated with the operation. /// ManagementProjectsStackingRulesUpdateResponseBody - public ManagementProjectsStackingRulesUpdateResponseBody UpdateStackingRules(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody = default(ManagementProjectsStackingRulesUpdateRequestBody), int operationIndex = 0) + public ManagementProjectsStackingRulesUpdateResponseBody UpdateStackingRules(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateStackingRulesWithHttpInfo(projectId, stackingRulesId, managementProjectsStackingRulesUpdateRequestBody); return localVarResponse.Data; @@ -8321,10 +8477,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the stacking rules. - /// Defines the stacking rules to be updated. (optional) + /// Defines the stacking rules to be updated. /// Index associated with the operation. /// ApiResponse of ManagementProjectsStackingRulesUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateStackingRulesWithHttpInfo(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody = default(ManagementProjectsStackingRulesUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateStackingRulesWithHttpInfo(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -8338,6 +8494,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'stackingRulesId' when calling ManagementApi->UpdateStackingRules"); } + // verify the required parameter 'managementProjectsStackingRulesUpdateRequestBody' is set + if (managementProjectsStackingRulesUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsStackingRulesUpdateRequestBody' when calling ManagementApi->UpdateStackingRules"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -8400,11 +8562,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the stacking rules. - /// Defines the stacking rules to be updated. (optional) + /// Defines the stacking rules to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsStackingRulesUpdateResponseBody - public async System.Threading.Tasks.Task UpdateStackingRulesAsync(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody = default(ManagementProjectsStackingRulesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateStackingRulesAsync(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateStackingRulesWithHttpInfoAsync(projectId, stackingRulesId, managementProjectsStackingRulesUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -8416,11 +8578,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the stacking rules. - /// Defines the stacking rules to be updated. (optional) + /// Defines the stacking rules to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsStackingRulesUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateStackingRulesWithHttpInfoAsync(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody = default(ManagementProjectsStackingRulesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateStackingRulesWithHttpInfoAsync(string projectId, string stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -8434,6 +8596,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'stackingRulesId' when calling ManagementApi->UpdateStackingRules"); } + // verify the required parameter 'managementProjectsStackingRulesUpdateRequestBody' is set + if (managementProjectsStackingRulesUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsStackingRulesUpdateRequestBody' when calling ManagementApi->UpdateStackingRules"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -8497,10 +8665,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the user. Alternatively, provide the users login. - /// Defines the users new role. (optional) + /// Defines the users new role. /// Index associated with the operation. /// ManagementProjectsUsersUpdateRoleResponseBody - public ManagementProjectsUsersUpdateRoleResponseBody UpdateUser(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody = default(ManagementProjectsUsersUpdateRoleRequestBody), int operationIndex = 0) + public ManagementProjectsUsersUpdateRoleResponseBody UpdateUser(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateUserWithHttpInfo(projectId, userId, managementProjectsUsersUpdateRoleRequestBody); return localVarResponse.Data; @@ -8512,10 +8680,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the user. Alternatively, provide the users login. - /// Defines the users new role. (optional) + /// Defines the users new role. /// Index associated with the operation. /// ApiResponse of ManagementProjectsUsersUpdateRoleResponseBody - public Voucherify.Client.ApiResponse UpdateUserWithHttpInfo(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody = default(ManagementProjectsUsersUpdateRoleRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateUserWithHttpInfo(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -8529,6 +8697,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'userId' when calling ManagementApi->UpdateUser"); } + // verify the required parameter 'managementProjectsUsersUpdateRoleRequestBody' is set + if (managementProjectsUsersUpdateRoleRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsUsersUpdateRoleRequestBody' when calling ManagementApi->UpdateUser"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -8591,11 +8765,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the user. Alternatively, provide the users login. - /// Defines the users new role. (optional) + /// Defines the users new role. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsUsersUpdateRoleResponseBody - public async System.Threading.Tasks.Task UpdateUserAsync(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody = default(ManagementProjectsUsersUpdateRoleRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateUserAsync(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateUserWithHttpInfoAsync(projectId, userId, managementProjectsUsersUpdateRoleRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -8607,11 +8781,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the user. Alternatively, provide the users login. - /// Defines the users new role. (optional) + /// Defines the users new role. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsUsersUpdateRoleResponseBody) - public async System.Threading.Tasks.Task> UpdateUserWithHttpInfoAsync(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody = default(ManagementProjectsUsersUpdateRoleRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateUserWithHttpInfoAsync(string projectId, string userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -8625,6 +8799,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'userId' when calling ManagementApi->UpdateUser"); } + // verify the required parameter 'managementProjectsUsersUpdateRoleRequestBody' is set + if (managementProjectsUsersUpdateRoleRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsUsersUpdateRoleRequestBody' when calling ManagementApi->UpdateUser"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -8688,10 +8868,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the webhook configuration. - /// Defines the webhook configuration to be updated. (optional) + /// Defines the webhook configuration to be updated. /// Index associated with the operation. /// ManagementProjectsWebhooksUpdateResponseBody - public ManagementProjectsWebhooksUpdateResponseBody UpdateWebhook(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody = default(ManagementProjectsWebhooksUpdateRequestBody), int operationIndex = 0) + public ManagementProjectsWebhooksUpdateResponseBody UpdateWebhook(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateWebhookWithHttpInfo(projectId, webhookId, managementProjectsWebhooksUpdateRequestBody); return localVarResponse.Data; @@ -8703,10 +8883,10 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the webhook configuration. - /// Defines the webhook configuration to be updated. (optional) + /// Defines the webhook configuration to be updated. /// Index associated with the operation. /// ApiResponse of ManagementProjectsWebhooksUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateWebhookWithHttpInfo(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody = default(ManagementProjectsWebhooksUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateWebhookWithHttpInfo(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -8720,6 +8900,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'webhookId' when calling ManagementApi->UpdateWebhook"); } + // verify the required parameter 'managementProjectsWebhooksUpdateRequestBody' is set + if (managementProjectsWebhooksUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsWebhooksUpdateRequestBody' when calling ManagementApi->UpdateWebhook"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -8782,11 +8968,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the webhook configuration. - /// Defines the webhook configuration to be updated. (optional) + /// Defines the webhook configuration to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ManagementProjectsWebhooksUpdateResponseBody - public async System.Threading.Tasks.Task UpdateWebhookAsync(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody = default(ManagementProjectsWebhooksUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateWebhookAsync(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateWebhookWithHttpInfoAsync(projectId, webhookId, managementProjectsWebhooksUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -8798,11 +8984,11 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro /// Thrown when fails to make API call /// Provide the unique identifier of the project. /// Provide the unique identifier of the webhook configuration. - /// Defines the webhook configuration to be updated. (optional) + /// Defines the webhook configuration to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ManagementProjectsWebhooksUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateWebhookWithHttpInfoAsync(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody = default(ManagementProjectsWebhooksUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateWebhookWithHttpInfoAsync(string projectId, string webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'projectId' is set if (projectId == null) @@ -8816,6 +9002,12 @@ public Voucherify.Client.ApiResponse UnassignUserWithHttpInfo(string pro throw new Voucherify.Client.ApiException(400, "Missing required parameter 'webhookId' when calling ManagementApi->UpdateWebhook"); } + // verify the required parameter 'managementProjectsWebhooksUpdateRequestBody' is set + if (managementProjectsWebhooksUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'managementProjectsWebhooksUpdateRequestBody' when calling ManagementApi->UpdateWebhook"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/OrdersApi.cs b/src/Voucherify/Api/OrdersApi.cs index ae67d7b4..e95b50bb 100644 --- a/src/Voucherify/Api/OrdersApi.cs +++ b/src/Voucherify/Api/OrdersApi.cs @@ -35,10 +35,10 @@ public interface IOrdersApiSync : IApiAccessor /// Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. /// /// Thrown when fails to make API call - /// Specify the order parameters. (optional) + /// Specify the order parameters. /// Index associated with the operation. /// OrdersCreateResponseBody - OrdersCreateResponseBody CreateOrder(OrdersCreateRequestBody ordersCreateRequestBody = default(OrdersCreateRequestBody), int operationIndex = 0); + OrdersCreateResponseBody CreateOrder(OrdersCreateRequestBody ordersCreateRequestBody, int operationIndex = 0); /// /// Create Order @@ -47,10 +47,10 @@ public interface IOrdersApiSync : IApiAccessor /// Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. /// /// Thrown when fails to make API call - /// Specify the order parameters. (optional) + /// Specify the order parameters. /// Index associated with the operation. /// ApiResponse of OrdersCreateResponseBody - ApiResponse CreateOrderWithHttpInfo(OrdersCreateRequestBody ordersCreateRequestBody = default(OrdersCreateRequestBody), int operationIndex = 0); + ApiResponse CreateOrderWithHttpInfo(OrdersCreateRequestBody ordersCreateRequestBody, int operationIndex = 0); /// /// Create Orders Export /// @@ -58,10 +58,10 @@ public interface IOrdersApiSync : IApiAccessor /// Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: /// /// Thrown when fails to make API call - /// Specify which order parameters you would like to export. (optional) + /// Specify which order parameters you would like to export. /// Index associated with the operation. /// OrdersExportCreateResponseBody - OrdersExportCreateResponseBody CreateOrderExport(OrdersExportCreateRequestBody ordersExportCreateRequestBody = default(OrdersExportCreateRequestBody), int operationIndex = 0); + OrdersExportCreateResponseBody CreateOrderExport(OrdersExportCreateRequestBody ordersExportCreateRequestBody, int operationIndex = 0); /// /// Create Orders Export @@ -70,10 +70,10 @@ public interface IOrdersApiSync : IApiAccessor /// Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: /// /// Thrown when fails to make API call - /// Specify which order parameters you would like to export. (optional) + /// Specify which order parameters you would like to export. /// Index associated with the operation. /// ApiResponse of OrdersExportCreateResponseBody - ApiResponse CreateOrderExportWithHttpInfo(OrdersExportCreateRequestBody ordersExportCreateRequestBody = default(OrdersExportCreateRequestBody), int operationIndex = 0); + ApiResponse CreateOrderExportWithHttpInfo(OrdersExportCreateRequestBody ordersExportCreateRequestBody, int operationIndex = 0); /// /// Get Order /// @@ -101,25 +101,25 @@ public interface IOrdersApiSync : IApiAccessor /// Import Orders /// /// - /// 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + /// 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. /// /// Thrown when fails to make API call - /// The request body is sent in the form of an array of order objects. (optional) + /// The request body is sent in the form of an array of order objects. /// Index associated with the operation. /// OrdersImportCreateResponseBody - OrdersImportCreateResponseBody ImportOrders(List ordersImportCreateRequestBodyItem = default(List), int operationIndex = 0); + OrdersImportCreateResponseBody ImportOrders(List ordersImportCreateRequestBodyItem, int operationIndex = 0); /// /// Import Orders /// /// - /// 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + /// 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. /// /// Thrown when fails to make API call - /// The request body is sent in the form of an array of order objects. (optional) + /// The request body is sent in the form of an array of order objects. /// Index associated with the operation. /// ApiResponse of OrdersImportCreateResponseBody - ApiResponse ImportOrdersWithHttpInfo(List ordersImportCreateRequestBodyItem = default(List), int operationIndex = 0); + ApiResponse ImportOrdersWithHttpInfo(List ordersImportCreateRequestBodyItem, int operationIndex = 0); /// /// List Orders /// @@ -155,10 +155,10 @@ public interface IOrdersApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique Voucherify order ID or order source ID. - /// Specify the parameters of the order that are to be updated. (optional) + /// Specify the parameters of the order that are to be updated. /// Index associated with the operation. /// OrdersUpdateResponseBody - OrdersUpdateResponseBody UpdateOrder(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody = default(OrdersUpdateRequestBody), int operationIndex = 0); + OrdersUpdateResponseBody UpdateOrder(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody, int operationIndex = 0); /// /// Update Order @@ -168,10 +168,10 @@ public interface IOrdersApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique Voucherify order ID or order source ID. - /// Specify the parameters of the order that are to be updated. (optional) + /// Specify the parameters of the order that are to be updated. /// Index associated with the operation. /// ApiResponse of OrdersUpdateResponseBody - ApiResponse UpdateOrderWithHttpInfo(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody = default(OrdersUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateOrderWithHttpInfo(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -188,11 +188,11 @@ public interface IOrdersApiAsync : IApiAccessor /// Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. /// /// Thrown when fails to make API call - /// Specify the order parameters. (optional) + /// Specify the order parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of OrdersCreateResponseBody - System.Threading.Tasks.Task CreateOrderAsync(OrdersCreateRequestBody ordersCreateRequestBody = default(OrdersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateOrderAsync(OrdersCreateRequestBody ordersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Order @@ -201,11 +201,11 @@ public interface IOrdersApiAsync : IApiAccessor /// Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. /// /// Thrown when fails to make API call - /// Specify the order parameters. (optional) + /// Specify the order parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (OrdersCreateResponseBody) - System.Threading.Tasks.Task> CreateOrderWithHttpInfoAsync(OrdersCreateRequestBody ordersCreateRequestBody = default(OrdersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateOrderWithHttpInfoAsync(OrdersCreateRequestBody ordersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Orders Export /// @@ -213,11 +213,11 @@ public interface IOrdersApiAsync : IApiAccessor /// Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: /// /// Thrown when fails to make API call - /// Specify which order parameters you would like to export. (optional) + /// Specify which order parameters you would like to export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of OrdersExportCreateResponseBody - System.Threading.Tasks.Task CreateOrderExportAsync(OrdersExportCreateRequestBody ordersExportCreateRequestBody = default(OrdersExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateOrderExportAsync(OrdersExportCreateRequestBody ordersExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Orders Export @@ -226,11 +226,11 @@ public interface IOrdersApiAsync : IApiAccessor /// Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: /// /// Thrown when fails to make API call - /// Specify which order parameters you would like to export. (optional) + /// Specify which order parameters you would like to export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (OrdersExportCreateResponseBody) - System.Threading.Tasks.Task> CreateOrderExportWithHttpInfoAsync(OrdersExportCreateRequestBody ordersExportCreateRequestBody = default(OrdersExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateOrderExportWithHttpInfoAsync(OrdersExportCreateRequestBody ordersExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Get Order /// @@ -260,27 +260,27 @@ public interface IOrdersApiAsync : IApiAccessor /// Import Orders /// /// - /// 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + /// 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. /// /// Thrown when fails to make API call - /// The request body is sent in the form of an array of order objects. (optional) + /// The request body is sent in the form of an array of order objects. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of OrdersImportCreateResponseBody - System.Threading.Tasks.Task ImportOrdersAsync(List ordersImportCreateRequestBodyItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task ImportOrdersAsync(List ordersImportCreateRequestBodyItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Import Orders /// /// - /// 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + /// 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. /// /// Thrown when fails to make API call - /// The request body is sent in the form of an array of order objects. (optional) + /// The request body is sent in the form of an array of order objects. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (OrdersImportCreateResponseBody) - System.Threading.Tasks.Task> ImportOrdersWithHttpInfoAsync(List ordersImportCreateRequestBodyItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ImportOrdersWithHttpInfoAsync(List ordersImportCreateRequestBodyItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// List Orders /// @@ -318,11 +318,11 @@ public interface IOrdersApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique Voucherify order ID or order source ID. - /// Specify the parameters of the order that are to be updated. (optional) + /// Specify the parameters of the order that are to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of OrdersUpdateResponseBody - System.Threading.Tasks.Task UpdateOrderAsync(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody = default(OrdersUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateOrderAsync(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Order @@ -332,11 +332,11 @@ public interface IOrdersApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique Voucherify order ID or order source ID. - /// Specify the parameters of the order that are to be updated. (optional) + /// Specify the parameters of the order that are to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (OrdersUpdateResponseBody) - System.Threading.Tasks.Task> UpdateOrderWithHttpInfoAsync(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody = default(OrdersUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateOrderWithHttpInfoAsync(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -461,10 +461,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. /// /// Thrown when fails to make API call - /// Specify the order parameters. (optional) + /// Specify the order parameters. /// Index associated with the operation. /// OrdersCreateResponseBody - public OrdersCreateResponseBody CreateOrder(OrdersCreateRequestBody ordersCreateRequestBody = default(OrdersCreateRequestBody), int operationIndex = 0) + public OrdersCreateResponseBody CreateOrder(OrdersCreateRequestBody ordersCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateOrderWithHttpInfo(ordersCreateRequestBody); return localVarResponse.Data; @@ -474,11 +474,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. /// /// Thrown when fails to make API call - /// Specify the order parameters. (optional) + /// Specify the order parameters. /// Index associated with the operation. /// ApiResponse of OrdersCreateResponseBody - public Voucherify.Client.ApiResponse CreateOrderWithHttpInfo(OrdersCreateRequestBody ordersCreateRequestBody = default(OrdersCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateOrderWithHttpInfo(OrdersCreateRequestBody ordersCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'ordersCreateRequestBody' is set + if (ordersCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'ordersCreateRequestBody' when calling OrdersApi->CreateOrder"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -553,11 +559,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. /// /// Thrown when fails to make API call - /// Specify the order parameters. (optional) + /// Specify the order parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of OrdersCreateResponseBody - public async System.Threading.Tasks.Task CreateOrderAsync(OrdersCreateRequestBody ordersCreateRequestBody = default(OrdersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateOrderAsync(OrdersCreateRequestBody ordersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateOrderWithHttpInfoAsync(ordersCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -567,12 +573,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Order Creates an order object and triggers an order creation event. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields. /// /// Thrown when fails to make API call - /// Specify the order parameters. (optional) + /// Specify the order parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (OrdersCreateResponseBody) - public async System.Threading.Tasks.Task> CreateOrderWithHttpInfoAsync(OrdersCreateRequestBody ordersCreateRequestBody = default(OrdersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateOrderWithHttpInfoAsync(OrdersCreateRequestBody ordersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'ordersCreateRequestBody' is set + if (ordersCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'ordersCreateRequestBody' when calling OrdersApi->CreateOrder"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -648,10 +660,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: /// /// Thrown when fails to make API call - /// Specify which order parameters you would like to export. (optional) + /// Specify which order parameters you would like to export. /// Index associated with the operation. /// OrdersExportCreateResponseBody - public OrdersExportCreateResponseBody CreateOrderExport(OrdersExportCreateRequestBody ordersExportCreateRequestBody = default(OrdersExportCreateRequestBody), int operationIndex = 0) + public OrdersExportCreateResponseBody CreateOrderExport(OrdersExportCreateRequestBody ordersExportCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateOrderExportWithHttpInfo(ordersExportCreateRequestBody); return localVarResponse.Data; @@ -661,11 +673,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: /// /// Thrown when fails to make API call - /// Specify which order parameters you would like to export. (optional) + /// Specify which order parameters you would like to export. /// Index associated with the operation. /// ApiResponse of OrdersExportCreateResponseBody - public Voucherify.Client.ApiResponse CreateOrderExportWithHttpInfo(OrdersExportCreateRequestBody ordersExportCreateRequestBody = default(OrdersExportCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateOrderExportWithHttpInfo(OrdersExportCreateRequestBody ordersExportCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'ordersExportCreateRequestBody' is set + if (ordersExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'ordersExportCreateRequestBody' when calling OrdersApi->CreateOrderExport"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -740,11 +758,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: /// /// Thrown when fails to make API call - /// Specify which order parameters you would like to export. (optional) + /// Specify which order parameters you would like to export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of OrdersExportCreateResponseBody - public async System.Threading.Tasks.Task CreateOrderExportAsync(OrdersExportCreateRequestBody ordersExportCreateRequestBody = default(OrdersExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateOrderExportAsync(OrdersExportCreateRequestBody ordersExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateOrderExportWithHttpInfoAsync(ordersExportCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -754,12 +772,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Orders Export Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: /// /// Thrown when fails to make API call - /// Specify which order parameters you would like to export. (optional) + /// Specify which order parameters you would like to export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (OrdersExportCreateResponseBody) - public async System.Threading.Tasks.Task> CreateOrderExportWithHttpInfoAsync(OrdersExportCreateRequestBody ordersExportCreateRequestBody = default(OrdersExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateOrderExportWithHttpInfoAsync(OrdersExportCreateRequestBody ordersExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'ordersExportCreateRequestBody' is set + if (ordersExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'ordersExportCreateRequestBody' when calling OrdersApi->CreateOrderExport"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -1029,27 +1053,33 @@ public Voucherify.Client.ApiResponse GetOrderWithHttpInfo } /// - /// Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + /// Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. /// /// Thrown when fails to make API call - /// The request body is sent in the form of an array of order objects. (optional) + /// The request body is sent in the form of an array of order objects. /// Index associated with the operation. /// OrdersImportCreateResponseBody - public OrdersImportCreateResponseBody ImportOrders(List ordersImportCreateRequestBodyItem = default(List), int operationIndex = 0) + public OrdersImportCreateResponseBody ImportOrders(List ordersImportCreateRequestBodyItem, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = ImportOrdersWithHttpInfo(ordersImportCreateRequestBodyItem); return localVarResponse.Data; } /// - /// Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + /// Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. /// /// Thrown when fails to make API call - /// The request body is sent in the form of an array of order objects. (optional) + /// The request body is sent in the form of an array of order objects. /// Index associated with the operation. /// ApiResponse of OrdersImportCreateResponseBody - public Voucherify.Client.ApiResponse ImportOrdersWithHttpInfo(List ordersImportCreateRequestBodyItem = default(List), int operationIndex = 0) + public Voucherify.Client.ApiResponse ImportOrdersWithHttpInfo(List ordersImportCreateRequestBodyItem, int operationIndex = 0) { + // verify the required parameter 'ordersImportCreateRequestBodyItem' is set + if (ordersImportCreateRequestBodyItem == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'ordersImportCreateRequestBodyItem' when calling OrdersApi->ImportOrders"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1121,29 +1151,35 @@ public Voucherify.Client.ApiResponse GetOrderWithHttpInfo } /// - /// Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + /// Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. /// /// Thrown when fails to make API call - /// The request body is sent in the form of an array of order objects. (optional) + /// The request body is sent in the form of an array of order objects. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of OrdersImportCreateResponseBody - public async System.Threading.Tasks.Task ImportOrdersAsync(List ordersImportCreateRequestBodyItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ImportOrdersAsync(List ordersImportCreateRequestBodyItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await ImportOrdersWithHttpInfoAsync(ordersImportCreateRequestBodyItem, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } /// - /// Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - **customers entering into segments** - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. + /// Import Orders 🚧 Historical orders This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date thats assigned when theyve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. ## Maximum count of orders in single import There is a 2000 limit of orders per one request. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger - Customers entering into segments - Distributions based on any rules tied to customer entering segment(s) - Earning rules based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. 2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered. 3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you wont see the Product created events listed, etc. 4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint. /// /// Thrown when fails to make API call - /// The request body is sent in the form of an array of order objects. (optional) + /// The request body is sent in the form of an array of order objects. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (OrdersImportCreateResponseBody) - public async System.Threading.Tasks.Task> ImportOrdersWithHttpInfoAsync(List ordersImportCreateRequestBodyItem = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ImportOrdersWithHttpInfoAsync(List ordersImportCreateRequestBodyItem, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'ordersImportCreateRequestBodyItem' is set + if (ordersImportCreateRequestBodyItem == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'ordersImportCreateRequestBodyItem' when calling OrdersApi->ImportOrders"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -1435,10 +1471,10 @@ public Voucherify.Client.ApiResponse GetOrderWithHttpInfo /// /// Thrown when fails to make API call /// Unique Voucherify order ID or order source ID. - /// Specify the parameters of the order that are to be updated. (optional) + /// Specify the parameters of the order that are to be updated. /// Index associated with the operation. /// OrdersUpdateResponseBody - public OrdersUpdateResponseBody UpdateOrder(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody = default(OrdersUpdateRequestBody), int operationIndex = 0) + public OrdersUpdateResponseBody UpdateOrder(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateOrderWithHttpInfo(orderId, ordersUpdateRequestBody); return localVarResponse.Data; @@ -1449,10 +1485,10 @@ public Voucherify.Client.ApiResponse GetOrderWithHttpInfo /// /// Thrown when fails to make API call /// Unique Voucherify order ID or order source ID. - /// Specify the parameters of the order that are to be updated. (optional) + /// Specify the parameters of the order that are to be updated. /// Index associated with the operation. /// ApiResponse of OrdersUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateOrderWithHttpInfo(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody = default(OrdersUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateOrderWithHttpInfo(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'orderId' is set if (orderId == null) @@ -1460,6 +1496,12 @@ public Voucherify.Client.ApiResponse GetOrderWithHttpInfo throw new Voucherify.Client.ApiException(400, "Missing required parameter 'orderId' when calling OrdersApi->UpdateOrder"); } + // verify the required parameter 'ordersUpdateRequestBody' is set + if (ordersUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'ordersUpdateRequestBody' when calling OrdersApi->UpdateOrder"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1536,11 +1578,11 @@ public Voucherify.Client.ApiResponse GetOrderWithHttpInfo /// /// Thrown when fails to make API call /// Unique Voucherify order ID or order source ID. - /// Specify the parameters of the order that are to be updated. (optional) + /// Specify the parameters of the order that are to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of OrdersUpdateResponseBody - public async System.Threading.Tasks.Task UpdateOrderAsync(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody = default(OrdersUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateOrderAsync(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateOrderWithHttpInfoAsync(orderId, ordersUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1551,11 +1593,11 @@ public Voucherify.Client.ApiResponse GetOrderWithHttpInfo /// /// Thrown when fails to make API call /// Unique Voucherify order ID or order source ID. - /// Specify the parameters of the order that are to be updated. (optional) + /// Specify the parameters of the order that are to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (OrdersUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateOrderWithHttpInfoAsync(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody = default(OrdersUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateOrderWithHttpInfoAsync(string orderId, OrdersUpdateRequestBody ordersUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'orderId' is set if (orderId == null) @@ -1563,6 +1605,12 @@ public Voucherify.Client.ApiResponse GetOrderWithHttpInfo throw new Voucherify.Client.ApiException(400, "Missing required parameter 'orderId' when calling OrdersApi->UpdateOrder"); } + // verify the required parameter 'ordersUpdateRequestBody' is set + if (ordersUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'ordersUpdateRequestBody' when calling OrdersApi->UpdateOrder"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/ProductCollectionsApi.cs b/src/Voucherify/Api/ProductCollectionsApi.cs index 71648765..bda13077 100644 --- a/src/Voucherify/Api/ProductCollectionsApi.cs +++ b/src/Voucherify/Api/ProductCollectionsApi.cs @@ -35,10 +35,10 @@ public interface IProductCollectionsApiSync : IApiAccessor /// This method creates a new product collection. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// ProductCollectionsCreateResponseBody - ProductCollectionsCreateResponseBody CreateProductCollection(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody = default(ProductCollectionsCreateRequestBody), int operationIndex = 0); + ProductCollectionsCreateResponseBody CreateProductCollection(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody, int operationIndex = 0); /// /// Create Product Collection @@ -47,10 +47,10 @@ public interface IProductCollectionsApiSync : IApiAccessor /// This method creates a new product collection. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// ApiResponse of ProductCollectionsCreateResponseBody - ApiResponse CreateProductCollectionWithHttpInfo(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody = default(ProductCollectionsCreateRequestBody), int operationIndex = 0); + ApiResponse CreateProductCollectionWithHttpInfo(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody, int operationIndex = 0); /// /// Delete Product Collection /// @@ -171,11 +171,11 @@ public interface IProductCollectionsApiAsync : IApiAccessor /// This method creates a new product collection. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductCollectionsCreateResponseBody - System.Threading.Tasks.Task CreateProductCollectionAsync(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody = default(ProductCollectionsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateProductCollectionAsync(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Product Collection @@ -184,11 +184,11 @@ public interface IProductCollectionsApiAsync : IApiAccessor /// This method creates a new product collection. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductCollectionsCreateResponseBody) - System.Threading.Tasks.Task> CreateProductCollectionWithHttpInfoAsync(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody = default(ProductCollectionsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateProductCollectionWithHttpInfoAsync(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Product Collection /// @@ -425,10 +425,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Product Collection This method creates a new product collection. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// ProductCollectionsCreateResponseBody - public ProductCollectionsCreateResponseBody CreateProductCollection(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody = default(ProductCollectionsCreateRequestBody), int operationIndex = 0) + public ProductCollectionsCreateResponseBody CreateProductCollection(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateProductCollectionWithHttpInfo(productCollectionsCreateRequestBody); return localVarResponse.Data; @@ -438,11 +438,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Product Collection This method creates a new product collection. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// ApiResponse of ProductCollectionsCreateResponseBody - public Voucherify.Client.ApiResponse CreateProductCollectionWithHttpInfo(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody = default(ProductCollectionsCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateProductCollectionWithHttpInfo(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'productCollectionsCreateRequestBody' is set + if (productCollectionsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productCollectionsCreateRequestBody' when calling ProductCollectionsApi->CreateProductCollection"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -517,11 +523,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Product Collection This method creates a new product collection. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductCollectionsCreateResponseBody - public async System.Threading.Tasks.Task CreateProductCollectionAsync(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody = default(ProductCollectionsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateProductCollectionAsync(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateProductCollectionWithHttpInfoAsync(productCollectionsCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -531,12 +537,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Product Collection This method creates a new product collection. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductCollectionsCreateResponseBody) - public async System.Threading.Tasks.Task> CreateProductCollectionWithHttpInfoAsync(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody = default(ProductCollectionsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateProductCollectionWithHttpInfoAsync(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'productCollectionsCreateRequestBody' is set + if (productCollectionsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productCollectionsCreateRequestBody' when calling ProductCollectionsApi->CreateProductCollection"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/ProductsApi.cs b/src/Voucherify/Api/ProductsApi.cs index 7896ac17..3b0698d4 100644 --- a/src/Voucherify/Api/ProductsApi.cs +++ b/src/Voucherify/Api/ProductsApi.cs @@ -35,10 +35,10 @@ public interface IProductsApiSync : IApiAccessor /// Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. /// /// Thrown when fails to make API call - /// Specify the product parameters. (optional) + /// Specify the product parameters. /// Index associated with the operation. /// ProductsCreateResponseBody - ProductsCreateResponseBody CreateProduct(ProductsCreateRequestBody productsCreateRequestBody = default(ProductsCreateRequestBody), int operationIndex = 0); + ProductsCreateResponseBody CreateProduct(ProductsCreateRequestBody productsCreateRequestBody, int operationIndex = 0); /// /// Create Product @@ -47,10 +47,10 @@ public interface IProductsApiSync : IApiAccessor /// Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. /// /// Thrown when fails to make API call - /// Specify the product parameters. (optional) + /// Specify the product parameters. /// Index associated with the operation. /// ApiResponse of ProductsCreateResponseBody - ApiResponse CreateProductWithHttpInfo(ProductsCreateRequestBody productsCreateRequestBody = default(ProductsCreateRequestBody), int operationIndex = 0); + ApiResponse CreateProductWithHttpInfo(ProductsCreateRequestBody productsCreateRequestBody, int operationIndex = 0); /// /// Create SKU /// @@ -59,10 +59,10 @@ public interface IProductsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - /// Specify the SKU parameters to be created. (optional) + /// Specify the SKU parameters to be created. /// Index associated with the operation. /// ProductsSkusCreateResponseBody - ProductsSkusCreateResponseBody CreateSku(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody = default(ProductsSkusCreateRequestBody), int operationIndex = 0); + ProductsSkusCreateResponseBody CreateSku(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody, int operationIndex = 0); /// /// Create SKU @@ -72,10 +72,10 @@ public interface IProductsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - /// Specify the SKU parameters to be created. (optional) + /// Specify the SKU parameters to be created. /// Index associated with the operation. /// ApiResponse of ProductsSkusCreateResponseBody - ApiResponse CreateSkuWithHttpInfo(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody = default(ProductsSkusCreateRequestBody), int operationIndex = 0); + ApiResponse CreateSkuWithHttpInfo(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody, int operationIndex = 0); /// /// Delete Product /// @@ -292,10 +292,10 @@ public interface IProductsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A Voucherify product ID or source ID. - /// Specify the parameters of the product that are to be updated. (optional) + /// Specify the parameters of the product that are to be updated. /// Index associated with the operation. /// ProductsUpdateResponseBody - ProductsUpdateResponseBody UpdateProduct(string productId, ProductsUpdateRequestBody productsUpdateRequestBody = default(ProductsUpdateRequestBody), int operationIndex = 0); + ProductsUpdateResponseBody UpdateProduct(string productId, ProductsUpdateRequestBody productsUpdateRequestBody, int operationIndex = 0); /// /// Update Product @@ -305,10 +305,10 @@ public interface IProductsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A Voucherify product ID or source ID. - /// Specify the parameters of the product that are to be updated. (optional) + /// Specify the parameters of the product that are to be updated. /// Index associated with the operation. /// ApiResponse of ProductsUpdateResponseBody - ApiResponse UpdateProductWithHttpInfo(string productId, ProductsUpdateRequestBody productsUpdateRequestBody = default(ProductsUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateProductWithHttpInfo(string productId, ProductsUpdateRequestBody productsUpdateRequestBody, int operationIndex = 0); /// /// Update Products in Bulk /// @@ -316,10 +316,10 @@ public interface IProductsApiSync : IApiAccessor /// Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the product fields to be updated in each product object. (optional) + /// List the product fields to be updated in each product object. /// Index associated with the operation. /// ProductsUpdateInBulkResponseBody - ProductsUpdateInBulkResponseBody UpdateProductsInBulk(List productsUpdateInBulkRequestBody = default(List), int operationIndex = 0); + ProductsUpdateInBulkResponseBody UpdateProductsInBulk(List productsUpdateInBulkRequestBody, int operationIndex = 0); /// /// Update Products in Bulk @@ -328,10 +328,10 @@ public interface IProductsApiSync : IApiAccessor /// Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the product fields to be updated in each product object. (optional) + /// List the product fields to be updated in each product object. /// Index associated with the operation. /// ApiResponse of ProductsUpdateInBulkResponseBody - ApiResponse UpdateProductsInBulkWithHttpInfo(List productsUpdateInBulkRequestBody = default(List), int operationIndex = 0); + ApiResponse UpdateProductsInBulkWithHttpInfo(List productsUpdateInBulkRequestBody, int operationIndex = 0); /// /// Update Products' Metadata in Bulk /// @@ -339,10 +339,10 @@ public interface IProductsApiSync : IApiAccessor /// Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the products you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// ProductsMetadataUpdateInBulkResponseBody - ProductsMetadataUpdateInBulkResponseBody UpdateProductsMetadataInBulk(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody = default(ProductsMetadataUpdateInBulkRequestBody), int operationIndex = 0); + ProductsMetadataUpdateInBulkResponseBody UpdateProductsMetadataInBulk(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody, int operationIndex = 0); /// /// Update Products' Metadata in Bulk @@ -351,10 +351,10 @@ public interface IProductsApiSync : IApiAccessor /// Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the products you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// ApiResponse of ProductsMetadataUpdateInBulkResponseBody - ApiResponse UpdateProductsMetadataInBulkWithHttpInfo(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody = default(ProductsMetadataUpdateInBulkRequestBody), int operationIndex = 0); + ApiResponse UpdateProductsMetadataInBulkWithHttpInfo(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody, int operationIndex = 0); /// /// Update SKU /// @@ -364,10 +364,10 @@ public interface IProductsApiSync : IApiAccessor /// Thrown when fails to make API call /// A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. /// A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// ProductsSkusUpdateResponseBody - ProductsSkusUpdateResponseBody UpdateSku(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody = default(ProductsSkusUpdateRequestBody), int operationIndex = 0); + ProductsSkusUpdateResponseBody UpdateSku(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody, int operationIndex = 0); /// /// Update SKU @@ -378,10 +378,10 @@ public interface IProductsApiSync : IApiAccessor /// Thrown when fails to make API call /// A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. /// A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// ApiResponse of ProductsSkusUpdateResponseBody - ApiResponse UpdateSkuWithHttpInfo(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody = default(ProductsSkusUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateSkuWithHttpInfo(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -398,11 +398,11 @@ public interface IProductsApiAsync : IApiAccessor /// Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. /// /// Thrown when fails to make API call - /// Specify the product parameters. (optional) + /// Specify the product parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductsCreateResponseBody - System.Threading.Tasks.Task CreateProductAsync(ProductsCreateRequestBody productsCreateRequestBody = default(ProductsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateProductAsync(ProductsCreateRequestBody productsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Product @@ -411,11 +411,11 @@ public interface IProductsApiAsync : IApiAccessor /// Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. /// /// Thrown when fails to make API call - /// Specify the product parameters. (optional) + /// Specify the product parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductsCreateResponseBody) - System.Threading.Tasks.Task> CreateProductWithHttpInfoAsync(ProductsCreateRequestBody productsCreateRequestBody = default(ProductsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateProductWithHttpInfoAsync(ProductsCreateRequestBody productsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create SKU /// @@ -424,11 +424,11 @@ public interface IProductsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - /// Specify the SKU parameters to be created. (optional) + /// Specify the SKU parameters to be created. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductsSkusCreateResponseBody - System.Threading.Tasks.Task CreateSkuAsync(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody = default(ProductsSkusCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateSkuAsync(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create SKU @@ -438,11 +438,11 @@ public interface IProductsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - /// Specify the SKU parameters to be created. (optional) + /// Specify the SKU parameters to be created. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductsSkusCreateResponseBody) - System.Threading.Tasks.Task> CreateSkuWithHttpInfoAsync(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody = default(ProductsSkusCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateSkuWithHttpInfoAsync(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Product /// @@ -675,11 +675,11 @@ public interface IProductsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A Voucherify product ID or source ID. - /// Specify the parameters of the product that are to be updated. (optional) + /// Specify the parameters of the product that are to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductsUpdateResponseBody - System.Threading.Tasks.Task UpdateProductAsync(string productId, ProductsUpdateRequestBody productsUpdateRequestBody = default(ProductsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateProductAsync(string productId, ProductsUpdateRequestBody productsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Product @@ -689,11 +689,11 @@ public interface IProductsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A Voucherify product ID or source ID. - /// Specify the parameters of the product that are to be updated. (optional) + /// Specify the parameters of the product that are to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductsUpdateResponseBody) - System.Threading.Tasks.Task> UpdateProductWithHttpInfoAsync(string productId, ProductsUpdateRequestBody productsUpdateRequestBody = default(ProductsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateProductWithHttpInfoAsync(string productId, ProductsUpdateRequestBody productsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Products in Bulk /// @@ -701,11 +701,11 @@ public interface IProductsApiAsync : IApiAccessor /// Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the product fields to be updated in each product object. (optional) + /// List the product fields to be updated in each product object. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductsUpdateInBulkResponseBody - System.Threading.Tasks.Task UpdateProductsInBulkAsync(List productsUpdateInBulkRequestBody = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateProductsInBulkAsync(List productsUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Products in Bulk @@ -714,11 +714,11 @@ public interface IProductsApiAsync : IApiAccessor /// Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the product fields to be updated in each product object. (optional) + /// List the product fields to be updated in each product object. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductsUpdateInBulkResponseBody) - System.Threading.Tasks.Task> UpdateProductsInBulkWithHttpInfoAsync(List productsUpdateInBulkRequestBody = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateProductsInBulkWithHttpInfoAsync(List productsUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Products' Metadata in Bulk /// @@ -726,11 +726,11 @@ public interface IProductsApiAsync : IApiAccessor /// Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the products you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductsMetadataUpdateInBulkResponseBody - System.Threading.Tasks.Task UpdateProductsMetadataInBulkAsync(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody = default(ProductsMetadataUpdateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateProductsMetadataInBulkAsync(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Products' Metadata in Bulk @@ -739,11 +739,11 @@ public interface IProductsApiAsync : IApiAccessor /// Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the products you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductsMetadataUpdateInBulkResponseBody) - System.Threading.Tasks.Task> UpdateProductsMetadataInBulkWithHttpInfoAsync(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody = default(ProductsMetadataUpdateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateProductsMetadataInBulkWithHttpInfoAsync(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update SKU /// @@ -753,11 +753,11 @@ public interface IProductsApiAsync : IApiAccessor /// Thrown when fails to make API call /// A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. /// A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductsSkusUpdateResponseBody - System.Threading.Tasks.Task UpdateSkuAsync(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody = default(ProductsSkusUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateSkuAsync(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update SKU @@ -768,11 +768,11 @@ public interface IProductsApiAsync : IApiAccessor /// Thrown when fails to make API call /// A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. /// A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductsSkusUpdateResponseBody) - System.Threading.Tasks.Task> UpdateSkuWithHttpInfoAsync(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody = default(ProductsSkusUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateSkuWithHttpInfoAsync(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -897,10 +897,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. /// /// Thrown when fails to make API call - /// Specify the product parameters. (optional) + /// Specify the product parameters. /// Index associated with the operation. /// ProductsCreateResponseBody - public ProductsCreateResponseBody CreateProduct(ProductsCreateRequestBody productsCreateRequestBody = default(ProductsCreateRequestBody), int operationIndex = 0) + public ProductsCreateResponseBody CreateProduct(ProductsCreateRequestBody productsCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateProductWithHttpInfo(productsCreateRequestBody); return localVarResponse.Data; @@ -910,11 +910,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. /// /// Thrown when fails to make API call - /// Specify the product parameters. (optional) + /// Specify the product parameters. /// Index associated with the operation. /// ApiResponse of ProductsCreateResponseBody - public Voucherify.Client.ApiResponse CreateProductWithHttpInfo(ProductsCreateRequestBody productsCreateRequestBody = default(ProductsCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateProductWithHttpInfo(ProductsCreateRequestBody productsCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'productsCreateRequestBody' is set + if (productsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productsCreateRequestBody' when calling ProductsApi->CreateProduct"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -989,11 +995,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. /// /// Thrown when fails to make API call - /// Specify the product parameters. (optional) + /// Specify the product parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductsCreateResponseBody - public async System.Threading.Tasks.Task CreateProductAsync(ProductsCreateRequestBody productsCreateRequestBody = default(ProductsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateProductAsync(ProductsCreateRequestBody productsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateProductWithHttpInfoAsync(productsCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1003,12 +1009,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Product Creates a product object. πŸ“˜ Upsert Mode If you pass an id or a source_id that already exists in the product database, Voucherify will return a related product object with updated fields. /// /// Thrown when fails to make API call - /// Specify the product parameters. (optional) + /// Specify the product parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductsCreateResponseBody) - public async System.Threading.Tasks.Task> CreateProductWithHttpInfoAsync(ProductsCreateRequestBody productsCreateRequestBody = default(ProductsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateProductWithHttpInfoAsync(ProductsCreateRequestBody productsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'productsCreateRequestBody' is set + if (productsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productsCreateRequestBody' when calling ProductsApi->CreateProduct"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -1085,10 +1097,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - /// Specify the SKU parameters to be created. (optional) + /// Specify the SKU parameters to be created. /// Index associated with the operation. /// ProductsSkusCreateResponseBody - public ProductsSkusCreateResponseBody CreateSku(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody = default(ProductsSkusCreateRequestBody), int operationIndex = 0) + public ProductsSkusCreateResponseBody CreateSku(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateSkuWithHttpInfo(productId, productsSkusCreateRequestBody); return localVarResponse.Data; @@ -1099,10 +1111,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - /// Specify the SKU parameters to be created. (optional) + /// Specify the SKU parameters to be created. /// Index associated with the operation. /// ApiResponse of ProductsSkusCreateResponseBody - public Voucherify.Client.ApiResponse CreateSkuWithHttpInfo(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody = default(ProductsSkusCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateSkuWithHttpInfo(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'productId' is set if (productId == null) @@ -1110,6 +1122,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productId' when calling ProductsApi->CreateSku"); } + // verify the required parameter 'productsSkusCreateRequestBody' is set + if (productsSkusCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productsSkusCreateRequestBody' when calling ProductsApi->CreateSku"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1186,11 +1204,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - /// Specify the SKU parameters to be created. (optional) + /// Specify the SKU parameters to be created. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductsSkusCreateResponseBody - public async System.Threading.Tasks.Task CreateSkuAsync(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody = default(ProductsSkusCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateSkuAsync(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateSkuWithHttpInfoAsync(productId, productsSkusCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1201,11 +1219,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// A Voucherify [product](/api-reference/products/get-product) ID or product source ID. - /// Specify the SKU parameters to be created. (optional) + /// Specify the SKU parameters to be created. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductsSkusCreateResponseBody) - public async System.Threading.Tasks.Task> CreateSkuWithHttpInfoAsync(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody = default(ProductsSkusCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateSkuWithHttpInfoAsync(string productId, ProductsSkusCreateRequestBody productsSkusCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'productId' is set if (productId == null) @@ -1213,6 +1231,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productId' when calling ProductsApi->CreateSku"); } + // verify the required parameter 'productsSkusCreateRequestBody' is set + if (productsSkusCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productsSkusCreateRequestBody' when calling ProductsApi->CreateSku"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2994,10 +3018,10 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// /// Thrown when fails to make API call /// A Voucherify product ID or source ID. - /// Specify the parameters of the product that are to be updated. (optional) + /// Specify the parameters of the product that are to be updated. /// Index associated with the operation. /// ProductsUpdateResponseBody - public ProductsUpdateResponseBody UpdateProduct(string productId, ProductsUpdateRequestBody productsUpdateRequestBody = default(ProductsUpdateRequestBody), int operationIndex = 0) + public ProductsUpdateResponseBody UpdateProduct(string productId, ProductsUpdateRequestBody productsUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateProductWithHttpInfo(productId, productsUpdateRequestBody); return localVarResponse.Data; @@ -3008,10 +3032,10 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// /// Thrown when fails to make API call /// A Voucherify product ID or source ID. - /// Specify the parameters of the product that are to be updated. (optional) + /// Specify the parameters of the product that are to be updated. /// Index associated with the operation. /// ApiResponse of ProductsUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateProductWithHttpInfo(string productId, ProductsUpdateRequestBody productsUpdateRequestBody = default(ProductsUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateProductWithHttpInfo(string productId, ProductsUpdateRequestBody productsUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'productId' is set if (productId == null) @@ -3019,6 +3043,12 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productId' when calling ProductsApi->UpdateProduct"); } + // verify the required parameter 'productsUpdateRequestBody' is set + if (productsUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productsUpdateRequestBody' when calling ProductsApi->UpdateProduct"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3095,11 +3125,11 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// /// Thrown when fails to make API call /// A Voucherify product ID or source ID. - /// Specify the parameters of the product that are to be updated. (optional) + /// Specify the parameters of the product that are to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductsUpdateResponseBody - public async System.Threading.Tasks.Task UpdateProductAsync(string productId, ProductsUpdateRequestBody productsUpdateRequestBody = default(ProductsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateProductAsync(string productId, ProductsUpdateRequestBody productsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateProductWithHttpInfoAsync(productId, productsUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -3110,11 +3140,11 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// /// Thrown when fails to make API call /// A Voucherify product ID or source ID. - /// Specify the parameters of the product that are to be updated. (optional) + /// Specify the parameters of the product that are to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductsUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateProductWithHttpInfoAsync(string productId, ProductsUpdateRequestBody productsUpdateRequestBody = default(ProductsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateProductWithHttpInfoAsync(string productId, ProductsUpdateRequestBody productsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'productId' is set if (productId == null) @@ -3122,6 +3152,12 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productId' when calling ProductsApi->UpdateProduct"); } + // verify the required parameter 'productsUpdateRequestBody' is set + if (productsUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productsUpdateRequestBody' when calling ProductsApi->UpdateProduct"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -3198,10 +3234,10 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the product fields to be updated in each product object. (optional) + /// List the product fields to be updated in each product object. /// Index associated with the operation. /// ProductsUpdateInBulkResponseBody - public ProductsUpdateInBulkResponseBody UpdateProductsInBulk(List productsUpdateInBulkRequestBody = default(List), int operationIndex = 0) + public ProductsUpdateInBulkResponseBody UpdateProductsInBulk(List productsUpdateInBulkRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateProductsInBulkWithHttpInfo(productsUpdateInBulkRequestBody); return localVarResponse.Data; @@ -3211,11 +3247,17 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the product fields to be updated in each product object. (optional) + /// List the product fields to be updated in each product object. /// Index associated with the operation. /// ApiResponse of ProductsUpdateInBulkResponseBody - public Voucherify.Client.ApiResponse UpdateProductsInBulkWithHttpInfo(List productsUpdateInBulkRequestBody = default(List), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateProductsInBulkWithHttpInfo(List productsUpdateInBulkRequestBody, int operationIndex = 0) { + // verify the required parameter 'productsUpdateInBulkRequestBody' is set + if (productsUpdateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productsUpdateInBulkRequestBody' when calling ProductsApi->UpdateProductsInBulk"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3290,11 +3332,11 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the product fields to be updated in each product object. (optional) + /// List the product fields to be updated in each product object. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductsUpdateInBulkResponseBody - public async System.Threading.Tasks.Task UpdateProductsInBulkAsync(List productsUpdateInBulkRequestBody = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateProductsInBulkAsync(List productsUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateProductsInBulkWithHttpInfoAsync(productsUpdateInBulkRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -3304,12 +3346,18 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// Update Products in Bulk Update products in one asynchronous operation. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the product fields to be updated in each product object. (optional) + /// List the product fields to be updated in each product object. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductsUpdateInBulkResponseBody) - public async System.Threading.Tasks.Task> UpdateProductsInBulkWithHttpInfoAsync(List productsUpdateInBulkRequestBody = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateProductsInBulkWithHttpInfoAsync(List productsUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'productsUpdateInBulkRequestBody' is set + if (productsUpdateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productsUpdateInBulkRequestBody' when calling ProductsApi->UpdateProductsInBulk"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -3385,10 +3433,10 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the products you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// ProductsMetadataUpdateInBulkResponseBody - public ProductsMetadataUpdateInBulkResponseBody UpdateProductsMetadataInBulk(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody = default(ProductsMetadataUpdateInBulkRequestBody), int operationIndex = 0) + public ProductsMetadataUpdateInBulkResponseBody UpdateProductsMetadataInBulk(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateProductsMetadataInBulkWithHttpInfo(productsMetadataUpdateInBulkRequestBody); return localVarResponse.Data; @@ -3398,11 +3446,17 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the products you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// ApiResponse of ProductsMetadataUpdateInBulkResponseBody - public Voucherify.Client.ApiResponse UpdateProductsMetadataInBulkWithHttpInfo(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody = default(ProductsMetadataUpdateInBulkRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateProductsMetadataInBulkWithHttpInfo(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody, int operationIndex = 0) { + // verify the required parameter 'productsMetadataUpdateInBulkRequestBody' is set + if (productsMetadataUpdateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productsMetadataUpdateInBulkRequestBody' when calling ProductsApi->UpdateProductsMetadataInBulk"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3477,11 +3531,11 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the products you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductsMetadataUpdateInBulkResponseBody - public async System.Threading.Tasks.Task UpdateProductsMetadataInBulkAsync(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody = default(ProductsMetadataUpdateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateProductsMetadataInBulkAsync(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateProductsMetadataInBulkWithHttpInfoAsync(productsMetadataUpdateInBulkRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -3491,12 +3545,18 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// Update Products' Metadata in Bulk Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update If a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value false in the found column and true in the updated column. This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished. /// /// Thrown when fails to make API call - /// List the source_ids of the products you would like to update with the metadata key/value pairs. (optional) + /// List the source_ids of the products you would like to update with the metadata key/value pairs. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductsMetadataUpdateInBulkResponseBody) - public async System.Threading.Tasks.Task> UpdateProductsMetadataInBulkWithHttpInfoAsync(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody = default(ProductsMetadataUpdateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateProductsMetadataInBulkWithHttpInfoAsync(ProductsMetadataUpdateInBulkRequestBody productsMetadataUpdateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'productsMetadataUpdateInBulkRequestBody' is set + if (productsMetadataUpdateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productsMetadataUpdateInBulkRequestBody' when calling ProductsApi->UpdateProductsMetadataInBulk"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -3574,10 +3634,10 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// Thrown when fails to make API call /// A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. /// A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// ProductsSkusUpdateResponseBody - public ProductsSkusUpdateResponseBody UpdateSku(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody = default(ProductsSkusUpdateRequestBody), int operationIndex = 0) + public ProductsSkusUpdateResponseBody UpdateSku(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateSkuWithHttpInfo(productId, skuId, productsSkusUpdateRequestBody); return localVarResponse.Data; @@ -3589,10 +3649,10 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// Thrown when fails to make API call /// A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. /// A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// ApiResponse of ProductsSkusUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateSkuWithHttpInfo(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody = default(ProductsSkusUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateSkuWithHttpInfo(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'productId' is set if (productId == null) @@ -3606,6 +3666,12 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str throw new Voucherify.Client.ApiException(400, "Missing required parameter 'skuId' when calling ProductsApi->UpdateSku"); } + // verify the required parameter 'productsSkusUpdateRequestBody' is set + if (productsSkusUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productsSkusUpdateRequestBody' when calling ProductsApi->UpdateSku"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3684,11 +3750,11 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// Thrown when fails to make API call /// A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. /// A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ProductsSkusUpdateResponseBody - public async System.Threading.Tasks.Task UpdateSkuAsync(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody = default(ProductsSkusUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateSkuAsync(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateSkuWithHttpInfoAsync(productId, skuId, productsSkusUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -3700,11 +3766,11 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str /// Thrown when fails to make API call /// A unique Voucherify [product](/api-reference/products/get-product) ID or product source ID. /// A Voucherify [SKU ID](/api-reference/products/get-sku) or SKU source ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ProductsSkusUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateSkuWithHttpInfoAsync(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody = default(ProductsSkusUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateSkuWithHttpInfoAsync(string productId, string skuId, ProductsSkusUpdateRequestBody productsSkusUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'productId' is set if (productId == null) @@ -3718,6 +3784,12 @@ public Voucherify.Client.ApiResponse GetSkuWithHttpInfo(str throw new Voucherify.Client.ApiException(400, "Missing required parameter 'skuId' when calling ProductsApi->UpdateSku"); } + // verify the required parameter 'productsSkusUpdateRequestBody' is set + if (productsSkusUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'productsSkusUpdateRequestBody' when calling ProductsApi->UpdateSku"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/PromotionsApi.cs b/src/Voucherify/Api/PromotionsApi.cs index e714dbd5..a445ca00 100644 --- a/src/Voucherify/Api/PromotionsApi.cs +++ b/src/Voucherify/Api/PromotionsApi.cs @@ -36,10 +36,10 @@ public interface IPromotionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID assigned by Voucherify. - /// Specify the promotion tier parameters. (optional) + /// Specify the promotion tier parameters. /// Index associated with the operation. /// PromotionsTiersCreateResponseBody - PromotionsTiersCreateResponseBody AddPromotionTierToCampaign(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody = default(PromotionsTiersCreateRequestBody), int operationIndex = 0); + PromotionsTiersCreateResponseBody AddPromotionTierToCampaign(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody, int operationIndex = 0); /// /// Add Promotion Tier to Campaign @@ -49,10 +49,10 @@ public interface IPromotionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID assigned by Voucherify. - /// Specify the promotion tier parameters. (optional) + /// Specify the promotion tier parameters. /// Index associated with the operation. /// ApiResponse of PromotionsTiersCreateResponseBody - ApiResponse AddPromotionTierToCampaignWithHttpInfo(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody = default(PromotionsTiersCreateRequestBody), int operationIndex = 0); + ApiResponse AddPromotionTierToCampaignWithHttpInfo(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody, int operationIndex = 0); /// /// Create Promotion Stack /// @@ -61,10 +61,10 @@ public interface IPromotionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID. - /// Specify the order of promotion tiers for the promotion stack. (optional) + /// Specify the order of promotion tiers for the promotion stack. /// Index associated with the operation. /// PromotionsStacksCreateResponseBody - PromotionsStacksCreateResponseBody CreatePromotionStack(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody = default(PromotionsStacksCreateRequestBody), int operationIndex = 0); + PromotionsStacksCreateResponseBody CreatePromotionStack(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody, int operationIndex = 0); /// /// Create Promotion Stack @@ -74,10 +74,10 @@ public interface IPromotionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID. - /// Specify the order of promotion tiers for the promotion stack. (optional) + /// Specify the order of promotion tiers for the promotion stack. /// Index associated with the operation. /// ApiResponse of PromotionsStacksCreateResponseBody - ApiResponse CreatePromotionStackWithHttpInfo(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody = default(PromotionsStacksCreateRequestBody), int operationIndex = 0); + ApiResponse CreatePromotionStackWithHttpInfo(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody, int operationIndex = 0); /// /// Delete Promotion Stack /// @@ -335,10 +335,10 @@ public interface IPromotionsApiSync : IApiAccessor /// Thrown when fails to make API call /// ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. /// Promotion stack ID. - /// Specify the promotion stack parameters that you would like to update. (optional) + /// Specify the promotion stack parameters that you would like to update. /// Index associated with the operation. /// PromotionsStacksUpdateResponseBody - PromotionsStacksUpdateResponseBody UpdatePromotionStack(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody = default(PromotionsStacksUpdateRequestBody), int operationIndex = 0); + PromotionsStacksUpdateResponseBody UpdatePromotionStack(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody, int operationIndex = 0); /// /// Update Promotion Stack @@ -349,10 +349,10 @@ public interface IPromotionsApiSync : IApiAccessor /// Thrown when fails to make API call /// ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. /// Promotion stack ID. - /// Specify the promotion stack parameters that you would like to update. (optional) + /// Specify the promotion stack parameters that you would like to update. /// Index associated with the operation. /// ApiResponse of PromotionsStacksUpdateResponseBody - ApiResponse UpdatePromotionStackWithHttpInfo(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody = default(PromotionsStacksUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdatePromotionStackWithHttpInfo(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody, int operationIndex = 0); /// /// Update Promotion Tier /// @@ -361,10 +361,10 @@ public interface IPromotionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique promotion tier ID. - /// Specify the promotion tier parameters that you would like to update. (optional) + /// Specify the promotion tier parameters that you would like to update. /// Index associated with the operation. /// PromotionsTiersUpdateResponseBody - PromotionsTiersUpdateResponseBody UpdatePromotionTier(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody = default(PromotionsTiersUpdateRequestBody), int operationIndex = 0); + PromotionsTiersUpdateResponseBody UpdatePromotionTier(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody, int operationIndex = 0); /// /// Update Promotion Tier @@ -374,10 +374,10 @@ public interface IPromotionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique promotion tier ID. - /// Specify the promotion tier parameters that you would like to update. (optional) + /// Specify the promotion tier parameters that you would like to update. /// Index associated with the operation. /// ApiResponse of PromotionsTiersUpdateResponseBody - ApiResponse UpdatePromotionTierWithHttpInfo(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody = default(PromotionsTiersUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdatePromotionTierWithHttpInfo(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -395,11 +395,11 @@ public interface IPromotionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID assigned by Voucherify. - /// Specify the promotion tier parameters. (optional) + /// Specify the promotion tier parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of PromotionsTiersCreateResponseBody - System.Threading.Tasks.Task AddPromotionTierToCampaignAsync(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody = default(PromotionsTiersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task AddPromotionTierToCampaignAsync(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Add Promotion Tier to Campaign @@ -409,11 +409,11 @@ public interface IPromotionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID assigned by Voucherify. - /// Specify the promotion tier parameters. (optional) + /// Specify the promotion tier parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (PromotionsTiersCreateResponseBody) - System.Threading.Tasks.Task> AddPromotionTierToCampaignWithHttpInfoAsync(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody = default(PromotionsTiersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> AddPromotionTierToCampaignWithHttpInfoAsync(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Promotion Stack /// @@ -422,11 +422,11 @@ public interface IPromotionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID. - /// Specify the order of promotion tiers for the promotion stack. (optional) + /// Specify the order of promotion tiers for the promotion stack. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of PromotionsStacksCreateResponseBody - System.Threading.Tasks.Task CreatePromotionStackAsync(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody = default(PromotionsStacksCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreatePromotionStackAsync(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Promotion Stack @@ -436,11 +436,11 @@ public interface IPromotionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique campaign ID. - /// Specify the order of promotion tiers for the promotion stack. (optional) + /// Specify the order of promotion tiers for the promotion stack. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (PromotionsStacksCreateResponseBody) - System.Threading.Tasks.Task> CreatePromotionStackWithHttpInfoAsync(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody = default(PromotionsStacksCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreatePromotionStackWithHttpInfoAsync(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Promotion Stack /// @@ -718,11 +718,11 @@ public interface IPromotionsApiAsync : IApiAccessor /// Thrown when fails to make API call /// ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. /// Promotion stack ID. - /// Specify the promotion stack parameters that you would like to update. (optional) + /// Specify the promotion stack parameters that you would like to update. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of PromotionsStacksUpdateResponseBody - System.Threading.Tasks.Task UpdatePromotionStackAsync(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody = default(PromotionsStacksUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdatePromotionStackAsync(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Promotion Stack @@ -733,11 +733,11 @@ public interface IPromotionsApiAsync : IApiAccessor /// Thrown when fails to make API call /// ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. /// Promotion stack ID. - /// Specify the promotion stack parameters that you would like to update. (optional) + /// Specify the promotion stack parameters that you would like to update. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (PromotionsStacksUpdateResponseBody) - System.Threading.Tasks.Task> UpdatePromotionStackWithHttpInfoAsync(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody = default(PromotionsStacksUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdatePromotionStackWithHttpInfoAsync(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Promotion Tier /// @@ -746,11 +746,11 @@ public interface IPromotionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique promotion tier ID. - /// Specify the promotion tier parameters that you would like to update. (optional) + /// Specify the promotion tier parameters that you would like to update. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of PromotionsTiersUpdateResponseBody - System.Threading.Tasks.Task UpdatePromotionTierAsync(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody = default(PromotionsTiersUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdatePromotionTierAsync(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Promotion Tier @@ -760,11 +760,11 @@ public interface IPromotionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique promotion tier ID. - /// Specify the promotion tier parameters that you would like to update. (optional) + /// Specify the promotion tier parameters that you would like to update. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (PromotionsTiersUpdateResponseBody) - System.Threading.Tasks.Task> UpdatePromotionTierWithHttpInfoAsync(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody = default(PromotionsTiersUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdatePromotionTierWithHttpInfoAsync(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -890,10 +890,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique campaign ID assigned by Voucherify. - /// Specify the promotion tier parameters. (optional) + /// Specify the promotion tier parameters. /// Index associated with the operation. /// PromotionsTiersCreateResponseBody - public PromotionsTiersCreateResponseBody AddPromotionTierToCampaign(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody = default(PromotionsTiersCreateRequestBody), int operationIndex = 0) + public PromotionsTiersCreateResponseBody AddPromotionTierToCampaign(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = AddPromotionTierToCampaignWithHttpInfo(campaignId, promotionsTiersCreateRequestBody); return localVarResponse.Data; @@ -904,10 +904,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique campaign ID assigned by Voucherify. - /// Specify the promotion tier parameters. (optional) + /// Specify the promotion tier parameters. /// Index associated with the operation. /// ApiResponse of PromotionsTiersCreateResponseBody - public Voucherify.Client.ApiResponse AddPromotionTierToCampaignWithHttpInfo(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody = default(PromotionsTiersCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse AddPromotionTierToCampaignWithHttpInfo(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -915,6 +915,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling PromotionsApi->AddPromotionTierToCampaign"); } + // verify the required parameter 'promotionsTiersCreateRequestBody' is set + if (promotionsTiersCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'promotionsTiersCreateRequestBody' when calling PromotionsApi->AddPromotionTierToCampaign"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -991,11 +997,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique campaign ID assigned by Voucherify. - /// Specify the promotion tier parameters. (optional) + /// Specify the promotion tier parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of PromotionsTiersCreateResponseBody - public async System.Threading.Tasks.Task AddPromotionTierToCampaignAsync(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody = default(PromotionsTiersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task AddPromotionTierToCampaignAsync(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await AddPromotionTierToCampaignWithHttpInfoAsync(campaignId, promotionsTiersCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1006,11 +1012,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique campaign ID assigned by Voucherify. - /// Specify the promotion tier parameters. (optional) + /// Specify the promotion tier parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (PromotionsTiersCreateResponseBody) - public async System.Threading.Tasks.Task> AddPromotionTierToCampaignWithHttpInfoAsync(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody = default(PromotionsTiersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> AddPromotionTierToCampaignWithHttpInfoAsync(string campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -1018,6 +1024,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling PromotionsApi->AddPromotionTierToCampaign"); } + // verify the required parameter 'promotionsTiersCreateRequestBody' is set + if (promotionsTiersCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'promotionsTiersCreateRequestBody' when calling PromotionsApi->AddPromotionTierToCampaign"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -1095,10 +1107,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique campaign ID. - /// Specify the order of promotion tiers for the promotion stack. (optional) + /// Specify the order of promotion tiers for the promotion stack. /// Index associated with the operation. /// PromotionsStacksCreateResponseBody - public PromotionsStacksCreateResponseBody CreatePromotionStack(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody = default(PromotionsStacksCreateRequestBody), int operationIndex = 0) + public PromotionsStacksCreateResponseBody CreatePromotionStack(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreatePromotionStackWithHttpInfo(campaignId, promotionsStacksCreateRequestBody); return localVarResponse.Data; @@ -1109,10 +1121,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique campaign ID. - /// Specify the order of promotion tiers for the promotion stack. (optional) + /// Specify the order of promotion tiers for the promotion stack. /// Index associated with the operation. /// ApiResponse of PromotionsStacksCreateResponseBody - public Voucherify.Client.ApiResponse CreatePromotionStackWithHttpInfo(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody = default(PromotionsStacksCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreatePromotionStackWithHttpInfo(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -1120,6 +1132,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling PromotionsApi->CreatePromotionStack"); } + // verify the required parameter 'promotionsStacksCreateRequestBody' is set + if (promotionsStacksCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'promotionsStacksCreateRequestBody' when calling PromotionsApi->CreatePromotionStack"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1196,11 +1214,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique campaign ID. - /// Specify the order of promotion tiers for the promotion stack. (optional) + /// Specify the order of promotion tiers for the promotion stack. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of PromotionsStacksCreateResponseBody - public async System.Threading.Tasks.Task CreatePromotionStackAsync(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody = default(PromotionsStacksCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreatePromotionStackAsync(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreatePromotionStackWithHttpInfoAsync(campaignId, promotionsStacksCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1211,11 +1229,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique campaign ID. - /// Specify the order of promotion tiers for the promotion stack. (optional) + /// Specify the order of promotion tiers for the promotion stack. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (PromotionsStacksCreateResponseBody) - public async System.Threading.Tasks.Task> CreatePromotionStackWithHttpInfoAsync(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody = default(PromotionsStacksCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreatePromotionStackWithHttpInfoAsync(string campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -1223,6 +1241,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignId' when calling PromotionsApi->CreatePromotionStack"); } + // verify the required parameter 'promotionsStacksCreateRequestBody' is set + if (promotionsStacksCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'promotionsStacksCreateRequestBody' when calling PromotionsApi->CreatePromotionStack"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -3399,10 +3423,10 @@ public Voucherify.Client.ApiResponse ListPromot /// Thrown when fails to make API call /// ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. /// Promotion stack ID. - /// Specify the promotion stack parameters that you would like to update. (optional) + /// Specify the promotion stack parameters that you would like to update. /// Index associated with the operation. /// PromotionsStacksUpdateResponseBody - public PromotionsStacksUpdateResponseBody UpdatePromotionStack(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody = default(PromotionsStacksUpdateRequestBody), int operationIndex = 0) + public PromotionsStacksUpdateResponseBody UpdatePromotionStack(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdatePromotionStackWithHttpInfo(campaignId, stackId, promotionsStacksUpdateRequestBody); return localVarResponse.Data; @@ -3414,10 +3438,10 @@ public Voucherify.Client.ApiResponse ListPromot /// Thrown when fails to make API call /// ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. /// Promotion stack ID. - /// Specify the promotion stack parameters that you would like to update. (optional) + /// Specify the promotion stack parameters that you would like to update. /// Index associated with the operation. /// ApiResponse of PromotionsStacksUpdateResponseBody - public Voucherify.Client.ApiResponse UpdatePromotionStackWithHttpInfo(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody = default(PromotionsStacksUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdatePromotionStackWithHttpInfo(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -3431,6 +3455,12 @@ public Voucherify.Client.ApiResponse ListPromot throw new Voucherify.Client.ApiException(400, "Missing required parameter 'stackId' when calling PromotionsApi->UpdatePromotionStack"); } + // verify the required parameter 'promotionsStacksUpdateRequestBody' is set + if (promotionsStacksUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'promotionsStacksUpdateRequestBody' when calling PromotionsApi->UpdatePromotionStack"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3509,11 +3539,11 @@ public Voucherify.Client.ApiResponse ListPromot /// Thrown when fails to make API call /// ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. /// Promotion stack ID. - /// Specify the promotion stack parameters that you would like to update. (optional) + /// Specify the promotion stack parameters that you would like to update. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of PromotionsStacksUpdateResponseBody - public async System.Threading.Tasks.Task UpdatePromotionStackAsync(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody = default(PromotionsStacksUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdatePromotionStackAsync(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdatePromotionStackWithHttpInfoAsync(campaignId, stackId, promotionsStacksUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -3525,11 +3555,11 @@ public Voucherify.Client.ApiResponse ListPromot /// Thrown when fails to make API call /// ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. /// Promotion stack ID. - /// Specify the promotion stack parameters that you would like to update. (optional) + /// Specify the promotion stack parameters that you would like to update. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (PromotionsStacksUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdatePromotionStackWithHttpInfoAsync(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody = default(PromotionsStacksUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdatePromotionStackWithHttpInfoAsync(string campaignId, string stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -3543,6 +3573,12 @@ public Voucherify.Client.ApiResponse ListPromot throw new Voucherify.Client.ApiException(400, "Missing required parameter 'stackId' when calling PromotionsApi->UpdatePromotionStack"); } + // verify the required parameter 'promotionsStacksUpdateRequestBody' is set + if (promotionsStacksUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'promotionsStacksUpdateRequestBody' when calling PromotionsApi->UpdatePromotionStack"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -3621,10 +3657,10 @@ public Voucherify.Client.ApiResponse ListPromot /// /// Thrown when fails to make API call /// Unique promotion tier ID. - /// Specify the promotion tier parameters that you would like to update. (optional) + /// Specify the promotion tier parameters that you would like to update. /// Index associated with the operation. /// PromotionsTiersUpdateResponseBody - public PromotionsTiersUpdateResponseBody UpdatePromotionTier(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody = default(PromotionsTiersUpdateRequestBody), int operationIndex = 0) + public PromotionsTiersUpdateResponseBody UpdatePromotionTier(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdatePromotionTierWithHttpInfo(promotionTierId, promotionsTiersUpdateRequestBody); return localVarResponse.Data; @@ -3635,10 +3671,10 @@ public Voucherify.Client.ApiResponse ListPromot /// /// Thrown when fails to make API call /// Unique promotion tier ID. - /// Specify the promotion tier parameters that you would like to update. (optional) + /// Specify the promotion tier parameters that you would like to update. /// Index associated with the operation. /// ApiResponse of PromotionsTiersUpdateResponseBody - public Voucherify.Client.ApiResponse UpdatePromotionTierWithHttpInfo(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody = default(PromotionsTiersUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdatePromotionTierWithHttpInfo(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'promotionTierId' is set if (promotionTierId == null) @@ -3646,6 +3682,12 @@ public Voucherify.Client.ApiResponse ListPromot throw new Voucherify.Client.ApiException(400, "Missing required parameter 'promotionTierId' when calling PromotionsApi->UpdatePromotionTier"); } + // verify the required parameter 'promotionsTiersUpdateRequestBody' is set + if (promotionsTiersUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'promotionsTiersUpdateRequestBody' when calling PromotionsApi->UpdatePromotionTier"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -3722,11 +3764,11 @@ public Voucherify.Client.ApiResponse ListPromot /// /// Thrown when fails to make API call /// Unique promotion tier ID. - /// Specify the promotion tier parameters that you would like to update. (optional) + /// Specify the promotion tier parameters that you would like to update. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of PromotionsTiersUpdateResponseBody - public async System.Threading.Tasks.Task UpdatePromotionTierAsync(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody = default(PromotionsTiersUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdatePromotionTierAsync(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdatePromotionTierWithHttpInfoAsync(promotionTierId, promotionsTiersUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -3737,11 +3779,11 @@ public Voucherify.Client.ApiResponse ListPromot /// /// Thrown when fails to make API call /// Unique promotion tier ID. - /// Specify the promotion tier parameters that you would like to update. (optional) + /// Specify the promotion tier parameters that you would like to update. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (PromotionsTiersUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdatePromotionTierWithHttpInfoAsync(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody = default(PromotionsTiersUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdatePromotionTierWithHttpInfoAsync(string promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'promotionTierId' is set if (promotionTierId == null) @@ -3749,6 +3791,12 @@ public Voucherify.Client.ApiResponse ListPromot throw new Voucherify.Client.ApiException(400, "Missing required parameter 'promotionTierId' when calling PromotionsApi->UpdatePromotionTier"); } + // verify the required parameter 'promotionsTiersUpdateRequestBody' is set + if (promotionsTiersUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'promotionsTiersUpdateRequestBody' when calling PromotionsApi->UpdatePromotionTier"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/PublicationsApi.cs b/src/Voucherify/Api/PublicationsApi.cs index 6aa5ebae..5fe4f91e 100644 --- a/src/Voucherify/Api/PublicationsApi.cs +++ b/src/Voucherify/Api/PublicationsApi.cs @@ -35,11 +35,11 @@ public interface IPublicationsApiSync : IApiAccessor /// This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. /// /// Thrown when fails to make API call + /// Specify the publication parameters. /// Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - /// Specify the publication parameters. (optional) /// Index associated with the operation. /// PublicationsCreateResponseBody - PublicationsCreateResponseBody CreatePublication(bool? joinOnce = default(bool?), PublicationsCreateRequestBody publicationsCreateRequestBody = default(PublicationsCreateRequestBody), int operationIndex = 0); + PublicationsCreateResponseBody CreatePublication(PublicationsCreateRequestBody publicationsCreateRequestBody, bool? joinOnce = default(bool?), int operationIndex = 0); /// /// Create Publication @@ -48,11 +48,11 @@ public interface IPublicationsApiSync : IApiAccessor /// This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. /// /// Thrown when fails to make API call + /// Specify the publication parameters. /// Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - /// Specify the publication parameters. (optional) /// Index associated with the operation. /// ApiResponse of PublicationsCreateResponseBody - ApiResponse CreatePublicationWithHttpInfo(bool? joinOnce = default(bool?), PublicationsCreateRequestBody publicationsCreateRequestBody = default(PublicationsCreateRequestBody), int operationIndex = 0); + ApiResponse CreatePublicationWithHttpInfo(PublicationsCreateRequestBody publicationsCreateRequestBody, bool? joinOnce = default(bool?), int operationIndex = 0); /// /// Create Publication with GET /// @@ -145,12 +145,12 @@ public interface IPublicationsApiAsync : IApiAccessor /// This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. /// /// Thrown when fails to make API call + /// Specify the publication parameters. /// Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - /// Specify the publication parameters. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of PublicationsCreateResponseBody - System.Threading.Tasks.Task CreatePublicationAsync(bool? joinOnce = default(bool?), PublicationsCreateRequestBody publicationsCreateRequestBody = default(PublicationsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreatePublicationAsync(PublicationsCreateRequestBody publicationsCreateRequestBody, bool? joinOnce = default(bool?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Publication @@ -159,12 +159,12 @@ public interface IPublicationsApiAsync : IApiAccessor /// This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. /// /// Thrown when fails to make API call + /// Specify the publication parameters. /// Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - /// Specify the publication parameters. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (PublicationsCreateResponseBody) - System.Threading.Tasks.Task> CreatePublicationWithHttpInfoAsync(bool? joinOnce = default(bool?), PublicationsCreateRequestBody publicationsCreateRequestBody = default(PublicationsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreatePublicationWithHttpInfoAsync(PublicationsCreateRequestBody publicationsCreateRequestBody, bool? joinOnce = default(bool?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Publication with GET /// @@ -369,13 +369,13 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. /// /// Thrown when fails to make API call + /// Specify the publication parameters. /// Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - /// Specify the publication parameters. (optional) /// Index associated with the operation. /// PublicationsCreateResponseBody - public PublicationsCreateResponseBody CreatePublication(bool? joinOnce = default(bool?), PublicationsCreateRequestBody publicationsCreateRequestBody = default(PublicationsCreateRequestBody), int operationIndex = 0) + public PublicationsCreateResponseBody CreatePublication(PublicationsCreateRequestBody publicationsCreateRequestBody, bool? joinOnce = default(bool?), int operationIndex = 0) { - Voucherify.Client.ApiResponse localVarResponse = CreatePublicationWithHttpInfo(joinOnce, publicationsCreateRequestBody); + Voucherify.Client.ApiResponse localVarResponse = CreatePublicationWithHttpInfo(publicationsCreateRequestBody, joinOnce); return localVarResponse.Data; } @@ -383,12 +383,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. /// /// Thrown when fails to make API call + /// Specify the publication parameters. /// Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - /// Specify the publication parameters. (optional) /// Index associated with the operation. /// ApiResponse of PublicationsCreateResponseBody - public Voucherify.Client.ApiResponse CreatePublicationWithHttpInfo(bool? joinOnce = default(bool?), PublicationsCreateRequestBody publicationsCreateRequestBody = default(PublicationsCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreatePublicationWithHttpInfo(PublicationsCreateRequestBody publicationsCreateRequestBody, bool? joinOnce = default(bool?), int operationIndex = 0) { + // verify the required parameter 'publicationsCreateRequestBody' is set + if (publicationsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'publicationsCreateRequestBody' when calling PublicationsApi->CreatePublication"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -467,14 +473,14 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. /// /// Thrown when fails to make API call + /// Specify the publication parameters. /// Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - /// Specify the publication parameters. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of PublicationsCreateResponseBody - public async System.Threading.Tasks.Task CreatePublicationAsync(bool? joinOnce = default(bool?), PublicationsCreateRequestBody publicationsCreateRequestBody = default(PublicationsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreatePublicationAsync(PublicationsCreateRequestBody publicationsCreateRequestBody, bool? joinOnce = default(bool?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { - Voucherify.Client.ApiResponse localVarResponse = await CreatePublicationWithHttpInfoAsync(joinOnce, publicationsCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); + Voucherify.Client.ApiResponse localVarResponse = await CreatePublicationWithHttpInfoAsync(publicationsCreateRequestBody, joinOnce, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -482,13 +488,19 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Publication This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet. 🚧 Clearly define the source of the voucher You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code. 🚧 Publish multiple vouchers In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish. πŸ“˜ Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign. /// /// Thrown when fails to make API call + /// Specify the publication parameters. /// Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. (optional) - /// Specify the publication parameters. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (PublicationsCreateResponseBody) - public async System.Threading.Tasks.Task> CreatePublicationWithHttpInfoAsync(bool? joinOnce = default(bool?), PublicationsCreateRequestBody publicationsCreateRequestBody = default(PublicationsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreatePublicationWithHttpInfoAsync(PublicationsCreateRequestBody publicationsCreateRequestBody, bool? joinOnce = default(bool?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'publicationsCreateRequestBody' is set + if (publicationsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'publicationsCreateRequestBody' when calling PublicationsApi->CreatePublication"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/QualificationsApi.cs b/src/Voucherify/Api/QualificationsApi.cs index f44162c7..1a59f633 100644 --- a/src/Voucherify/Api/QualificationsApi.cs +++ b/src/Voucherify/Api/QualificationsApi.cs @@ -35,10 +35,10 @@ public interface IQualificationsApiSync : IApiAccessor /// 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// QualificationsCheckEligibilityResponseBody - QualificationsCheckEligibilityResponseBody CheckEligibility(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody = default(QualificationsCheckEligibilityRequestBody), int operationIndex = 0); + QualificationsCheckEligibilityResponseBody CheckEligibility(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody, int operationIndex = 0); /// /// Check Eligibility @@ -47,10 +47,10 @@ public interface IQualificationsApiSync : IApiAccessor /// 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// ApiResponse of QualificationsCheckEligibilityResponseBody - ApiResponse CheckEligibilityWithHttpInfo(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody = default(QualificationsCheckEligibilityRequestBody), int operationIndex = 0); + ApiResponse CheckEligibilityWithHttpInfo(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -67,11 +67,11 @@ public interface IQualificationsApiAsync : IApiAccessor /// 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of QualificationsCheckEligibilityResponseBody - System.Threading.Tasks.Task CheckEligibilityAsync(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody = default(QualificationsCheckEligibilityRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CheckEligibilityAsync(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Check Eligibility @@ -80,11 +80,11 @@ public interface IQualificationsApiAsync : IApiAccessor /// 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (QualificationsCheckEligibilityResponseBody) - System.Threading.Tasks.Task> CheckEligibilityWithHttpInfoAsync(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody = default(QualificationsCheckEligibilityRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CheckEligibilityWithHttpInfoAsync(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -209,10 +209,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// QualificationsCheckEligibilityResponseBody - public QualificationsCheckEligibilityResponseBody CheckEligibility(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody = default(QualificationsCheckEligibilityRequestBody), int operationIndex = 0) + public QualificationsCheckEligibilityResponseBody CheckEligibility(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CheckEligibilityWithHttpInfo(qualificationsCheckEligibilityRequestBody); return localVarResponse.Data; @@ -222,11 +222,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// ApiResponse of QualificationsCheckEligibilityResponseBody - public Voucherify.Client.ApiResponse CheckEligibilityWithHttpInfo(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody = default(QualificationsCheckEligibilityRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CheckEligibilityWithHttpInfo(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody, int operationIndex = 0) { + // verify the required parameter 'qualificationsCheckEligibilityRequestBody' is set + if (qualificationsCheckEligibilityRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'qualificationsCheckEligibilityRequestBody' when calling QualificationsApi->CheckEligibility"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -301,11 +307,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of QualificationsCheckEligibilityResponseBody - public async System.Threading.Tasks.Task CheckEligibilityAsync(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody = default(QualificationsCheckEligibilityRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CheckEligibilityAsync(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CheckEligibilityWithHttpInfoAsync(qualificationsCheckEligibilityRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -315,12 +321,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version πŸ‘ Scenario Guide Read [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables. /// /// Thrown when fails to make API call - /// Define order and customer context. (optional) + /// Define order and customer context. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (QualificationsCheckEligibilityResponseBody) - public async System.Threading.Tasks.Task> CheckEligibilityWithHttpInfoAsync(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody = default(QualificationsCheckEligibilityRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CheckEligibilityWithHttpInfoAsync(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'qualificationsCheckEligibilityRequestBody' is set + if (qualificationsCheckEligibilityRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'qualificationsCheckEligibilityRequestBody' when calling QualificationsApi->CheckEligibility"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/RedemptionsApi.cs b/src/Voucherify/Api/RedemptionsApi.cs index 61bb2214..d580d8ba 100644 --- a/src/Voucherify/Api/RedemptionsApi.cs +++ b/src/Voucherify/Api/RedemptionsApi.cs @@ -115,25 +115,25 @@ public interface IRedemptionsApiSync : IApiAccessor /// Redeem Stackable Discounts /// /// - /// # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + /// # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// RedemptionsRedeemResponseBody - RedemptionsRedeemResponseBody RedeemStackedDiscounts(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody = default(RedemptionsRedeemRequestBody), int operationIndex = 0); + RedemptionsRedeemResponseBody RedeemStackedDiscounts(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody, int operationIndex = 0); /// /// Redeem Stackable Discounts /// /// - /// # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + /// # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// ApiResponse of RedemptionsRedeemResponseBody - ApiResponse RedeemStackedDiscountsWithHttpInfo(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody = default(RedemptionsRedeemRequestBody), int operationIndex = 0); + ApiResponse RedeemStackedDiscountsWithHttpInfo(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody, int operationIndex = 0); /// /// Rollback Redemption /// @@ -142,12 +142,12 @@ public interface IRedemptionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The original redemption ID to be rolled back (undone). + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// RedemptionsRollbackCreateResponseBody - RedemptionsRollbackCreateResponseBody RollbackRedemption(string redemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody = default(RedemptionsRollbackCreateRequestBody), int operationIndex = 0); + RedemptionsRollbackCreateResponseBody RollbackRedemption(string redemptionId, RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0); /// /// Rollback Redemption @@ -157,12 +157,12 @@ public interface IRedemptionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The original redemption ID to be rolled back (undone). + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// ApiResponse of RedemptionsRollbackCreateResponseBody - ApiResponse RollbackRedemptionWithHttpInfo(string redemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody = default(RedemptionsRollbackCreateRequestBody), int operationIndex = 0); + ApiResponse RollbackRedemptionWithHttpInfo(string redemptionId, RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0); /// /// Rollback Stackable Redemptions /// @@ -171,12 +171,12 @@ public interface IRedemptionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// RedemptionsRollbacksCreateResponseBody - RedemptionsRollbacksCreateResponseBody RollbackStackedRedemptions(string parentRedemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody = default(RedemptionsRollbacksCreateRequestBody), int operationIndex = 0); + RedemptionsRollbacksCreateResponseBody RollbackStackedRedemptions(string parentRedemptionId, RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0); /// /// Rollback Stackable Redemptions @@ -186,12 +186,12 @@ public interface IRedemptionsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// ApiResponse of RedemptionsRollbacksCreateResponseBody - ApiResponse RollbackStackedRedemptionsWithHttpInfo(string parentRedemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody = default(RedemptionsRollbacksCreateRequestBody), int operationIndex = 0); + ApiResponse RollbackStackedRedemptionsWithHttpInfo(string parentRedemptionId, RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0); #endregion Synchronous Operations } @@ -294,27 +294,27 @@ public interface IRedemptionsApiAsync : IApiAccessor /// Redeem Stackable Discounts /// /// - /// # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + /// # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RedemptionsRedeemResponseBody - System.Threading.Tasks.Task RedeemStackedDiscountsAsync(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody = default(RedemptionsRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task RedeemStackedDiscountsAsync(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Redeem Stackable Discounts /// /// - /// # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + /// # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RedemptionsRedeemResponseBody) - System.Threading.Tasks.Task> RedeemStackedDiscountsWithHttpInfoAsync(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody = default(RedemptionsRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> RedeemStackedDiscountsWithHttpInfoAsync(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Rollback Redemption /// @@ -323,13 +323,13 @@ public interface IRedemptionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The original redemption ID to be rolled back (undone). + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RedemptionsRollbackCreateResponseBody - System.Threading.Tasks.Task RollbackRedemptionAsync(string redemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody = default(RedemptionsRollbackCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task RollbackRedemptionAsync(string redemptionId, RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Rollback Redemption @@ -339,13 +339,13 @@ public interface IRedemptionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The original redemption ID to be rolled back (undone). + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RedemptionsRollbackCreateResponseBody) - System.Threading.Tasks.Task> RollbackRedemptionWithHttpInfoAsync(string redemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody = default(RedemptionsRollbackCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> RollbackRedemptionWithHttpInfoAsync(string redemptionId, RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Rollback Stackable Redemptions /// @@ -354,13 +354,13 @@ public interface IRedemptionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RedemptionsRollbacksCreateResponseBody - System.Threading.Tasks.Task RollbackStackedRedemptionsAsync(string parentRedemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody = default(RedemptionsRollbacksCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task RollbackStackedRedemptionsAsync(string parentRedemptionId, RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Rollback Stackable Redemptions @@ -370,13 +370,13 @@ public interface IRedemptionsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RedemptionsRollbacksCreateResponseBody) - System.Threading.Tasks.Task> RollbackStackedRedemptionsWithHttpInfoAsync(string parentRedemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody = default(RedemptionsRollbacksCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> RollbackStackedRedemptionsWithHttpInfoAsync(string parentRedemptionId, RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -1267,27 +1267,33 @@ public Voucherify.Client.ApiResponse GetVouch } /// - /// Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + /// Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// RedemptionsRedeemResponseBody - public RedemptionsRedeemResponseBody RedeemStackedDiscounts(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody = default(RedemptionsRedeemRequestBody), int operationIndex = 0) + public RedemptionsRedeemResponseBody RedeemStackedDiscounts(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = RedeemStackedDiscountsWithHttpInfo(redemptionsRedeemRequestBody); return localVarResponse.Data; } /// - /// Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + /// Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// ApiResponse of RedemptionsRedeemResponseBody - public Voucherify.Client.ApiResponse RedeemStackedDiscountsWithHttpInfo(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody = default(RedemptionsRedeemRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse RedeemStackedDiscountsWithHttpInfo(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody, int operationIndex = 0) { + // verify the required parameter 'redemptionsRedeemRequestBody' is set + if (redemptionsRedeemRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'redemptionsRedeemRequestBody' when calling RedemptionsApi->RedeemStackedDiscounts"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1359,29 +1365,35 @@ public Voucherify.Client.ApiResponse GetVouch } /// - /// Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + /// Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RedemptionsRedeemResponseBody - public async System.Threading.Tasks.Task RedeemStackedDiscountsAsync(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody = default(RedemptionsRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task RedeemStackedDiscountsAsync(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await RedeemStackedDiscountsWithHttpInfoAsync(redemptionsRedeemRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } /// - /// Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. - Use X-Client-Application-Id as the application ID header. - Use X-Client-Token as the appliction secret key header. - Use client-side base URL. - Use an origin header for your custom domain. + /// Redeem Stackable Discounts # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts: API keys with a Merchant role cant use this endpoint. πŸ“˜ Rollbacks You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). πŸ“˜ Also available on client-side This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RedemptionsRedeemResponseBody) - public async System.Threading.Tasks.Task> RedeemStackedDiscountsWithHttpInfoAsync(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody = default(RedemptionsRedeemRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> RedeemStackedDiscountsWithHttpInfoAsync(RedemptionsRedeemRequestBody redemptionsRedeemRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'redemptionsRedeemRequestBody' is set + if (redemptionsRedeemRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'redemptionsRedeemRequestBody' when calling RedemptionsApi->RedeemStackedDiscounts"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -1458,14 +1470,14 @@ public Voucherify.Client.ApiResponse GetVouch /// /// Thrown when fails to make API call /// The original redemption ID to be rolled back (undone). + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// RedemptionsRollbackCreateResponseBody - public RedemptionsRollbackCreateResponseBody RollbackRedemption(string redemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody = default(RedemptionsRollbackCreateRequestBody), int operationIndex = 0) + public RedemptionsRollbackCreateResponseBody RollbackRedemption(string redemptionId, RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0) { - Voucherify.Client.ApiResponse localVarResponse = RollbackRedemptionWithHttpInfo(redemptionId, reason, trackingId, redemptionsRollbackCreateRequestBody); + Voucherify.Client.ApiResponse localVarResponse = RollbackRedemptionWithHttpInfo(redemptionId, redemptionsRollbackCreateRequestBody, reason, trackingId); return localVarResponse.Data; } @@ -1474,12 +1486,12 @@ public Voucherify.Client.ApiResponse GetVouch /// /// Thrown when fails to make API call /// The original redemption ID to be rolled back (undone). + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// ApiResponse of RedemptionsRollbackCreateResponseBody - public Voucherify.Client.ApiResponse RollbackRedemptionWithHttpInfo(string redemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody = default(RedemptionsRollbackCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse RollbackRedemptionWithHttpInfo(string redemptionId, RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0) { // verify the required parameter 'redemptionId' is set if (redemptionId == null) @@ -1487,6 +1499,12 @@ public Voucherify.Client.ApiResponse GetVouch throw new Voucherify.Client.ApiException(400, "Missing required parameter 'redemptionId' when calling RedemptionsApi->RollbackRedemption"); } + // verify the required parameter 'redemptionsRollbackCreateRequestBody' is set + if (redemptionsRollbackCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'redemptionsRollbackCreateRequestBody' when calling RedemptionsApi->RollbackRedemption"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1571,15 +1589,15 @@ public Voucherify.Client.ApiResponse GetVouch /// /// Thrown when fails to make API call /// The original redemption ID to be rolled back (undone). + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RedemptionsRollbackCreateResponseBody - public async System.Threading.Tasks.Task RollbackRedemptionAsync(string redemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody = default(RedemptionsRollbackCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task RollbackRedemptionAsync(string redemptionId, RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { - Voucherify.Client.ApiResponse localVarResponse = await RollbackRedemptionWithHttpInfoAsync(redemptionId, reason, trackingId, redemptionsRollbackCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); + Voucherify.Client.ApiResponse localVarResponse = await RollbackRedemptionWithHttpInfoAsync(redemptionId, redemptionsRollbackCreateRequestBody, reason, trackingId, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1588,13 +1606,13 @@ public Voucherify.Client.ApiResponse GetVouch /// /// Thrown when fails to make API call /// The original redemption ID to be rolled back (undone). + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RedemptionsRollbackCreateResponseBody) - public async System.Threading.Tasks.Task> RollbackRedemptionWithHttpInfoAsync(string redemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody = default(RedemptionsRollbackCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> RollbackRedemptionWithHttpInfoAsync(string redemptionId, RedemptionsRollbackCreateRequestBody redemptionsRollbackCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'redemptionId' is set if (redemptionId == null) @@ -1602,6 +1620,12 @@ public Voucherify.Client.ApiResponse GetVouch throw new Voucherify.Client.ApiException(400, "Missing required parameter 'redemptionId' when calling RedemptionsApi->RollbackRedemption"); } + // verify the required parameter 'redemptionsRollbackCreateRequestBody' is set + if (redemptionsRollbackCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'redemptionsRollbackCreateRequestBody' when calling RedemptionsApi->RollbackRedemption"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -1687,14 +1711,14 @@ public Voucherify.Client.ApiResponse GetVouch /// /// Thrown when fails to make API call /// Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// RedemptionsRollbacksCreateResponseBody - public RedemptionsRollbacksCreateResponseBody RollbackStackedRedemptions(string parentRedemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody = default(RedemptionsRollbacksCreateRequestBody), int operationIndex = 0) + public RedemptionsRollbacksCreateResponseBody RollbackStackedRedemptions(string parentRedemptionId, RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0) { - Voucherify.Client.ApiResponse localVarResponse = RollbackStackedRedemptionsWithHttpInfo(parentRedemptionId, reason, trackingId, redemptionsRollbacksCreateRequestBody); + Voucherify.Client.ApiResponse localVarResponse = RollbackStackedRedemptionsWithHttpInfo(parentRedemptionId, redemptionsRollbacksCreateRequestBody, reason, trackingId); return localVarResponse.Data; } @@ -1703,12 +1727,12 @@ public Voucherify.Client.ApiResponse GetVouch /// /// Thrown when fails to make API call /// Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// ApiResponse of RedemptionsRollbacksCreateResponseBody - public Voucherify.Client.ApiResponse RollbackStackedRedemptionsWithHttpInfo(string parentRedemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody = default(RedemptionsRollbacksCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse RollbackStackedRedemptionsWithHttpInfo(string parentRedemptionId, RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0) { // verify the required parameter 'parentRedemptionId' is set if (parentRedemptionId == null) @@ -1716,6 +1740,12 @@ public Voucherify.Client.ApiResponse GetVouch throw new Voucherify.Client.ApiException(400, "Missing required parameter 'parentRedemptionId' when calling RedemptionsApi->RollbackStackedRedemptions"); } + // verify the required parameter 'redemptionsRollbacksCreateRequestBody' is set + if (redemptionsRollbacksCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'redemptionsRollbacksCreateRequestBody' when calling RedemptionsApi->RollbackStackedRedemptions"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1800,15 +1830,15 @@ public Voucherify.Client.ApiResponse GetVouch /// /// Thrown when fails to make API call /// Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RedemptionsRollbacksCreateResponseBody - public async System.Threading.Tasks.Task RollbackStackedRedemptionsAsync(string parentRedemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody = default(RedemptionsRollbacksCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task RollbackStackedRedemptionsAsync(string parentRedemptionId, RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { - Voucherify.Client.ApiResponse localVarResponse = await RollbackStackedRedemptionsWithHttpInfoAsync(parentRedemptionId, reason, trackingId, redemptionsRollbacksCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); + Voucherify.Client.ApiResponse localVarResponse = await RollbackStackedRedemptionsWithHttpInfoAsync(parentRedemptionId, redemptionsRollbacksCreateRequestBody, reason, trackingId, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1817,13 +1847,13 @@ public Voucherify.Client.ApiResponse GetVouch /// /// Thrown when fails to make API call /// Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm. + /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. /// Reason for the rollback. (optional) /// Customers source_id. (optional) - /// Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RedemptionsRollbacksCreateResponseBody) - public async System.Threading.Tasks.Task> RollbackStackedRedemptionsWithHttpInfoAsync(string parentRedemptionId, string reason = default(string), string trackingId = default(string), RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody = default(RedemptionsRollbacksCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> RollbackStackedRedemptionsWithHttpInfoAsync(string parentRedemptionId, RedemptionsRollbacksCreateRequestBody redemptionsRollbacksCreateRequestBody, string reason = default(string), string trackingId = default(string), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'parentRedemptionId' is set if (parentRedemptionId == null) @@ -1831,6 +1861,12 @@ public Voucherify.Client.ApiResponse GetVouch throw new Voucherify.Client.ApiException(400, "Missing required parameter 'parentRedemptionId' when calling RedemptionsApi->RollbackStackedRedemptions"); } + // verify the required parameter 'redemptionsRollbacksCreateRequestBody' is set + if (redemptionsRollbacksCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'redemptionsRollbacksCreateRequestBody' when calling RedemptionsApi->RollbackStackedRedemptions"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/ReferralsApi.cs b/src/Voucherify/Api/ReferralsApi.cs index 12c04761..1c431c52 100644 --- a/src/Voucherify/Api/ReferralsApi.cs +++ b/src/Voucherify/Api/ReferralsApi.cs @@ -36,10 +36,10 @@ public interface IReferralsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// ReferralsMembersHoldersCreateInBulkResponseBody - ReferralsMembersHoldersCreateInBulkResponseBody ReferralsAddHolders(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0); + ReferralsMembersHoldersCreateInBulkResponseBody ReferralsAddHolders(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0); /// /// Add Referral Code Holders @@ -49,10 +49,10 @@ public interface IReferralsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody - ApiResponse ReferralsAddHoldersWithHttpInfo(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0); + ApiResponse ReferralsAddHoldersWithHttpInfo(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0); /// /// Add Referral Code Holders with Campaign ID /// @@ -62,10 +62,10 @@ public interface IReferralsApiSync : IApiAccessor /// Thrown when fails to make API call /// Unique identifier of a referral program campaign. /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// ReferralsMembersHoldersCreateInBulkResponseBody - ReferralsMembersHoldersCreateInBulkResponseBody ReferralsAddHolders1(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0); + ReferralsMembersHoldersCreateInBulkResponseBody ReferralsAddHolders1(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0); /// /// Add Referral Code Holders with Campaign ID @@ -76,10 +76,10 @@ public interface IReferralsApiSync : IApiAccessor /// Thrown when fails to make API call /// Unique identifier of a referral program campaign. /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody - ApiResponse ReferralsAddHolders1WithHttpInfo(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0); + ApiResponse ReferralsAddHolders1WithHttpInfo(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0); /// /// List Referral Code Holders with campaign ID /// @@ -213,11 +213,11 @@ public interface IReferralsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ReferralsMembersHoldersCreateInBulkResponseBody - System.Threading.Tasks.Task ReferralsAddHoldersAsync(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task ReferralsAddHoldersAsync(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Add Referral Code Holders @@ -227,11 +227,11 @@ public interface IReferralsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) - System.Threading.Tasks.Task> ReferralsAddHoldersWithHttpInfoAsync(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ReferralsAddHoldersWithHttpInfoAsync(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Add Referral Code Holders with Campaign ID /// @@ -241,11 +241,11 @@ public interface IReferralsApiAsync : IApiAccessor /// Thrown when fails to make API call /// Unique identifier of a referral program campaign. /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ReferralsMembersHoldersCreateInBulkResponseBody - System.Threading.Tasks.Task ReferralsAddHolders1Async(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task ReferralsAddHolders1Async(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Add Referral Code Holders with Campaign ID @@ -256,11 +256,11 @@ public interface IReferralsApiAsync : IApiAccessor /// Thrown when fails to make API call /// Unique identifier of a referral program campaign. /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) - System.Threading.Tasks.Task> ReferralsAddHolders1WithHttpInfoAsync(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ReferralsAddHolders1WithHttpInfoAsync(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// List Referral Code Holders with campaign ID /// @@ -510,10 +510,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// ReferralsMembersHoldersCreateInBulkResponseBody - public ReferralsMembersHoldersCreateInBulkResponseBody ReferralsAddHolders(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0) + public ReferralsMembersHoldersCreateInBulkResponseBody ReferralsAddHolders(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = ReferralsAddHoldersWithHttpInfo(memberId, referralsMembersHoldersCreateInBulkRequestBody); return localVarResponse.Data; @@ -524,10 +524,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody - public Voucherify.Client.ApiResponse ReferralsAddHoldersWithHttpInfo(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse ReferralsAddHoldersWithHttpInfo(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0) { // verify the required parameter 'memberId' is set if (memberId == null) @@ -535,6 +535,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling ReferralsApi->ReferralsAddHolders"); } + // verify the required parameter 'referralsMembersHoldersCreateInBulkRequestBody' is set + if (referralsMembersHoldersCreateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'referralsMembersHoldersCreateInBulkRequestBody' when calling ReferralsApi->ReferralsAddHolders"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -611,11 +617,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ReferralsMembersHoldersCreateInBulkResponseBody - public async System.Threading.Tasks.Task ReferralsAddHoldersAsync(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ReferralsAddHoldersAsync(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await ReferralsAddHoldersWithHttpInfoAsync(memberId, referralsMembersHoldersCreateInBulkRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -626,11 +632,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) - public async System.Threading.Tasks.Task> ReferralsAddHoldersWithHttpInfoAsync(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ReferralsAddHoldersWithHttpInfoAsync(string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'memberId' is set if (memberId == null) @@ -638,6 +644,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling ReferralsApi->ReferralsAddHolders"); } + // verify the required parameter 'referralsMembersHoldersCreateInBulkRequestBody' is set + if (referralsMembersHoldersCreateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'referralsMembersHoldersCreateInBulkRequestBody' when calling ReferralsApi->ReferralsAddHolders"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -716,10 +728,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Thrown when fails to make API call /// Unique identifier of a referral program campaign. /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// ReferralsMembersHoldersCreateInBulkResponseBody - public ReferralsMembersHoldersCreateInBulkResponseBody ReferralsAddHolders1(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0) + public ReferralsMembersHoldersCreateInBulkResponseBody ReferralsAddHolders1(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = ReferralsAddHolders1WithHttpInfo(campaignId, memberId, referralsMembersHoldersCreateInBulkRequestBody); return localVarResponse.Data; @@ -731,10 +743,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Thrown when fails to make API call /// Unique identifier of a referral program campaign. /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// ApiResponse of ReferralsMembersHoldersCreateInBulkResponseBody - public Voucherify.Client.ApiResponse ReferralsAddHolders1WithHttpInfo(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse ReferralsAddHolders1WithHttpInfo(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -748,6 +760,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling ReferralsApi->ReferralsAddHolders1"); } + // verify the required parameter 'referralsMembersHoldersCreateInBulkRequestBody' is set + if (referralsMembersHoldersCreateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'referralsMembersHoldersCreateInBulkRequestBody' when calling ReferralsApi->ReferralsAddHolders1"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -826,11 +844,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Thrown when fails to make API call /// Unique identifier of a referral program campaign. /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ReferralsMembersHoldersCreateInBulkResponseBody - public async System.Threading.Tasks.Task ReferralsAddHolders1Async(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ReferralsAddHolders1Async(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await ReferralsAddHolders1WithHttpInfoAsync(campaignId, memberId, referralsMembersHoldersCreateInBulkRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -842,11 +860,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Thrown when fails to make API call /// Unique identifier of a referral program campaign. /// Unique referral code or its identifier. - /// Specify the customer data to be upserted as redeemable holders. (optional) + /// Specify the customer data to be upserted as redeemable holders. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ReferralsMembersHoldersCreateInBulkResponseBody) - public async System.Threading.Tasks.Task> ReferralsAddHolders1WithHttpInfoAsync(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody = default(ReferralsMembersHoldersCreateInBulkRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ReferralsAddHolders1WithHttpInfoAsync(string campaignId, string memberId, ReferralsMembersHoldersCreateInBulkRequestBody referralsMembersHoldersCreateInBulkRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignId' is set if (campaignId == null) @@ -860,6 +878,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'memberId' when calling ReferralsApi->ReferralsAddHolders1"); } + // verify the required parameter 'referralsMembersHoldersCreateInBulkRequestBody' is set + if (referralsMembersHoldersCreateInBulkRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'referralsMembersHoldersCreateInBulkRequestBody' when calling ReferralsApi->ReferralsAddHolders1"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/RewardsApi.cs b/src/Voucherify/Api/RewardsApi.cs index 8476c93e..2f3967a9 100644 --- a/src/Voucherify/Api/RewardsApi.cs +++ b/src/Voucherify/Api/RewardsApi.cs @@ -35,10 +35,10 @@ public interface IRewardsApiSync : IApiAccessor /// Create a new reward. /// /// Thrown when fails to make API call - /// Define parameters of the new reward. (optional) + /// Define parameters of the new reward. /// Index associated with the operation. /// RewardsCreateResponseBody - RewardsCreateResponseBody CreateReward(RewardsCreateRequestBody rewardsCreateRequestBody = default(RewardsCreateRequestBody), int operationIndex = 0); + RewardsCreateResponseBody CreateReward(RewardsCreateRequestBody rewardsCreateRequestBody, int operationIndex = 0); /// /// Create Reward @@ -47,10 +47,10 @@ public interface IRewardsApiSync : IApiAccessor /// Create a new reward. /// /// Thrown when fails to make API call - /// Define parameters of the new reward. (optional) + /// Define parameters of the new reward. /// Index associated with the operation. /// ApiResponse of RewardsCreateResponseBody - ApiResponse CreateRewardWithHttpInfo(RewardsCreateRequestBody rewardsCreateRequestBody = default(RewardsCreateRequestBody), int operationIndex = 0); + ApiResponse CreateRewardWithHttpInfo(RewardsCreateRequestBody rewardsCreateRequestBody, int operationIndex = 0); /// /// Create Reward Assignment /// @@ -59,10 +59,10 @@ public interface IRewardsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A unique reward ID. - /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. /// Index associated with the operation. /// RewardsAssignmentsCreateResponseBody - RewardsAssignmentsCreateResponseBody CreateRewardAssignment(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody = default(RewardsAssignmentsCreateRequestBody), int operationIndex = 0); + RewardsAssignmentsCreateResponseBody CreateRewardAssignment(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody, int operationIndex = 0); /// /// Create Reward Assignment @@ -72,10 +72,10 @@ public interface IRewardsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A unique reward ID. - /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. /// Index associated with the operation. /// ApiResponse of RewardsAssignmentsCreateResponseBody - ApiResponse CreateRewardAssignmentWithHttpInfo(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody = default(RewardsAssignmentsCreateRequestBody), int operationIndex = 0); + ApiResponse CreateRewardAssignmentWithHttpInfo(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody, int operationIndex = 0); /// /// Delete Reward /// @@ -234,10 +234,10 @@ public interface IRewardsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A unique reward ID. - /// Define the parameters to be updated for the reward. (optional) + /// Define the parameters to be updated for the reward. /// Index associated with the operation. /// RewardsUpdateResponseBody - RewardsUpdateResponseBody UpdateReward(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody = default(RewardsUpdateRequestBody), int operationIndex = 0); + RewardsUpdateResponseBody UpdateReward(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody, int operationIndex = 0); /// /// Update Reward @@ -247,10 +247,10 @@ public interface IRewardsApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A unique reward ID. - /// Define the parameters to be updated for the reward. (optional) + /// Define the parameters to be updated for the reward. /// Index associated with the operation. /// ApiResponse of RewardsUpdateResponseBody - ApiResponse UpdateRewardWithHttpInfo(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody = default(RewardsUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateRewardWithHttpInfo(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody, int operationIndex = 0); /// /// Update Reward Assignment /// @@ -260,10 +260,10 @@ public interface IRewardsApiSync : IApiAccessor /// Thrown when fails to make API call /// A unique reward ID. /// A unique reward assignment ID. - /// Define the number of points required to exchange for the reward. (optional) + /// Define the number of points required to exchange for the reward. /// Index associated with the operation. /// RewardsAssignmentsUpdateResponseBody - RewardsAssignmentsUpdateResponseBody UpdateRewardAssignment(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody = default(RewardsAssignmentsUpdateRequestBody), int operationIndex = 0); + RewardsAssignmentsUpdateResponseBody UpdateRewardAssignment(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody, int operationIndex = 0); /// /// Update Reward Assignment @@ -274,10 +274,10 @@ public interface IRewardsApiSync : IApiAccessor /// Thrown when fails to make API call /// A unique reward ID. /// A unique reward assignment ID. - /// Define the number of points required to exchange for the reward. (optional) + /// Define the number of points required to exchange for the reward. /// Index associated with the operation. /// ApiResponse of RewardsAssignmentsUpdateResponseBody - ApiResponse UpdateRewardAssignmentWithHttpInfo(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody = default(RewardsAssignmentsUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateRewardAssignmentWithHttpInfo(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -294,11 +294,11 @@ public interface IRewardsApiAsync : IApiAccessor /// Create a new reward. /// /// Thrown when fails to make API call - /// Define parameters of the new reward. (optional) + /// Define parameters of the new reward. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RewardsCreateResponseBody - System.Threading.Tasks.Task CreateRewardAsync(RewardsCreateRequestBody rewardsCreateRequestBody = default(RewardsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateRewardAsync(RewardsCreateRequestBody rewardsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Reward @@ -307,11 +307,11 @@ public interface IRewardsApiAsync : IApiAccessor /// Create a new reward. /// /// Thrown when fails to make API call - /// Define parameters of the new reward. (optional) + /// Define parameters of the new reward. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RewardsCreateResponseBody) - System.Threading.Tasks.Task> CreateRewardWithHttpInfoAsync(RewardsCreateRequestBody rewardsCreateRequestBody = default(RewardsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateRewardWithHttpInfoAsync(RewardsCreateRequestBody rewardsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Reward Assignment /// @@ -320,11 +320,11 @@ public interface IRewardsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A unique reward ID. - /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RewardsAssignmentsCreateResponseBody - System.Threading.Tasks.Task CreateRewardAssignmentAsync(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody = default(RewardsAssignmentsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateRewardAssignmentAsync(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Reward Assignment @@ -334,11 +334,11 @@ public interface IRewardsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A unique reward ID. - /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RewardsAssignmentsCreateResponseBody) - System.Threading.Tasks.Task> CreateRewardAssignmentWithHttpInfoAsync(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody = default(RewardsAssignmentsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateRewardAssignmentWithHttpInfoAsync(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Reward /// @@ -509,11 +509,11 @@ public interface IRewardsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A unique reward ID. - /// Define the parameters to be updated for the reward. (optional) + /// Define the parameters to be updated for the reward. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RewardsUpdateResponseBody - System.Threading.Tasks.Task UpdateRewardAsync(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody = default(RewardsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateRewardAsync(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Reward @@ -523,11 +523,11 @@ public interface IRewardsApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A unique reward ID. - /// Define the parameters to be updated for the reward. (optional) + /// Define the parameters to be updated for the reward. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RewardsUpdateResponseBody) - System.Threading.Tasks.Task> UpdateRewardWithHttpInfoAsync(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody = default(RewardsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateRewardWithHttpInfoAsync(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Reward Assignment /// @@ -537,11 +537,11 @@ public interface IRewardsApiAsync : IApiAccessor /// Thrown when fails to make API call /// A unique reward ID. /// A unique reward assignment ID. - /// Define the number of points required to exchange for the reward. (optional) + /// Define the number of points required to exchange for the reward. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RewardsAssignmentsUpdateResponseBody - System.Threading.Tasks.Task UpdateRewardAssignmentAsync(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody = default(RewardsAssignmentsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateRewardAssignmentAsync(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Reward Assignment @@ -552,11 +552,11 @@ public interface IRewardsApiAsync : IApiAccessor /// Thrown when fails to make API call /// A unique reward ID. /// A unique reward assignment ID. - /// Define the number of points required to exchange for the reward. (optional) + /// Define the number of points required to exchange for the reward. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RewardsAssignmentsUpdateResponseBody) - System.Threading.Tasks.Task> UpdateRewardAssignmentWithHttpInfoAsync(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody = default(RewardsAssignmentsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateRewardAssignmentWithHttpInfoAsync(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -681,10 +681,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Reward Create a new reward. /// /// Thrown when fails to make API call - /// Define parameters of the new reward. (optional) + /// Define parameters of the new reward. /// Index associated with the operation. /// RewardsCreateResponseBody - public RewardsCreateResponseBody CreateReward(RewardsCreateRequestBody rewardsCreateRequestBody = default(RewardsCreateRequestBody), int operationIndex = 0) + public RewardsCreateResponseBody CreateReward(RewardsCreateRequestBody rewardsCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateRewardWithHttpInfo(rewardsCreateRequestBody); return localVarResponse.Data; @@ -694,11 +694,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Reward Create a new reward. /// /// Thrown when fails to make API call - /// Define parameters of the new reward. (optional) + /// Define parameters of the new reward. /// Index associated with the operation. /// ApiResponse of RewardsCreateResponseBody - public Voucherify.Client.ApiResponse CreateRewardWithHttpInfo(RewardsCreateRequestBody rewardsCreateRequestBody = default(RewardsCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateRewardWithHttpInfo(RewardsCreateRequestBody rewardsCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'rewardsCreateRequestBody' is set + if (rewardsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'rewardsCreateRequestBody' when calling RewardsApi->CreateReward"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -773,11 +779,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Reward Create a new reward. /// /// Thrown when fails to make API call - /// Define parameters of the new reward. (optional) + /// Define parameters of the new reward. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RewardsCreateResponseBody - public async System.Threading.Tasks.Task CreateRewardAsync(RewardsCreateRequestBody rewardsCreateRequestBody = default(RewardsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateRewardAsync(RewardsCreateRequestBody rewardsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateRewardWithHttpInfoAsync(rewardsCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -787,12 +793,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Reward Create a new reward. /// /// Thrown when fails to make API call - /// Define parameters of the new reward. (optional) + /// Define parameters of the new reward. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RewardsCreateResponseBody) - public async System.Threading.Tasks.Task> CreateRewardWithHttpInfoAsync(RewardsCreateRequestBody rewardsCreateRequestBody = default(RewardsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateRewardWithHttpInfoAsync(RewardsCreateRequestBody rewardsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'rewardsCreateRequestBody' is set + if (rewardsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'rewardsCreateRequestBody' when calling RewardsApi->CreateReward"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -869,10 +881,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// A unique reward ID. - /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. /// Index associated with the operation. /// RewardsAssignmentsCreateResponseBody - public RewardsAssignmentsCreateResponseBody CreateRewardAssignment(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody = default(RewardsAssignmentsCreateRequestBody), int operationIndex = 0) + public RewardsAssignmentsCreateResponseBody CreateRewardAssignment(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateRewardAssignmentWithHttpInfo(rewardId, rewardsAssignmentsCreateRequestBody); return localVarResponse.Data; @@ -883,10 +895,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// A unique reward ID. - /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. /// Index associated with the operation. /// ApiResponse of RewardsAssignmentsCreateResponseBody - public Voucherify.Client.ApiResponse CreateRewardAssignmentWithHttpInfo(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody = default(RewardsAssignmentsCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateRewardAssignmentWithHttpInfo(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'rewardId' is set if (rewardId == null) @@ -894,6 +906,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'rewardId' when calling RewardsApi->CreateRewardAssignment"); } + // verify the required parameter 'rewardsAssignmentsCreateRequestBody' is set + if (rewardsAssignmentsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'rewardsAssignmentsCreateRequestBody' when calling RewardsApi->CreateRewardAssignment"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -970,11 +988,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// A unique reward ID. - /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RewardsAssignmentsCreateResponseBody - public async System.Threading.Tasks.Task CreateRewardAssignmentAsync(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody = default(RewardsAssignmentsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateRewardAssignmentAsync(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateRewardAssignmentWithHttpInfoAsync(rewardId, rewardsAssignmentsCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -985,11 +1003,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// A unique reward ID. - /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. (optional) + /// Provide the campaign ID of the campaign to which the reward is to be assigned and define the cost of the reward in terms of loyalty points. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RewardsAssignmentsCreateResponseBody) - public async System.Threading.Tasks.Task> CreateRewardAssignmentWithHttpInfoAsync(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody = default(RewardsAssignmentsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateRewardAssignmentWithHttpInfoAsync(string rewardId, RewardsAssignmentsCreateRequestBody rewardsAssignmentsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'rewardId' is set if (rewardId == null) @@ -997,6 +1015,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'rewardId' when calling RewardsApi->CreateRewardAssignment"); } + // verify the required parameter 'rewardsAssignmentsCreateRequestBody' is set + if (rewardsAssignmentsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'rewardsAssignmentsCreateRequestBody' when calling RewardsApi->CreateRewardAssignment"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2326,10 +2350,10 @@ public Voucherify.Client.ApiResponse GetRewar /// /// Thrown when fails to make API call /// A unique reward ID. - /// Define the parameters to be updated for the reward. (optional) + /// Define the parameters to be updated for the reward. /// Index associated with the operation. /// RewardsUpdateResponseBody - public RewardsUpdateResponseBody UpdateReward(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody = default(RewardsUpdateRequestBody), int operationIndex = 0) + public RewardsUpdateResponseBody UpdateReward(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateRewardWithHttpInfo(rewardId, rewardsUpdateRequestBody); return localVarResponse.Data; @@ -2340,10 +2364,10 @@ public Voucherify.Client.ApiResponse GetRewar /// /// Thrown when fails to make API call /// A unique reward ID. - /// Define the parameters to be updated for the reward. (optional) + /// Define the parameters to be updated for the reward. /// Index associated with the operation. /// ApiResponse of RewardsUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateRewardWithHttpInfo(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody = default(RewardsUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateRewardWithHttpInfo(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'rewardId' is set if (rewardId == null) @@ -2351,6 +2375,12 @@ public Voucherify.Client.ApiResponse GetRewar throw new Voucherify.Client.ApiException(400, "Missing required parameter 'rewardId' when calling RewardsApi->UpdateReward"); } + // verify the required parameter 'rewardsUpdateRequestBody' is set + if (rewardsUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'rewardsUpdateRequestBody' when calling RewardsApi->UpdateReward"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -2427,11 +2457,11 @@ public Voucherify.Client.ApiResponse GetRewar /// /// Thrown when fails to make API call /// A unique reward ID. - /// Define the parameters to be updated for the reward. (optional) + /// Define the parameters to be updated for the reward. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RewardsUpdateResponseBody - public async System.Threading.Tasks.Task UpdateRewardAsync(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody = default(RewardsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateRewardAsync(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateRewardWithHttpInfoAsync(rewardId, rewardsUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -2442,11 +2472,11 @@ public Voucherify.Client.ApiResponse GetRewar /// /// Thrown when fails to make API call /// A unique reward ID. - /// Define the parameters to be updated for the reward. (optional) + /// Define the parameters to be updated for the reward. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RewardsUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateRewardWithHttpInfoAsync(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody = default(RewardsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateRewardWithHttpInfoAsync(string rewardId, RewardsUpdateRequestBody rewardsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'rewardId' is set if (rewardId == null) @@ -2454,6 +2484,12 @@ public Voucherify.Client.ApiResponse GetRewar throw new Voucherify.Client.ApiException(400, "Missing required parameter 'rewardId' when calling RewardsApi->UpdateReward"); } + // verify the required parameter 'rewardsUpdateRequestBody' is set + if (rewardsUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'rewardsUpdateRequestBody' when calling RewardsApi->UpdateReward"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2532,10 +2568,10 @@ public Voucherify.Client.ApiResponse GetRewar /// Thrown when fails to make API call /// A unique reward ID. /// A unique reward assignment ID. - /// Define the number of points required to exchange for the reward. (optional) + /// Define the number of points required to exchange for the reward. /// Index associated with the operation. /// RewardsAssignmentsUpdateResponseBody - public RewardsAssignmentsUpdateResponseBody UpdateRewardAssignment(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody = default(RewardsAssignmentsUpdateRequestBody), int operationIndex = 0) + public RewardsAssignmentsUpdateResponseBody UpdateRewardAssignment(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateRewardAssignmentWithHttpInfo(rewardId, assignmentId, rewardsAssignmentsUpdateRequestBody); return localVarResponse.Data; @@ -2547,10 +2583,10 @@ public Voucherify.Client.ApiResponse GetRewar /// Thrown when fails to make API call /// A unique reward ID. /// A unique reward assignment ID. - /// Define the number of points required to exchange for the reward. (optional) + /// Define the number of points required to exchange for the reward. /// Index associated with the operation. /// ApiResponse of RewardsAssignmentsUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateRewardAssignmentWithHttpInfo(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody = default(RewardsAssignmentsUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateRewardAssignmentWithHttpInfo(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'rewardId' is set if (rewardId == null) @@ -2564,6 +2600,12 @@ public Voucherify.Client.ApiResponse GetRewar throw new Voucherify.Client.ApiException(400, "Missing required parameter 'assignmentId' when calling RewardsApi->UpdateRewardAssignment"); } + // verify the required parameter 'rewardsAssignmentsUpdateRequestBody' is set + if (rewardsAssignmentsUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'rewardsAssignmentsUpdateRequestBody' when calling RewardsApi->UpdateRewardAssignment"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -2642,11 +2684,11 @@ public Voucherify.Client.ApiResponse GetRewar /// Thrown when fails to make API call /// A unique reward ID. /// A unique reward assignment ID. - /// Define the number of points required to exchange for the reward. (optional) + /// Define the number of points required to exchange for the reward. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of RewardsAssignmentsUpdateResponseBody - public async System.Threading.Tasks.Task UpdateRewardAssignmentAsync(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody = default(RewardsAssignmentsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateRewardAssignmentAsync(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateRewardAssignmentWithHttpInfoAsync(rewardId, assignmentId, rewardsAssignmentsUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -2658,11 +2700,11 @@ public Voucherify.Client.ApiResponse GetRewar /// Thrown when fails to make API call /// A unique reward ID. /// A unique reward assignment ID. - /// Define the number of points required to exchange for the reward. (optional) + /// Define the number of points required to exchange for the reward. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (RewardsAssignmentsUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateRewardAssignmentWithHttpInfoAsync(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody = default(RewardsAssignmentsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateRewardAssignmentWithHttpInfoAsync(string rewardId, string assignmentId, RewardsAssignmentsUpdateRequestBody rewardsAssignmentsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'rewardId' is set if (rewardId == null) @@ -2676,6 +2718,12 @@ public Voucherify.Client.ApiResponse GetRewar throw new Voucherify.Client.ApiException(400, "Missing required parameter 'assignmentId' when calling RewardsApi->UpdateRewardAssignment"); } + // verify the required parameter 'rewardsAssignmentsUpdateRequestBody' is set + if (rewardsAssignmentsUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'rewardsAssignmentsUpdateRequestBody' when calling RewardsApi->UpdateRewardAssignment"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/SegmentsApi.cs b/src/Voucherify/Api/SegmentsApi.cs index b2a5b547..0cbca830 100644 --- a/src/Voucherify/Api/SegmentsApi.cs +++ b/src/Voucherify/Api/SegmentsApi.cs @@ -35,10 +35,10 @@ public interface ISegmentsApiSync : IApiAccessor /// Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. /// /// Thrown when fails to make API call - /// Specify the boundary conditions for the customer segment. (optional) + /// Specify the boundary conditions for the customer segment. /// Index associated with the operation. /// SegmentsCreateResponseBody - SegmentsCreateResponseBody CreateSegment(SegmentsCreateRequestBody segmentsCreateRequestBody = default(SegmentsCreateRequestBody), int operationIndex = 0); + SegmentsCreateResponseBody CreateSegment(SegmentsCreateRequestBody segmentsCreateRequestBody, int operationIndex = 0); /// /// Create Segment @@ -47,10 +47,10 @@ public interface ISegmentsApiSync : IApiAccessor /// Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. /// /// Thrown when fails to make API call - /// Specify the boundary conditions for the customer segment. (optional) + /// Specify the boundary conditions for the customer segment. /// Index associated with the operation. /// ApiResponse of SegmentsCreateResponseBody - ApiResponse CreateSegmentWithHttpInfo(SegmentsCreateRequestBody segmentsCreateRequestBody = default(SegmentsCreateRequestBody), int operationIndex = 0); + ApiResponse CreateSegmentWithHttpInfo(SegmentsCreateRequestBody segmentsCreateRequestBody, int operationIndex = 0); /// /// Delete Segment /// @@ -113,11 +113,11 @@ public interface ISegmentsApiAsync : IApiAccessor /// Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. /// /// Thrown when fails to make API call - /// Specify the boundary conditions for the customer segment. (optional) + /// Specify the boundary conditions for the customer segment. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of SegmentsCreateResponseBody - System.Threading.Tasks.Task CreateSegmentAsync(SegmentsCreateRequestBody segmentsCreateRequestBody = default(SegmentsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateSegmentAsync(SegmentsCreateRequestBody segmentsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Segment @@ -126,11 +126,11 @@ public interface ISegmentsApiAsync : IApiAccessor /// Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. /// /// Thrown when fails to make API call - /// Specify the boundary conditions for the customer segment. (optional) + /// Specify the boundary conditions for the customer segment. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (SegmentsCreateResponseBody) - System.Threading.Tasks.Task> CreateSegmentWithHttpInfoAsync(SegmentsCreateRequestBody segmentsCreateRequestBody = default(SegmentsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateSegmentWithHttpInfoAsync(SegmentsCreateRequestBody segmentsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Segment /// @@ -305,10 +305,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. /// /// Thrown when fails to make API call - /// Specify the boundary conditions for the customer segment. (optional) + /// Specify the boundary conditions for the customer segment. /// Index associated with the operation. /// SegmentsCreateResponseBody - public SegmentsCreateResponseBody CreateSegment(SegmentsCreateRequestBody segmentsCreateRequestBody = default(SegmentsCreateRequestBody), int operationIndex = 0) + public SegmentsCreateResponseBody CreateSegment(SegmentsCreateRequestBody segmentsCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateSegmentWithHttpInfo(segmentsCreateRequestBody); return localVarResponse.Data; @@ -318,11 +318,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. /// /// Thrown when fails to make API call - /// Specify the boundary conditions for the customer segment. (optional) + /// Specify the boundary conditions for the customer segment. /// Index associated with the operation. /// ApiResponse of SegmentsCreateResponseBody - public Voucherify.Client.ApiResponse CreateSegmentWithHttpInfo(SegmentsCreateRequestBody segmentsCreateRequestBody = default(SegmentsCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateSegmentWithHttpInfo(SegmentsCreateRequestBody segmentsCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'segmentsCreateRequestBody' is set + if (segmentsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'segmentsCreateRequestBody' when calling SegmentsApi->CreateSegment"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -397,11 +403,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. /// /// Thrown when fails to make API call - /// Specify the boundary conditions for the customer segment. (optional) + /// Specify the boundary conditions for the customer segment. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of SegmentsCreateResponseBody - public async System.Threading.Tasks.Task CreateSegmentAsync(SegmentsCreateRequestBody segmentsCreateRequestBody = default(SegmentsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateSegmentAsync(SegmentsCreateRequestBody segmentsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateSegmentWithHttpInfoAsync(segmentsCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -411,12 +417,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Segment Create a customer segment. 🚧 Limit on static segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. 🚧 Limit on Active and Passive segments You can create a maximum of 100 passive and active segments. /// /// Thrown when fails to make API call - /// Specify the boundary conditions for the customer segment. (optional) + /// Specify the boundary conditions for the customer segment. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (SegmentsCreateResponseBody) - public async System.Threading.Tasks.Task> CreateSegmentWithHttpInfoAsync(SegmentsCreateRequestBody segmentsCreateRequestBody = default(SegmentsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateSegmentWithHttpInfoAsync(SegmentsCreateRequestBody segmentsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'segmentsCreateRequestBody' is set + if (segmentsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'segmentsCreateRequestBody' when calling SegmentsApi->CreateSegment"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/TemplatesApi.cs b/src/Voucherify/Api/TemplatesApi.cs index d50dace4..7e47120f 100644 --- a/src/Voucherify/Api/TemplatesApi.cs +++ b/src/Voucherify/Api/TemplatesApi.cs @@ -36,10 +36,10 @@ public interface ITemplatesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// TemplatesCampaignsTierSetupCreateResponseBody - TemplatesCampaignsTierSetupCreateResponseBody AddTierFromTemplate(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody = default(TemplatesCampaignsTierSetupCreateRequestBody), int operationIndex = 0); + TemplatesCampaignsTierSetupCreateResponseBody AddTierFromTemplate(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody, int operationIndex = 0); /// /// Add Promotion Tier From Template @@ -49,10 +49,10 @@ public interface ITemplatesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// ApiResponse of TemplatesCampaignsTierSetupCreateResponseBody - ApiResponse AddTierFromTemplateWithHttpInfo(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody = default(TemplatesCampaignsTierSetupCreateRequestBody), int operationIndex = 0); + ApiResponse AddTierFromTemplateWithHttpInfo(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody, int operationIndex = 0); /// /// Create Campaign From Template /// @@ -61,10 +61,10 @@ public interface ITemplatesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name is required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name is required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// TemplatesCampaignsCampaignSetupCreateResponseBody - TemplatesCampaignsCampaignSetupCreateResponseBody CreateCampaignFromTemplate(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody = default(TemplatesCampaignsCampaignSetupCreateRequestBody), int operationIndex = 0); + TemplatesCampaignsCampaignSetupCreateResponseBody CreateCampaignFromTemplate(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody, int operationIndex = 0); /// /// Create Campaign From Template @@ -74,10 +74,10 @@ public interface ITemplatesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name is required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name is required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// ApiResponse of TemplatesCampaignsCampaignSetupCreateResponseBody - ApiResponse CreateCampaignFromTemplateWithHttpInfo(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody = default(TemplatesCampaignsCampaignSetupCreateRequestBody), int operationIndex = 0); + ApiResponse CreateCampaignFromTemplateWithHttpInfo(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody, int operationIndex = 0); /// /// Create Campaign Template /// @@ -85,10 +85,10 @@ public interface ITemplatesApiSync : IApiAccessor /// Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. /// /// Thrown when fails to make API call - /// Provide details for a campaign template (optional) + /// Provide details for a campaign template /// Index associated with the operation. /// TemplatesCampaignsCreateTemplateResponseBody - TemplatesCampaignsCreateTemplateResponseBody CreateCampaignTemplate(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody = default(TemplatesCampaignsCreateRequestBody), int operationIndex = 0); + TemplatesCampaignsCreateTemplateResponseBody CreateCampaignTemplate(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody, int operationIndex = 0); /// /// Create Campaign Template @@ -97,10 +97,10 @@ public interface ITemplatesApiSync : IApiAccessor /// Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. /// /// Thrown when fails to make API call - /// Provide details for a campaign template (optional) + /// Provide details for a campaign template /// Index associated with the operation. /// ApiResponse of TemplatesCampaignsCreateTemplateResponseBody - ApiResponse CreateCampaignTemplateWithHttpInfo(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody = default(TemplatesCampaignsCreateRequestBody), int operationIndex = 0); + ApiResponse CreateCampaignTemplateWithHttpInfo(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody, int operationIndex = 0); /// /// Delete Campaign Template /// @@ -186,10 +186,10 @@ public interface ITemplatesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Provide the new name or description for the campaign template (optional) + /// Provide the new name or description for the campaign template /// Index associated with the operation. /// TemplatesCampaignsUpdateResponseBody - TemplatesCampaignsUpdateResponseBody UpdateCampaignTemplate(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody = default(TemplatesCampaignsUpdateRequestBody), int operationIndex = 0); + TemplatesCampaignsUpdateResponseBody UpdateCampaignTemplate(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody, int operationIndex = 0); /// /// Update Campaign Template @@ -199,10 +199,10 @@ public interface ITemplatesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Provide the new name or description for the campaign template (optional) + /// Provide the new name or description for the campaign template /// Index associated with the operation. /// ApiResponse of TemplatesCampaignsUpdateResponseBody - ApiResponse UpdateCampaignTemplateWithHttpInfo(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody = default(TemplatesCampaignsUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateCampaignTemplateWithHttpInfo(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -220,11 +220,11 @@ public interface ITemplatesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of TemplatesCampaignsTierSetupCreateResponseBody - System.Threading.Tasks.Task AddTierFromTemplateAsync(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody = default(TemplatesCampaignsTierSetupCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task AddTierFromTemplateAsync(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Add Promotion Tier From Template @@ -234,11 +234,11 @@ public interface ITemplatesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (TemplatesCampaignsTierSetupCreateResponseBody) - System.Threading.Tasks.Task> AddTierFromTemplateWithHttpInfoAsync(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody = default(TemplatesCampaignsTierSetupCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> AddTierFromTemplateWithHttpInfoAsync(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Campaign From Template /// @@ -247,11 +247,11 @@ public interface ITemplatesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name is required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name is required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of TemplatesCampaignsCampaignSetupCreateResponseBody - System.Threading.Tasks.Task CreateCampaignFromTemplateAsync(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody = default(TemplatesCampaignsCampaignSetupCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateCampaignFromTemplateAsync(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Campaign From Template @@ -261,11 +261,11 @@ public interface ITemplatesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name is required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name is required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (TemplatesCampaignsCampaignSetupCreateResponseBody) - System.Threading.Tasks.Task> CreateCampaignFromTemplateWithHttpInfoAsync(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody = default(TemplatesCampaignsCampaignSetupCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateCampaignFromTemplateWithHttpInfoAsync(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Campaign Template /// @@ -273,11 +273,11 @@ public interface ITemplatesApiAsync : IApiAccessor /// Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. /// /// Thrown when fails to make API call - /// Provide details for a campaign template (optional) + /// Provide details for a campaign template /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of TemplatesCampaignsCreateTemplateResponseBody - System.Threading.Tasks.Task CreateCampaignTemplateAsync(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody = default(TemplatesCampaignsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateCampaignTemplateAsync(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Campaign Template @@ -286,11 +286,11 @@ public interface ITemplatesApiAsync : IApiAccessor /// Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. /// /// Thrown when fails to make API call - /// Provide details for a campaign template (optional) + /// Provide details for a campaign template /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (TemplatesCampaignsCreateTemplateResponseBody) - System.Threading.Tasks.Task> CreateCampaignTemplateWithHttpInfoAsync(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody = default(TemplatesCampaignsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateCampaignTemplateWithHttpInfoAsync(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Campaign Template /// @@ -382,11 +382,11 @@ public interface ITemplatesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Provide the new name or description for the campaign template (optional) + /// Provide the new name or description for the campaign template /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of TemplatesCampaignsUpdateResponseBody - System.Threading.Tasks.Task UpdateCampaignTemplateAsync(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody = default(TemplatesCampaignsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateCampaignTemplateAsync(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Campaign Template @@ -396,11 +396,11 @@ public interface ITemplatesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Provide the new name or description for the campaign template (optional) + /// Provide the new name or description for the campaign template /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (TemplatesCampaignsUpdateResponseBody) - System.Threading.Tasks.Task> UpdateCampaignTemplateWithHttpInfoAsync(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody = default(TemplatesCampaignsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateCampaignTemplateWithHttpInfoAsync(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -526,10 +526,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// TemplatesCampaignsTierSetupCreateResponseBody - public TemplatesCampaignsTierSetupCreateResponseBody AddTierFromTemplate(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody = default(TemplatesCampaignsTierSetupCreateRequestBody), int operationIndex = 0) + public TemplatesCampaignsTierSetupCreateResponseBody AddTierFromTemplate(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = AddTierFromTemplateWithHttpInfo(campaignTemplateId, templatesCampaignsTierSetupCreateRequestBody); return localVarResponse.Data; @@ -540,10 +540,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// ApiResponse of TemplatesCampaignsTierSetupCreateResponseBody - public Voucherify.Client.ApiResponse AddTierFromTemplateWithHttpInfo(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody = default(TemplatesCampaignsTierSetupCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse AddTierFromTemplateWithHttpInfo(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignTemplateId' is set if (campaignTemplateId == null) @@ -551,6 +551,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignTemplateId' when calling TemplatesApi->AddTierFromTemplate"); } + // verify the required parameter 'templatesCampaignsTierSetupCreateRequestBody' is set + if (templatesCampaignsTierSetupCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'templatesCampaignsTierSetupCreateRequestBody' when calling TemplatesApi->AddTierFromTemplate"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -627,11 +633,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of TemplatesCampaignsTierSetupCreateResponseBody - public async System.Threading.Tasks.Task AddTierFromTemplateAsync(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody = default(TemplatesCampaignsTierSetupCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task AddTierFromTemplateAsync(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await AddTierFromTemplateWithHttpInfoAsync(campaignTemplateId, templatesCampaignsTierSetupCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -642,11 +648,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (TemplatesCampaignsTierSetupCreateResponseBody) - public async System.Threading.Tasks.Task> AddTierFromTemplateWithHttpInfoAsync(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody = default(TemplatesCampaignsTierSetupCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> AddTierFromTemplateWithHttpInfoAsync(string campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignTemplateId' is set if (campaignTemplateId == null) @@ -654,6 +660,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignTemplateId' when calling TemplatesApi->AddTierFromTemplate"); } + // verify the required parameter 'templatesCampaignsTierSetupCreateRequestBody' is set + if (templatesCampaignsTierSetupCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'templatesCampaignsTierSetupCreateRequestBody' when calling TemplatesApi->AddTierFromTemplate"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -731,10 +743,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name is required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name is required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// TemplatesCampaignsCampaignSetupCreateResponseBody - public TemplatesCampaignsCampaignSetupCreateResponseBody CreateCampaignFromTemplate(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody = default(TemplatesCampaignsCampaignSetupCreateRequestBody), int operationIndex = 0) + public TemplatesCampaignsCampaignSetupCreateResponseBody CreateCampaignFromTemplate(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateCampaignFromTemplateWithHttpInfo(campaignTemplateId, templatesCampaignsCampaignSetupCreateRequestBody); return localVarResponse.Data; @@ -745,10 +757,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name is required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name is required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// ApiResponse of TemplatesCampaignsCampaignSetupCreateResponseBody - public Voucherify.Client.ApiResponse CreateCampaignFromTemplateWithHttpInfo(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody = default(TemplatesCampaignsCampaignSetupCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateCampaignFromTemplateWithHttpInfo(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignTemplateId' is set if (campaignTemplateId == null) @@ -756,6 +768,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignTemplateId' when calling TemplatesApi->CreateCampaignFromTemplate"); } + // verify the required parameter 'templatesCampaignsCampaignSetupCreateRequestBody' is set + if (templatesCampaignsCampaignSetupCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'templatesCampaignsCampaignSetupCreateRequestBody' when calling TemplatesApi->CreateCampaignFromTemplate"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -832,11 +850,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name is required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name is required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of TemplatesCampaignsCampaignSetupCreateResponseBody - public async System.Threading.Tasks.Task CreateCampaignFromTemplateAsync(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody = default(TemplatesCampaignsCampaignSetupCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateCampaignFromTemplateAsync(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateCampaignFromTemplateWithHttpInfoAsync(campaignTemplateId, templatesCampaignsCampaignSetupCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -847,11 +865,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Only name is required. The rest of the fields will overwrite the template configuration. (optional) + /// Only name is required. The rest of the fields will overwrite the template configuration. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (TemplatesCampaignsCampaignSetupCreateResponseBody) - public async System.Threading.Tasks.Task> CreateCampaignFromTemplateWithHttpInfoAsync(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody = default(TemplatesCampaignsCampaignSetupCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateCampaignFromTemplateWithHttpInfoAsync(string campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignTemplateId' is set if (campaignTemplateId == null) @@ -859,6 +877,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignTemplateId' when calling TemplatesApi->CreateCampaignFromTemplate"); } + // verify the required parameter 'templatesCampaignsCampaignSetupCreateRequestBody' is set + if (templatesCampaignsCampaignSetupCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'templatesCampaignsCampaignSetupCreateRequestBody' when calling TemplatesApi->CreateCampaignFromTemplate"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -935,10 +959,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. /// /// Thrown when fails to make API call - /// Provide details for a campaign template (optional) + /// Provide details for a campaign template /// Index associated with the operation. /// TemplatesCampaignsCreateTemplateResponseBody - public TemplatesCampaignsCreateTemplateResponseBody CreateCampaignTemplate(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody = default(TemplatesCampaignsCreateRequestBody), int operationIndex = 0) + public TemplatesCampaignsCreateTemplateResponseBody CreateCampaignTemplate(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateCampaignTemplateWithHttpInfo(templatesCampaignsCreateRequestBody); return localVarResponse.Data; @@ -948,11 +972,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. /// /// Thrown when fails to make API call - /// Provide details for a campaign template (optional) + /// Provide details for a campaign template /// Index associated with the operation. /// ApiResponse of TemplatesCampaignsCreateTemplateResponseBody - public Voucherify.Client.ApiResponse CreateCampaignTemplateWithHttpInfo(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody = default(TemplatesCampaignsCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateCampaignTemplateWithHttpInfo(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'templatesCampaignsCreateRequestBody' is set + if (templatesCampaignsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'templatesCampaignsCreateRequestBody' when calling TemplatesApi->CreateCampaignTemplate"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1027,11 +1057,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. /// /// Thrown when fails to make API call - /// Provide details for a campaign template (optional) + /// Provide details for a campaign template /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of TemplatesCampaignsCreateTemplateResponseBody - public async System.Threading.Tasks.Task CreateCampaignTemplateAsync(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody = default(TemplatesCampaignsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateCampaignTemplateAsync(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateCampaignTemplateWithHttpInfoAsync(templatesCampaignsCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1041,12 +1071,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments πŸ‘ Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). πŸ“˜ Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature. /// /// Thrown when fails to make API call - /// Provide details for a campaign template (optional) + /// Provide details for a campaign template /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (TemplatesCampaignsCreateTemplateResponseBody) - public async System.Threading.Tasks.Task> CreateCampaignTemplateWithHttpInfoAsync(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody = default(TemplatesCampaignsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateCampaignTemplateWithHttpInfoAsync(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'templatesCampaignsCreateRequestBody' is set + if (templatesCampaignsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'templatesCampaignsCreateRequestBody' when calling TemplatesApi->CreateCampaignTemplate"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -1782,10 +1818,10 @@ public Voucherify.Client.ApiResponse GetCampa /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Provide the new name or description for the campaign template (optional) + /// Provide the new name or description for the campaign template /// Index associated with the operation. /// TemplatesCampaignsUpdateResponseBody - public TemplatesCampaignsUpdateResponseBody UpdateCampaignTemplate(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody = default(TemplatesCampaignsUpdateRequestBody), int operationIndex = 0) + public TemplatesCampaignsUpdateResponseBody UpdateCampaignTemplate(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateCampaignTemplateWithHttpInfo(campaignTemplateId, templatesCampaignsUpdateRequestBody); return localVarResponse.Data; @@ -1796,10 +1832,10 @@ public Voucherify.Client.ApiResponse GetCampa /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Provide the new name or description for the campaign template (optional) + /// Provide the new name or description for the campaign template /// Index associated with the operation. /// ApiResponse of TemplatesCampaignsUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateCampaignTemplateWithHttpInfo(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody = default(TemplatesCampaignsUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateCampaignTemplateWithHttpInfo(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'campaignTemplateId' is set if (campaignTemplateId == null) @@ -1807,6 +1843,12 @@ public Voucherify.Client.ApiResponse GetCampa throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignTemplateId' when calling TemplatesApi->UpdateCampaignTemplate"); } + // verify the required parameter 'templatesCampaignsUpdateRequestBody' is set + if (templatesCampaignsUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'templatesCampaignsUpdateRequestBody' when calling TemplatesApi->UpdateCampaignTemplate"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1883,11 +1925,11 @@ public Voucherify.Client.ApiResponse GetCampa /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Provide the new name or description for the campaign template (optional) + /// Provide the new name or description for the campaign template /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of TemplatesCampaignsUpdateResponseBody - public async System.Threading.Tasks.Task UpdateCampaignTemplateAsync(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody = default(TemplatesCampaignsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateCampaignTemplateAsync(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateCampaignTemplateWithHttpInfoAsync(campaignTemplateId, templatesCampaignsUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1898,11 +1940,11 @@ public Voucherify.Client.ApiResponse GetCampa /// /// Thrown when fails to make API call /// Pass the campaign template ID that was assigned by Voucherify. - /// Provide the new name or description for the campaign template (optional) + /// Provide the new name or description for the campaign template /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (TemplatesCampaignsUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateCampaignTemplateWithHttpInfoAsync(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody = default(TemplatesCampaignsUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateCampaignTemplateWithHttpInfoAsync(string campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'campaignTemplateId' is set if (campaignTemplateId == null) @@ -1910,6 +1952,12 @@ public Voucherify.Client.ApiResponse GetCampa throw new Voucherify.Client.ApiException(400, "Missing required parameter 'campaignTemplateId' when calling TemplatesApi->UpdateCampaignTemplate"); } + // verify the required parameter 'templatesCampaignsUpdateRequestBody' is set + if (templatesCampaignsUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'templatesCampaignsUpdateRequestBody' when calling TemplatesApi->UpdateCampaignTemplate"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/ValidationRulesApi.cs b/src/Voucherify/Api/ValidationRulesApi.cs index feec95c8..cec089fe 100644 --- a/src/Voucherify/Api/ValidationRulesApi.cs +++ b/src/Voucherify/Api/ValidationRulesApi.cs @@ -36,11 +36,11 @@ public interface IValidationRulesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique validation rule ID. + /// Specify the resource that you would like to assign the validation rule to. /// If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - /// Specify the resource that you would like to assign the validation rule to. (optional) /// Index associated with the operation. /// ValidationRulesAssignmentsCreateResponseBody - ValidationRulesAssignmentsCreateResponseBody CreateValidationRuleAssignment(string validationRuleId, bool? force = default(bool?), ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody = default(ValidationRulesAssignmentsCreateRequestBody), int operationIndex = 0); + ValidationRulesAssignmentsCreateResponseBody CreateValidationRuleAssignment(string validationRuleId, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody, bool? force = default(bool?), int operationIndex = 0); /// /// Create Validation Rules Assignments @@ -50,11 +50,11 @@ public interface IValidationRulesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Unique validation rule ID. + /// Specify the resource that you would like to assign the validation rule to. /// If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - /// Specify the resource that you would like to assign the validation rule to. (optional) /// Index associated with the operation. /// ApiResponse of ValidationRulesAssignmentsCreateResponseBody - ApiResponse CreateValidationRuleAssignmentWithHttpInfo(string validationRuleId, bool? force = default(bool?), ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody = default(ValidationRulesAssignmentsCreateRequestBody), int operationIndex = 0); + ApiResponse CreateValidationRuleAssignmentWithHttpInfo(string validationRuleId, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody, bool? force = default(bool?), int operationIndex = 0); /// /// Create Validation Rules /// @@ -62,10 +62,10 @@ public interface IValidationRulesApiSync : IApiAccessor /// Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. /// /// Thrown when fails to make API call - /// Specify the validation rules parameters. (optional) + /// Specify the validation rules parameters. /// Index associated with the operation. /// ValidationRulesCreateResponseBody - ValidationRulesCreateResponseBody CreateValidationRules(ValidationRulesCreateRequestBody validationRulesCreateRequestBody = default(ValidationRulesCreateRequestBody), int operationIndex = 0); + ValidationRulesCreateResponseBody CreateValidationRules(ValidationRulesCreateRequestBody validationRulesCreateRequestBody, int operationIndex = 0); /// /// Create Validation Rules @@ -74,10 +74,10 @@ public interface IValidationRulesApiSync : IApiAccessor /// Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. /// /// Thrown when fails to make API call - /// Specify the validation rules parameters. (optional) + /// Specify the validation rules parameters. /// Index associated with the operation. /// ApiResponse of ValidationRulesCreateResponseBody - ApiResponse CreateValidationRulesWithHttpInfo(ValidationRulesCreateRequestBody validationRulesCreateRequestBody = default(ValidationRulesCreateRequestBody), int operationIndex = 0); + ApiResponse CreateValidationRulesWithHttpInfo(ValidationRulesCreateRequestBody validationRulesCreateRequestBody, int operationIndex = 0); /// /// Delete Validation Rule Assignment /// @@ -248,10 +248,10 @@ public interface IValidationRulesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A unique validation rule ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// ValidationRulesUpdateResponseBody - ValidationRulesUpdateResponseBody UpdateValidationRule(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody = default(ValidationRulesUpdateRequestBody), int operationIndex = 0); + ValidationRulesUpdateResponseBody UpdateValidationRule(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody, int operationIndex = 0); /// /// Update Validation Rule @@ -261,10 +261,10 @@ public interface IValidationRulesApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A unique validation rule ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// ApiResponse of ValidationRulesUpdateResponseBody - ApiResponse UpdateValidationRuleWithHttpInfo(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody = default(ValidationRulesUpdateRequestBody), int operationIndex = 0); + ApiResponse UpdateValidationRuleWithHttpInfo(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -282,12 +282,12 @@ public interface IValidationRulesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique validation rule ID. + /// Specify the resource that you would like to assign the validation rule to. /// If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - /// Specify the resource that you would like to assign the validation rule to. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ValidationRulesAssignmentsCreateResponseBody - System.Threading.Tasks.Task CreateValidationRuleAssignmentAsync(string validationRuleId, bool? force = default(bool?), ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody = default(ValidationRulesAssignmentsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateValidationRuleAssignmentAsync(string validationRuleId, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody, bool? force = default(bool?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Validation Rules Assignments @@ -297,12 +297,12 @@ public interface IValidationRulesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Unique validation rule ID. + /// Specify the resource that you would like to assign the validation rule to. /// If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - /// Specify the resource that you would like to assign the validation rule to. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ValidationRulesAssignmentsCreateResponseBody) - System.Threading.Tasks.Task> CreateValidationRuleAssignmentWithHttpInfoAsync(string validationRuleId, bool? force = default(bool?), ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody = default(ValidationRulesAssignmentsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateValidationRuleAssignmentWithHttpInfoAsync(string validationRuleId, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody, bool? force = default(bool?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Validation Rules /// @@ -310,11 +310,11 @@ public interface IValidationRulesApiAsync : IApiAccessor /// Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. /// /// Thrown when fails to make API call - /// Specify the validation rules parameters. (optional) + /// Specify the validation rules parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ValidationRulesCreateResponseBody - System.Threading.Tasks.Task CreateValidationRulesAsync(ValidationRulesCreateRequestBody validationRulesCreateRequestBody = default(ValidationRulesCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateValidationRulesAsync(ValidationRulesCreateRequestBody validationRulesCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Validation Rules @@ -323,11 +323,11 @@ public interface IValidationRulesApiAsync : IApiAccessor /// Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. /// /// Thrown when fails to make API call - /// Specify the validation rules parameters. (optional) + /// Specify the validation rules parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ValidationRulesCreateResponseBody) - System.Threading.Tasks.Task> CreateValidationRulesWithHttpInfoAsync(ValidationRulesCreateRequestBody validationRulesCreateRequestBody = default(ValidationRulesCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateValidationRulesWithHttpInfoAsync(ValidationRulesCreateRequestBody validationRulesCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Validation Rule Assignment /// @@ -510,11 +510,11 @@ public interface IValidationRulesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A unique validation rule ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ValidationRulesUpdateResponseBody - System.Threading.Tasks.Task UpdateValidationRuleAsync(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody = default(ValidationRulesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateValidationRuleAsync(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Update Validation Rule @@ -524,11 +524,11 @@ public interface IValidationRulesApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A unique validation rule ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ValidationRulesUpdateResponseBody) - System.Threading.Tasks.Task> UpdateValidationRuleWithHttpInfoAsync(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody = default(ValidationRulesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> UpdateValidationRuleWithHttpInfoAsync(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -654,13 +654,13 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique validation rule ID. + /// Specify the resource that you would like to assign the validation rule to. /// If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - /// Specify the resource that you would like to assign the validation rule to. (optional) /// Index associated with the operation. /// ValidationRulesAssignmentsCreateResponseBody - public ValidationRulesAssignmentsCreateResponseBody CreateValidationRuleAssignment(string validationRuleId, bool? force = default(bool?), ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody = default(ValidationRulesAssignmentsCreateRequestBody), int operationIndex = 0) + public ValidationRulesAssignmentsCreateResponseBody CreateValidationRuleAssignment(string validationRuleId, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody, bool? force = default(bool?), int operationIndex = 0) { - Voucherify.Client.ApiResponse localVarResponse = CreateValidationRuleAssignmentWithHttpInfo(validationRuleId, force, validationRulesAssignmentsCreateRequestBody); + Voucherify.Client.ApiResponse localVarResponse = CreateValidationRuleAssignmentWithHttpInfo(validationRuleId, validationRulesAssignmentsCreateRequestBody, force); return localVarResponse.Data; } @@ -669,11 +669,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique validation rule ID. + /// Specify the resource that you would like to assign the validation rule to. /// If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - /// Specify the resource that you would like to assign the validation rule to. (optional) /// Index associated with the operation. /// ApiResponse of ValidationRulesAssignmentsCreateResponseBody - public Voucherify.Client.ApiResponse CreateValidationRuleAssignmentWithHttpInfo(string validationRuleId, bool? force = default(bool?), ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody = default(ValidationRulesAssignmentsCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateValidationRuleAssignmentWithHttpInfo(string validationRuleId, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody, bool? force = default(bool?), int operationIndex = 0) { // verify the required parameter 'validationRuleId' is set if (validationRuleId == null) @@ -681,6 +681,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'validationRuleId' when calling ValidationRulesApi->CreateValidationRuleAssignment"); } + // verify the required parameter 'validationRulesAssignmentsCreateRequestBody' is set + if (validationRulesAssignmentsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'validationRulesAssignmentsCreateRequestBody' when calling ValidationRulesApi->CreateValidationRuleAssignment"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -761,14 +767,14 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique validation rule ID. + /// Specify the resource that you would like to assign the validation rule to. /// If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - /// Specify the resource that you would like to assign the validation rule to. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ValidationRulesAssignmentsCreateResponseBody - public async System.Threading.Tasks.Task CreateValidationRuleAssignmentAsync(string validationRuleId, bool? force = default(bool?), ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody = default(ValidationRulesAssignmentsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateValidationRuleAssignmentAsync(string validationRuleId, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody, bool? force = default(bool?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { - Voucherify.Client.ApiResponse localVarResponse = await CreateValidationRuleAssignmentWithHttpInfoAsync(validationRuleId, force, validationRulesAssignmentsCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); + Voucherify.Client.ApiResponse localVarResponse = await CreateValidationRuleAssignmentWithHttpInfoAsync(validationRuleId, validationRulesAssignmentsCreateRequestBody, force, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -777,12 +783,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// Unique validation rule ID. + /// Specify the resource that you would like to assign the validation rule to. /// If this flag is set to true, the previous assignment with the same data will be deleted and a new one will be added. (optional) - /// Specify the resource that you would like to assign the validation rule to. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ValidationRulesAssignmentsCreateResponseBody) - public async System.Threading.Tasks.Task> CreateValidationRuleAssignmentWithHttpInfoAsync(string validationRuleId, bool? force = default(bool?), ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody = default(ValidationRulesAssignmentsCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateValidationRuleAssignmentWithHttpInfoAsync(string validationRuleId, ValidationRulesAssignmentsCreateRequestBody validationRulesAssignmentsCreateRequestBody, bool? force = default(bool?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'validationRuleId' is set if (validationRuleId == null) @@ -790,6 +796,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'validationRuleId' when calling ValidationRulesApi->CreateValidationRuleAssignment"); } + // verify the required parameter 'validationRulesAssignmentsCreateRequestBody' is set + if (validationRulesAssignmentsCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'validationRulesAssignmentsCreateRequestBody' when calling ValidationRulesApi->CreateValidationRuleAssignment"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -870,10 +882,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. /// /// Thrown when fails to make API call - /// Specify the validation rules parameters. (optional) + /// Specify the validation rules parameters. /// Index associated with the operation. /// ValidationRulesCreateResponseBody - public ValidationRulesCreateResponseBody CreateValidationRules(ValidationRulesCreateRequestBody validationRulesCreateRequestBody = default(ValidationRulesCreateRequestBody), int operationIndex = 0) + public ValidationRulesCreateResponseBody CreateValidationRules(ValidationRulesCreateRequestBody validationRulesCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateValidationRulesWithHttpInfo(validationRulesCreateRequestBody); return localVarResponse.Data; @@ -883,11 +895,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. /// /// Thrown when fails to make API call - /// Specify the validation rules parameters. (optional) + /// Specify the validation rules parameters. /// Index associated with the operation. /// ApiResponse of ValidationRulesCreateResponseBody - public Voucherify.Client.ApiResponse CreateValidationRulesWithHttpInfo(ValidationRulesCreateRequestBody validationRulesCreateRequestBody = default(ValidationRulesCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateValidationRulesWithHttpInfo(ValidationRulesCreateRequestBody validationRulesCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'validationRulesCreateRequestBody' is set + if (validationRulesCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'validationRulesCreateRequestBody' when calling ValidationRulesApi->CreateValidationRules"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -962,11 +980,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. /// /// Thrown when fails to make API call - /// Specify the validation rules parameters. (optional) + /// Specify the validation rules parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ValidationRulesCreateResponseBody - public async System.Threading.Tasks.Task CreateValidationRulesAsync(ValidationRulesCreateRequestBody validationRulesCreateRequestBody = default(ValidationRulesCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateValidationRulesAsync(ValidationRulesCreateRequestBody validationRulesCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateValidationRulesWithHttpInfoAsync(validationRulesCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -976,12 +994,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Create Validation Rules Create a validation rule. 🚧 Managing validation rules It is recommended to [create or update validation rules](https://support.voucherify.io/article/148-how-to-build-a-rule) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. /// /// Thrown when fails to make API call - /// Specify the validation rules parameters. (optional) + /// Specify the validation rules parameters. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ValidationRulesCreateResponseBody) - public async System.Threading.Tasks.Task> CreateValidationRulesWithHttpInfoAsync(ValidationRulesCreateRequestBody validationRulesCreateRequestBody = default(ValidationRulesCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateValidationRulesWithHttpInfoAsync(ValidationRulesCreateRequestBody validationRulesCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'validationRulesCreateRequestBody' is set + if (validationRulesCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'validationRulesCreateRequestBody' when calling ValidationRulesApi->CreateValidationRules"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2370,10 +2394,10 @@ public Voucherify.Client.ApiResponse GetValidati /// /// Thrown when fails to make API call /// A unique validation rule ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// ValidationRulesUpdateResponseBody - public ValidationRulesUpdateResponseBody UpdateValidationRule(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody = default(ValidationRulesUpdateRequestBody), int operationIndex = 0) + public ValidationRulesUpdateResponseBody UpdateValidationRule(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = UpdateValidationRuleWithHttpInfo(validationRuleId, validationRulesUpdateRequestBody); return localVarResponse.Data; @@ -2384,10 +2408,10 @@ public Voucherify.Client.ApiResponse GetValidati /// /// Thrown when fails to make API call /// A unique validation rule ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// ApiResponse of ValidationRulesUpdateResponseBody - public Voucherify.Client.ApiResponse UpdateValidationRuleWithHttpInfo(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody = default(ValidationRulesUpdateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse UpdateValidationRuleWithHttpInfo(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody, int operationIndex = 0) { // verify the required parameter 'validationRuleId' is set if (validationRuleId == null) @@ -2395,6 +2419,12 @@ public Voucherify.Client.ApiResponse GetValidati throw new Voucherify.Client.ApiException(400, "Missing required parameter 'validationRuleId' when calling ValidationRulesApi->UpdateValidationRule"); } + // verify the required parameter 'validationRulesUpdateRequestBody' is set + if (validationRulesUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'validationRulesUpdateRequestBody' when calling ValidationRulesApi->UpdateValidationRule"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -2471,11 +2501,11 @@ public Voucherify.Client.ApiResponse GetValidati /// /// Thrown when fails to make API call /// A unique validation rule ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ValidationRulesUpdateResponseBody - public async System.Threading.Tasks.Task UpdateValidationRuleAsync(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody = default(ValidationRulesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateValidationRuleAsync(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await UpdateValidationRuleWithHttpInfoAsync(validationRuleId, validationRulesUpdateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -2486,11 +2516,11 @@ public Voucherify.Client.ApiResponse GetValidati /// /// Thrown when fails to make API call /// A unique validation rule ID. - /// Specify the parameters to be updated. (optional) + /// Specify the parameters to be updated. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ValidationRulesUpdateResponseBody) - public async System.Threading.Tasks.Task> UpdateValidationRuleWithHttpInfoAsync(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody = default(ValidationRulesUpdateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> UpdateValidationRuleWithHttpInfoAsync(string validationRuleId, ValidationRulesUpdateRequestBody validationRulesUpdateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'validationRuleId' is set if (validationRuleId == null) @@ -2498,6 +2528,12 @@ public Voucherify.Client.ApiResponse GetValidati throw new Voucherify.Client.ApiException(400, "Missing required parameter 'validationRuleId' when calling ValidationRulesApi->UpdateValidationRule"); } + // verify the required parameter 'validationRulesUpdateRequestBody' is set + if (validationRulesUpdateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'validationRulesUpdateRequestBody' when calling ValidationRulesApi->UpdateValidationRule"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/ValidationsApi.cs b/src/Voucherify/Api/ValidationsApi.cs index 2ac89c5b..ace0877b 100644 --- a/src/Voucherify/Api/ValidationsApi.cs +++ b/src/Voucherify/Api/ValidationsApi.cs @@ -35,10 +35,10 @@ public interface IValidationsApiSync : IApiAccessor /// Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// ValidationsValidateResponseBody - ValidationsValidateResponseBody ValidateStackedDiscounts(ValidationsValidateRequestBody validationsValidateRequestBody = default(ValidationsValidateRequestBody), int operationIndex = 0); + ValidationsValidateResponseBody ValidateStackedDiscounts(ValidationsValidateRequestBody validationsValidateRequestBody, int operationIndex = 0); /// /// Validate Stackable Discounts @@ -47,10 +47,10 @@ public interface IValidationsApiSync : IApiAccessor /// Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// ApiResponse of ValidationsValidateResponseBody - ApiResponse ValidateStackedDiscountsWithHttpInfo(ValidationsValidateRequestBody validationsValidateRequestBody = default(ValidationsValidateRequestBody), int operationIndex = 0); + ApiResponse ValidateStackedDiscountsWithHttpInfo(ValidationsValidateRequestBody validationsValidateRequestBody, int operationIndex = 0); #endregion Synchronous Operations } @@ -67,11 +67,11 @@ public interface IValidationsApiAsync : IApiAccessor /// Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ValidationsValidateResponseBody - System.Threading.Tasks.Task ValidateStackedDiscountsAsync(ValidationsValidateRequestBody validationsValidateRequestBody = default(ValidationsValidateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task ValidateStackedDiscountsAsync(ValidationsValidateRequestBody validationsValidateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Validate Stackable Discounts @@ -80,11 +80,11 @@ public interface IValidationsApiAsync : IApiAccessor /// Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ValidationsValidateResponseBody) - System.Threading.Tasks.Task> ValidateStackedDiscountsWithHttpInfoAsync(ValidationsValidateRequestBody validationsValidateRequestBody = default(ValidationsValidateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ValidateStackedDiscountsWithHttpInfoAsync(ValidationsValidateRequestBody validationsValidateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -209,10 +209,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// ValidationsValidateResponseBody - public ValidationsValidateResponseBody ValidateStackedDiscounts(ValidationsValidateRequestBody validationsValidateRequestBody = default(ValidationsValidateRequestBody), int operationIndex = 0) + public ValidationsValidateResponseBody ValidateStackedDiscounts(ValidationsValidateRequestBody validationsValidateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = ValidateStackedDiscountsWithHttpInfo(validationsValidateRequestBody); return localVarResponse.Data; @@ -222,11 +222,17 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// ApiResponse of ValidationsValidateResponseBody - public Voucherify.Client.ApiResponse ValidateStackedDiscountsWithHttpInfo(ValidationsValidateRequestBody validationsValidateRequestBody = default(ValidationsValidateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse ValidateStackedDiscountsWithHttpInfo(ValidationsValidateRequestBody validationsValidateRequestBody, int operationIndex = 0) { + // verify the required parameter 'validationsValidateRequestBody' is set + if (validationsValidateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'validationsValidateRequestBody' when calling ValidationsApi->ValidateStackedDiscounts"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -301,11 +307,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ValidationsValidateResponseBody - public async System.Threading.Tasks.Task ValidateStackedDiscountsAsync(ValidationsValidateRequestBody validationsValidateRequestBody = default(ValidationsValidateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ValidateStackedDiscountsAsync(ValidationsValidateRequestBody validationsValidateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await ValidateStackedDiscountsWithHttpInfoAsync(validationsValidateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -315,12 +321,18 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// Validate Stackable Discounts Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint. /// /// Thrown when fails to make API call - /// (optional) + /// /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (ValidationsValidateResponseBody) - public async System.Threading.Tasks.Task> ValidateStackedDiscountsWithHttpInfoAsync(ValidationsValidateRequestBody validationsValidateRequestBody = default(ValidationsValidateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ValidateStackedDiscountsWithHttpInfoAsync(ValidationsValidateRequestBody validationsValidateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'validationsValidateRequestBody' is set + if (validationsValidateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'validationsValidateRequestBody' when calling ValidationsApi->ValidateStackedDiscounts"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); diff --git a/src/Voucherify/Api/VouchersApi.cs b/src/Voucherify/Api/VouchersApi.cs index 2315e2f5..541cb06c 100644 --- a/src/Voucherify/Api/VouchersApi.cs +++ b/src/Voucherify/Api/VouchersApi.cs @@ -36,10 +36,10 @@ public interface IVouchersApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A unique **code** that identifies the voucher. - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// VouchersCreateResponseBody - VouchersCreateResponseBody CreateVoucher(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody = default(VouchersCreateWithSpecificCodeRequestBody), int operationIndex = 0); + VouchersCreateResponseBody CreateVoucher(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody, int operationIndex = 0); /// /// Create Voucher @@ -49,10 +49,10 @@ public interface IVouchersApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A unique **code** that identifies the voucher. - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// ApiResponse of VouchersCreateResponseBody - ApiResponse CreateVoucherWithHttpInfo(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody = default(VouchersCreateWithSpecificCodeRequestBody), int operationIndex = 0); + ApiResponse CreateVoucherWithHttpInfo(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody, int operationIndex = 0); /// /// Delete Voucher /// @@ -132,10 +132,10 @@ public interface IVouchersApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - /// Specify the parameters for the camapign transaction export. (optional) + /// Specify the parameters for the camapign transaction export. /// Index associated with the operation. /// VouchersTransactionsExportCreateResponseBody - VouchersTransactionsExportCreateResponseBody ExportVoucherTransactions(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody = default(VouchersTransactionsExportCreateRequestBody), int operationIndex = 0); + VouchersTransactionsExportCreateResponseBody ExportVoucherTransactions(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody, int operationIndex = 0); /// /// Export Voucher Transactions @@ -145,10 +145,10 @@ public interface IVouchersApiSync : IApiAccessor /// /// Thrown when fails to make API call /// A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - /// Specify the parameters for the camapign transaction export. (optional) + /// Specify the parameters for the camapign transaction export. /// Index associated with the operation. /// ApiResponse of VouchersTransactionsExportCreateResponseBody - ApiResponse ExportVoucherTransactionsWithHttpInfo(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody = default(VouchersTransactionsExportCreateRequestBody), int operationIndex = 0); + ApiResponse ExportVoucherTransactionsWithHttpInfo(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody, int operationIndex = 0); /// /// Generate Random Code /// @@ -156,10 +156,10 @@ public interface IVouchersApiSync : IApiAccessor /// Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// VouchersCreateResponseBody - VouchersCreateResponseBody GenerateRandomCode(VouchersCreateRequestBody vouchersCreateRequestBody = default(VouchersCreateRequestBody), int operationIndex = 0); + VouchersCreateResponseBody GenerateRandomCode(VouchersCreateRequestBody vouchersCreateRequestBody, int operationIndex = 0); /// /// Generate Random Code @@ -168,10 +168,10 @@ public interface IVouchersApiSync : IApiAccessor /// Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// ApiResponse of VouchersCreateResponseBody - ApiResponse GenerateRandomCodeWithHttpInfo(VouchersCreateRequestBody vouchersCreateRequestBody = default(VouchersCreateRequestBody), int operationIndex = 0); + ApiResponse GenerateRandomCodeWithHttpInfo(VouchersCreateRequestBody vouchersCreateRequestBody, int operationIndex = 0); /// /// Get Voucher /// @@ -199,7 +199,7 @@ public interface IVouchersApiSync : IApiAccessor /// Import Vouchers /// /// - /// Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// The request body is an array of objects. Each object contains details about a specific voucher. @@ -211,7 +211,7 @@ public interface IVouchersApiSync : IApiAccessor /// Import Vouchers /// /// - /// Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// The request body is an array of objects. Each object contains details about a specific voucher. @@ -222,7 +222,7 @@ public interface IVouchersApiSync : IApiAccessor /// Import Vouchers using CSV /// /// - /// Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// File path. (optional) @@ -235,7 +235,7 @@ public interface IVouchersApiSync : IApiAccessor /// Import Vouchers using CSV /// /// - /// Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// File path. (optional) @@ -290,9 +290,10 @@ public interface IVouchersApiSync : IApiAccessor /// Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) /// (optional) /// (optional) + /// Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) /// Index associated with the operation. /// VouchersListResponseBody - VouchersListResponseBody ListVouchers(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), int operationIndex = 0); + VouchersListResponseBody ListVouchers(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), Object filters = default(Object), int operationIndex = 0); /// /// List Vouchers @@ -312,9 +313,10 @@ public interface IVouchersApiSync : IApiAccessor /// Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) /// (optional) /// (optional) + /// Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) /// Index associated with the operation. /// ApiResponse of VouchersListResponseBody - ApiResponse ListVouchersWithHttpInfo(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), int operationIndex = 0); + ApiResponse ListVouchersWithHttpInfo(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), Object filters = default(Object), int operationIndex = 0); /// /// Release Validation Session /// @@ -453,11 +455,11 @@ public interface IVouchersApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A unique **code** that identifies the voucher. - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of VouchersCreateResponseBody - System.Threading.Tasks.Task CreateVoucherAsync(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody = default(VouchersCreateWithSpecificCodeRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task CreateVoucherAsync(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Create Voucher @@ -467,11 +469,11 @@ public interface IVouchersApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A unique **code** that identifies the voucher. - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (VouchersCreateResponseBody) - System.Threading.Tasks.Task> CreateVoucherWithHttpInfoAsync(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody = default(VouchersCreateWithSpecificCodeRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> CreateVoucherWithHttpInfoAsync(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Delete Voucher /// @@ -557,11 +559,11 @@ public interface IVouchersApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - /// Specify the parameters for the camapign transaction export. (optional) + /// Specify the parameters for the camapign transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of VouchersTransactionsExportCreateResponseBody - System.Threading.Tasks.Task ExportVoucherTransactionsAsync(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody = default(VouchersTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task ExportVoucherTransactionsAsync(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Export Voucher Transactions @@ -571,11 +573,11 @@ public interface IVouchersApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - /// Specify the parameters for the camapign transaction export. (optional) + /// Specify the parameters for the camapign transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (VouchersTransactionsExportCreateResponseBody) - System.Threading.Tasks.Task> ExportVoucherTransactionsWithHttpInfoAsync(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody = default(VouchersTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ExportVoucherTransactionsWithHttpInfoAsync(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Generate Random Code /// @@ -583,11 +585,11 @@ public interface IVouchersApiAsync : IApiAccessor /// Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of VouchersCreateResponseBody - System.Threading.Tasks.Task GenerateRandomCodeAsync(VouchersCreateRequestBody vouchersCreateRequestBody = default(VouchersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task GenerateRandomCodeAsync(VouchersCreateRequestBody vouchersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Generate Random Code @@ -596,11 +598,11 @@ public interface IVouchersApiAsync : IApiAccessor /// Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (VouchersCreateResponseBody) - System.Threading.Tasks.Task> GenerateRandomCodeWithHttpInfoAsync(VouchersCreateRequestBody vouchersCreateRequestBody = default(VouchersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> GenerateRandomCodeWithHttpInfoAsync(VouchersCreateRequestBody vouchersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Get Voucher /// @@ -630,7 +632,7 @@ public interface IVouchersApiAsync : IApiAccessor /// Import Vouchers /// /// - /// Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// The request body is an array of objects. Each object contains details about a specific voucher. @@ -643,7 +645,7 @@ public interface IVouchersApiAsync : IApiAccessor /// Import Vouchers /// /// - /// Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// The request body is an array of objects. Each object contains details about a specific voucher. @@ -655,7 +657,7 @@ public interface IVouchersApiAsync : IApiAccessor /// Import Vouchers using CSV /// /// - /// Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// File path. (optional) @@ -669,7 +671,7 @@ public interface IVouchersApiAsync : IApiAccessor /// Import Vouchers using CSV /// /// - /// Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// File path. (optional) @@ -727,10 +729,11 @@ public interface IVouchersApiAsync : IApiAccessor /// Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) /// (optional) /// (optional) + /// Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of VouchersListResponseBody - System.Threading.Tasks.Task ListVouchersAsync(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task ListVouchersAsync(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), Object filters = default(Object), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// List Vouchers @@ -750,10 +753,11 @@ public interface IVouchersApiAsync : IApiAccessor /// Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) /// (optional) /// (optional) + /// Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (VouchersListResponseBody) - System.Threading.Tasks.Task> ListVouchersWithHttpInfoAsync(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> ListVouchersWithHttpInfoAsync(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), Object filters = default(Object), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Release Validation Session /// @@ -1010,10 +1014,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// A unique **code** that identifies the voucher. - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// VouchersCreateResponseBody - public VouchersCreateResponseBody CreateVoucher(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody = default(VouchersCreateWithSpecificCodeRequestBody), int operationIndex = 0) + public VouchersCreateResponseBody CreateVoucher(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = CreateVoucherWithHttpInfo(code, vouchersCreateWithSpecificCodeRequestBody); return localVarResponse.Data; @@ -1024,10 +1028,10 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// A unique **code** that identifies the voucher. - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// ApiResponse of VouchersCreateResponseBody - public Voucherify.Client.ApiResponse CreateVoucherWithHttpInfo(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody = default(VouchersCreateWithSpecificCodeRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse CreateVoucherWithHttpInfo(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody, int operationIndex = 0) { // verify the required parameter 'code' is set if (code == null) @@ -1035,6 +1039,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'code' when calling VouchersApi->CreateVoucher"); } + // verify the required parameter 'vouchersCreateWithSpecificCodeRequestBody' is set + if (vouchersCreateWithSpecificCodeRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'vouchersCreateWithSpecificCodeRequestBody' when calling VouchersApi->CreateVoucher"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1111,11 +1121,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// A unique **code** that identifies the voucher. - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of VouchersCreateResponseBody - public async System.Threading.Tasks.Task CreateVoucherAsync(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody = default(VouchersCreateWithSpecificCodeRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task CreateVoucherAsync(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await CreateVoucherWithHttpInfoAsync(code, vouchersCreateWithSpecificCodeRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1126,11 +1136,11 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory /// /// Thrown when fails to make API call /// A unique **code** that identifies the voucher. - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (VouchersCreateResponseBody) - public async System.Threading.Tasks.Task> CreateVoucherWithHttpInfoAsync(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody = default(VouchersCreateWithSpecificCodeRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> CreateVoucherWithHttpInfoAsync(string code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'code' is set if (code == null) @@ -1138,6 +1148,12 @@ public Voucherify.Client.ExceptionFactory ExceptionFactory throw new Voucherify.Client.ApiException(400, "Missing required parameter 'code' when calling VouchersApi->CreateVoucher"); } + // verify the required parameter 'vouchersCreateWithSpecificCodeRequestBody' is set + if (vouchersCreateWithSpecificCodeRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'vouchersCreateWithSpecificCodeRequestBody' when calling VouchersApi->CreateVoucher"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -1814,10 +1830,10 @@ public Voucherify.Client.ApiResponse EnableVoucherWi /// /// Thrown when fails to make API call /// A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - /// Specify the parameters for the camapign transaction export. (optional) + /// Specify the parameters for the camapign transaction export. /// Index associated with the operation. /// VouchersTransactionsExportCreateResponseBody - public VouchersTransactionsExportCreateResponseBody ExportVoucherTransactions(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody = default(VouchersTransactionsExportCreateRequestBody), int operationIndex = 0) + public VouchersTransactionsExportCreateResponseBody ExportVoucherTransactions(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = ExportVoucherTransactionsWithHttpInfo(code, vouchersTransactionsExportCreateRequestBody); return localVarResponse.Data; @@ -1828,10 +1844,10 @@ public Voucherify.Client.ApiResponse EnableVoucherWi /// /// Thrown when fails to make API call /// A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - /// Specify the parameters for the camapign transaction export. (optional) + /// Specify the parameters for the camapign transaction export. /// Index associated with the operation. /// ApiResponse of VouchersTransactionsExportCreateResponseBody - public Voucherify.Client.ApiResponse ExportVoucherTransactionsWithHttpInfo(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody = default(VouchersTransactionsExportCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse ExportVoucherTransactionsWithHttpInfo(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody, int operationIndex = 0) { // verify the required parameter 'code' is set if (code == null) @@ -1839,6 +1855,12 @@ public Voucherify.Client.ApiResponse EnableVoucherWi throw new Voucherify.Client.ApiException(400, "Missing required parameter 'code' when calling VouchersApi->ExportVoucherTransactions"); } + // verify the required parameter 'vouchersTransactionsExportCreateRequestBody' is set + if (vouchersTransactionsExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'vouchersTransactionsExportCreateRequestBody' when calling VouchersApi->ExportVoucherTransactions"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1915,11 +1937,11 @@ public Voucherify.Client.ApiResponse EnableVoucherWi /// /// Thrown when fails to make API call /// A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - /// Specify the parameters for the camapign transaction export. (optional) + /// Specify the parameters for the camapign transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of VouchersTransactionsExportCreateResponseBody - public async System.Threading.Tasks.Task ExportVoucherTransactionsAsync(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody = default(VouchersTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ExportVoucherTransactionsAsync(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await ExportVoucherTransactionsWithHttpInfoAsync(code, vouchersTransactionsExportCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -1930,11 +1952,11 @@ public Voucherify.Client.ApiResponse EnableVoucherWi /// /// Thrown when fails to make API call /// A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. - /// Specify the parameters for the camapign transaction export. (optional) + /// Specify the parameters for the camapign transaction export. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (VouchersTransactionsExportCreateResponseBody) - public async System.Threading.Tasks.Task> ExportVoucherTransactionsWithHttpInfoAsync(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody = default(VouchersTransactionsExportCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ExportVoucherTransactionsWithHttpInfoAsync(string code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'code' is set if (code == null) @@ -1942,6 +1964,12 @@ public Voucherify.Client.ApiResponse EnableVoucherWi throw new Voucherify.Client.ApiException(400, "Missing required parameter 'code' when calling VouchersApi->ExportVoucherTransactions"); } + // verify the required parameter 'vouchersTransactionsExportCreateRequestBody' is set + if (vouchersTransactionsExportCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'vouchersTransactionsExportCreateRequestBody' when calling VouchersApi->ExportVoucherTransactions"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2018,10 +2046,10 @@ public Voucherify.Client.ApiResponse EnableVoucherWi /// Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// VouchersCreateResponseBody - public VouchersCreateResponseBody GenerateRandomCode(VouchersCreateRequestBody vouchersCreateRequestBody = default(VouchersCreateRequestBody), int operationIndex = 0) + public VouchersCreateResponseBody GenerateRandomCode(VouchersCreateRequestBody vouchersCreateRequestBody, int operationIndex = 0) { Voucherify.Client.ApiResponse localVarResponse = GenerateRandomCodeWithHttpInfo(vouchersCreateRequestBody); return localVarResponse.Data; @@ -2031,11 +2059,17 @@ public Voucherify.Client.ApiResponse EnableVoucherWi /// Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// ApiResponse of VouchersCreateResponseBody - public Voucherify.Client.ApiResponse GenerateRandomCodeWithHttpInfo(VouchersCreateRequestBody vouchersCreateRequestBody = default(VouchersCreateRequestBody), int operationIndex = 0) + public Voucherify.Client.ApiResponse GenerateRandomCodeWithHttpInfo(VouchersCreateRequestBody vouchersCreateRequestBody, int operationIndex = 0) { + // verify the required parameter 'vouchersCreateRequestBody' is set + if (vouchersCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'vouchersCreateRequestBody' when calling VouchersApi->GenerateRandomCode"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -2110,11 +2144,11 @@ public Voucherify.Client.ApiResponse EnableVoucherWi /// Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of VouchersCreateResponseBody - public async System.Threading.Tasks.Task GenerateRandomCodeAsync(VouchersCreateRequestBody vouchersCreateRequestBody = default(VouchersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task GenerateRandomCodeAsync(VouchersCreateRequestBody vouchersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.ApiResponse localVarResponse = await GenerateRandomCodeWithHttpInfoAsync(vouchersCreateRequestBody, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; @@ -2124,12 +2158,18 @@ public Voucherify.Client.ApiResponse EnableVoucherWi /// Generate Random Code Create a generic (standalone) vouchers. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new generic (standalone) vouchers if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a generic (standalone) vouchers campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify) for more details about released features. /// /// Thrown when fails to make API call - /// Specify the details of the voucher that you would like to create. (optional) + /// Specify the details of the voucher that you would like to create. /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (VouchersCreateResponseBody) - public async System.Threading.Tasks.Task> GenerateRandomCodeWithHttpInfoAsync(VouchersCreateRequestBody vouchersCreateRequestBody = default(VouchersCreateRequestBody), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> GenerateRandomCodeWithHttpInfoAsync(VouchersCreateRequestBody vouchersCreateRequestBody, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { + // verify the required parameter 'vouchersCreateRequestBody' is set + if (vouchersCreateRequestBody == null) + { + throw new Voucherify.Client.ApiException(400, "Missing required parameter 'vouchersCreateRequestBody' when calling VouchersApi->GenerateRandomCode"); + } + Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -2399,7 +2439,7 @@ public Voucherify.Client.ApiResponse GetVoucherWithHttp } /// - /// Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// The request body is an array of objects. Each object contains details about a specific voucher. @@ -2412,7 +2452,7 @@ public VouchersImportCreateResponseBody ImportVouchers(List - /// Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// The request body is an array of objects. Each object contains details about a specific voucher. @@ -2497,7 +2537,7 @@ public Voucherify.Client.ApiResponse ImportVou } /// - /// Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// The request body is an array of objects. Each object contains details about a specific voucher. @@ -2511,7 +2551,7 @@ public Voucherify.Client.ApiResponse ImportVou } /// - /// Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import Vouchers Import generic (standalone) vouchers and gift cards into the repository. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include up to **10 MB** of data. πŸ“˜ Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// The request body is an array of objects. Each object contains details about a specific voucher. @@ -2598,7 +2638,7 @@ public Voucherify.Client.ApiResponse ImportVou } /// - /// Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// File path. (optional) @@ -2612,7 +2652,7 @@ public Voucherify.Client.ApiResponse ImportVou } /// - /// Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// File path. (optional) @@ -2699,7 +2739,7 @@ public Voucherify.Client.ApiResponse ImportVou } /// - /// Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// File path. (optional) @@ -2714,7 +2754,7 @@ public Voucherify.Client.ApiResponse ImportVou } /// - /// Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. + /// Import Vouchers using CSV Import generic (standalone) vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. Also, the request can include a max. **10 MB** CSV file. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ πŸ“˜ Standard voucher fields mapping - Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify project. - You can, however, upload the same codes to update them. πŸ“˜ Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action). You can pass the webhooks_enable true parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasnt been changed in the CSV file. 🚧 Generic (standalone) vouchers and campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), generic (standalone) vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null. /// /// Thrown when fails to make API call /// File path. (optional) @@ -3050,11 +3090,12 @@ public Voucherify.Client.ApiResponse ImportVou /// Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) /// (optional) /// (optional) + /// Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) /// Index associated with the operation. /// VouchersListResponseBody - public VouchersListResponseBody ListVouchers(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), int operationIndex = 0) + public VouchersListResponseBody ListVouchers(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), Object filters = default(Object), int operationIndex = 0) { - Voucherify.Client.ApiResponse localVarResponse = ListVouchersWithHttpInfo(limit, page, category, campaignId, customer, campaign, createdAt, updatedAt, order, code, ids); + Voucherify.Client.ApiResponse localVarResponse = ListVouchersWithHttpInfo(limit, page, category, campaignId, customer, campaign, createdAt, updatedAt, order, code, ids, filters); return localVarResponse.Data; } @@ -3073,9 +3114,10 @@ public Voucherify.Client.ApiResponse ImportVou /// Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) /// (optional) /// (optional) + /// Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) /// Index associated with the operation. /// ApiResponse of VouchersListResponseBody - public Voucherify.Client.ApiResponse ListVouchersWithHttpInfo(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), int operationIndex = 0) + public Voucherify.Client.ApiResponse ListVouchersWithHttpInfo(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), Object filters = default(Object), int operationIndex = 0) { Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -3158,6 +3200,9 @@ public Voucherify.Client.ApiResponse ImportVou { localVarRequestOptions.QueryParameters.Add(Voucherify.Client.ClientUtils.ParameterToMultiMap("multi", "ids", ids)); } + if (filters != null) + { + } localVarRequestOptions.Operation = "VouchersApi.ListVouchers"; localVarRequestOptions.OperationIndex = operationIndex; @@ -3218,12 +3263,13 @@ public Voucherify.Client.ApiResponse ImportVou /// Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) /// (optional) /// (optional) + /// Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of VouchersListResponseBody - public async System.Threading.Tasks.Task ListVouchersAsync(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task ListVouchersAsync(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), Object filters = default(Object), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { - Voucherify.Client.ApiResponse localVarResponse = await ListVouchersWithHttpInfoAsync(limit, page, category, campaignId, customer, campaign, createdAt, updatedAt, order, code, ids, operationIndex, cancellationToken).ConfigureAwait(false); + Voucherify.Client.ApiResponse localVarResponse = await ListVouchersWithHttpInfoAsync(limit, page, category, campaignId, customer, campaign, createdAt, updatedAt, order, code, ids, filters, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -3242,10 +3288,11 @@ public Voucherify.Client.ApiResponse ImportVou /// Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional) /// (optional) /// (optional) + /// Object for setting voucher filters. Read [Advanced filters for fetching resources](/api-reference/listing#advanced-filters-for-fetching-resources) for filter examples. (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (VouchersListResponseBody) - public async System.Threading.Tasks.Task> ListVouchersWithHttpInfoAsync(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> ListVouchersWithHttpInfoAsync(int? limit = default(int?), int? page = default(int?), string category = default(string), string campaignId = default(string), string customer = default(string), string campaign = default(string), ParameterCreatedBeforeAfter createdAt = default(ParameterCreatedBeforeAfter), ParameterUpdatedBeforeAfter updatedAt = default(ParameterUpdatedBeforeAfter), ParameterOrderVouchers? order = default(ParameterOrderVouchers?), string code = default(string), List ids = default(List), Object filters = default(Object), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { Voucherify.Client.RequestOptions localVarRequestOptions = new Voucherify.Client.RequestOptions(); @@ -3328,6 +3375,9 @@ public Voucherify.Client.ApiResponse ImportVou { localVarRequestOptions.QueryParameters.Add(Voucherify.Client.ClientUtils.ParameterToMultiMap("multi", "ids", ids)); } + if (filters != null) + { + } localVarRequestOptions.Operation = "VouchersApi.ListVouchers"; localVarRequestOptions.OperationIndex = operationIndex; diff --git a/src/Voucherify/Client/Configuration.cs b/src/Voucherify/Client/Configuration.cs index 1a5a9704..3ed8c379 100644 --- a/src/Voucherify/Client/Configuration.cs +++ b/src/Voucherify/Client/Configuration.cs @@ -35,7 +35,7 @@ public class Configuration : IReadableConfiguration /// Version of the package. /// /// Version of the package. - public const string Version = "8.1.0"; + public const string Version = "9.0.0"; /// /// Identifier for ISO 8601 DateTime Format @@ -114,7 +114,7 @@ public class Configuration : IReadableConfiguration public Configuration() { Proxy = null; - UserAgent = WebUtility.UrlEncode("DOTNET-SDK-8.1.0"); + UserAgent = WebUtility.UrlEncode("DOTNET-SDK-9.0.0"); BasePath = "https://api.voucherify.io"; DefaultHeaders = new ConcurrentDictionary(); ApiKey = new ConcurrentDictionary(); @@ -587,7 +587,7 @@ public static string ToDebugReport() report += " OS: " + System.Environment.OSVersion + "\n"; report += " .NET Framework Version: " + System.Environment.Version + "\n"; report += " Version of the API: v2018-08-01\n"; - report += " SDK Package Version: 8.1.0\n"; + report += " SDK Package Version: 9.0.0\n"; return report; } diff --git a/src/Voucherify/Model/ClientValidationsValidateRequestBody.cs b/src/Voucherify/Model/ClientValidationsValidateRequestBody.cs index c31473fc..ed7da3cb 100644 --- a/src/Voucherify/Model/ClientValidationsValidateRequestBody.cs +++ b/src/Voucherify/Model/ClientValidationsValidateRequestBody.cs @@ -28,7 +28,7 @@ namespace Voucherify.Model { /// - /// Response body schema for **POST** `v1/validations`. + /// Request body schema for **POST** `v1/validations`. /// [DataContract(Name = "ClientValidationsValidateRequestBody")] public partial class ClientValidationsValidateRequestBody : IValidatableObject diff --git a/src/Voucherify/Model/LoyaltyCardTransaction.cs b/src/Voucherify/Model/LoyaltyCardTransaction.cs index b8ea96c5..bed045bf 100644 --- a/src/Voucherify/Model/LoyaltyCardTransaction.cs +++ b/src/Voucherify/Model/LoyaltyCardTransaction.cs @@ -67,7 +67,7 @@ public bool ShouldSerializeType() /// The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.. /// Unique voucher ID.. /// Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.. - /// The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.. + /// The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.. /// Reason why the transaction occurred. In case of a redemption, this value is null.. /// The related transaction ID on the receiving card.. /// Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.. @@ -228,9 +228,9 @@ public bool ShouldSerializeCampaignId() return _flagCampaignId; } /// - /// The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + /// The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. /// - /// The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + /// The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. [DataMember(Name = "source", EmitDefaultValue = true)] public string Source { diff --git a/src/Voucherify/Model/LoyaltyPointsBucket.cs b/src/Voucherify/Model/LoyaltyPointsBucket.cs index fbbdebdf..952d3329 100644 --- a/src/Voucherify/Model/LoyaltyPointsBucket.cs +++ b/src/Voucherify/Model/LoyaltyPointsBucket.cs @@ -82,7 +82,7 @@ public bool ShouldSerializeObject() /// Unique identifier of the parent loyalty card.. /// Unique identifier of the parent campaign.. /// bucket. - /// Loyalty point point bucket status.. + /// Loyalty point bucket status.. /// Date when the number of points defined in the bucket object are due to expire.. /// Timestamp representing the date and time when the loyalty point bucket object was created in ISO 8601 format.. /// Timestamp representing the date and time when the loyalty point bucket object was updated in ISO 8601 format.. @@ -236,9 +236,9 @@ public bool ShouldSerializeBucket() return _flagBucket; } /// - /// Loyalty point point bucket status. + /// Loyalty point bucket status. /// - /// Loyalty point point bucket status. + /// Loyalty point bucket status. [DataMember(Name = "status", EmitDefaultValue = true)] public string Status { diff --git a/src/Voucherify/Model/MemberActivityDataTransaction.cs b/src/Voucherify/Model/MemberActivityDataTransaction.cs index 559b3d8a..25f6795e 100644 --- a/src/Voucherify/Model/MemberActivityDataTransaction.cs +++ b/src/Voucherify/Model/MemberActivityDataTransaction.cs @@ -152,7 +152,7 @@ public bool ShouldSerializeType() /// The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.. /// Unique voucher ID.. /// Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.. - /// The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.. + /// The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.. /// Reason why the transaction occurred. In case of a redemption, this value is null.. /// The related transaction ID on the receiving card.. /// Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.. @@ -313,9 +313,9 @@ public bool ShouldSerializeCampaignId() return _flagCampaignId; } /// - /// The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + /// The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. /// - /// The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + /// The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. [DataMember(Name = "source", EmitDefaultValue = true)] public string Source { diff --git a/src/Voucherify/Model/OrdersImportCreateRequestBodyItem.cs b/src/Voucherify/Model/OrdersImportCreateRequestBodyItem.cs index 4e23d67b..70c46e3a 100644 --- a/src/Voucherify/Model/OrdersImportCreateRequestBodyItem.cs +++ b/src/Voucherify/Model/OrdersImportCreateRequestBodyItem.cs @@ -104,11 +104,10 @@ public bool ShouldSerializeStatus() /// Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).. /// Array of items applied to the order. It can include up to 500 items.. /// A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.. - /// Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.. /// Unique referrer ID.. /// customer. /// referrer. - public OrdersImportCreateRequestBodyItem(string id = default(string), string sourceId = default(string), StatusEnum? status = default(StatusEnum?), int? amount = default(int?), int? initialAmount = default(int?), int? discountAmount = default(int?), List items = default(List), Object metadata = default(Object), DateTimeOffset createdAt = default(DateTimeOffset), string referrerId = default(string), Customer customer = default(Customer), Referrer referrer = default(Referrer)) + public OrdersImportCreateRequestBodyItem(string id = default(string), string sourceId = default(string), StatusEnum? status = default(StatusEnum?), int? amount = default(int?), int? initialAmount = default(int?), int? discountAmount = default(int?), List items = default(List), Object metadata = default(Object), string referrerId = default(string), Customer customer = default(Customer), Referrer referrer = default(Referrer)) { this._Id = id; if (this.Id != null) @@ -150,11 +149,6 @@ public bool ShouldSerializeStatus() { this._flagMetadata = true; } - this._CreatedAt = createdAt; - if (this.CreatedAt != null) - { - this._flagCreatedAt = true; - } this._ReferrerId = referrerId; if (this.ReferrerId != null) { @@ -348,34 +342,6 @@ public bool ShouldSerializeMetadata() return _flagMetadata; } /// - /// Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. - /// - /// Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. - /* - 2021-12-22T10:13:06.487Z - */ - [DataMember(Name = "created_at", EmitDefaultValue = true)] - public DateTimeOffset CreatedAt - { - get{ return _CreatedAt;} - set - { - _CreatedAt = value; - _flagCreatedAt = true; - } - } - private DateTimeOffset _CreatedAt; - private bool _flagCreatedAt; - - /// - /// Returns false as CreatedAt should not be serialized given that it's read-only. - /// - /// false (boolean) - public bool ShouldSerializeCreatedAt() - { - return _flagCreatedAt; - } - /// /// Unique referrer ID. /// /// Unique referrer ID. @@ -467,7 +433,6 @@ public override string ToString() sb.Append(" DiscountAmount: ").Append(DiscountAmount).Append("\n"); sb.Append(" Items: ").Append(Items).Append("\n"); sb.Append(" Metadata: ").Append(Metadata).Append("\n"); - sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" ReferrerId: ").Append(ReferrerId).Append("\n"); sb.Append(" Customer: ").Append(Customer).Append("\n"); sb.Append(" Referrer: ").Append(Referrer).Append("\n"); diff --git a/src/Voucherify/Model/ProductCollectionsCreateRequestBody.cs b/src/Voucherify/Model/ProductCollectionsCreateRequestBody.cs index 938bd940..57a6b1d1 100644 --- a/src/Voucherify/Model/ProductCollectionsCreateRequestBody.cs +++ b/src/Voucherify/Model/ProductCollectionsCreateRequestBody.cs @@ -34,9 +34,8 @@ namespace Voucherify.Model public partial class ProductCollectionsCreateRequestBody : IValidatableObject { /// - /// Show that the product collection is static (manually selected products). + /// Defines Type /// - /// Show that the product collection is static (manually selected products). [JsonConverter(typeof(SafeEnumConverter))] public enum TypeEnum { @@ -44,14 +43,19 @@ public enum TypeEnum /// Enum STATIC for value: STATIC /// [EnumMember(Value = "STATIC")] - STATIC = 1 + STATIC = 1, + + /// + /// Enum AUTOUPDATE for value: AUTO_UPDATE + /// + [EnumMember(Value = "AUTO_UPDATE")] + AUTOUPDATE = 2 } /// - /// Show that the product collection is static (manually selected products). + /// Gets or Sets Type /// - /// Show that the product collection is static (manually selected products). [JsonConverter(typeof(SafeEnumConverter))] [DataMember(Name = "type", EmitDefaultValue = true)] @@ -78,7 +82,7 @@ public bool ShouldSerializeType() /// /// Initializes a new instance of the class. /// - /// Show that the product collection is static (manually selected products).. + /// type. /// Unique user-defined product collection name.. /// Defines a set of products for a `STATIC` product collection type.. /// Defines a set of criteria and boundary conditions for an `AUTO_UPDATE` product collection type.. diff --git a/src/Voucherify/Model/ProductCollectionsCreateRequestBodyProductsItem.cs b/src/Voucherify/Model/ProductCollectionsCreateRequestBodyProductsItem.cs index 2aa52715..edc9e6fd 100644 --- a/src/Voucherify/Model/ProductCollectionsCreateRequestBodyProductsItem.cs +++ b/src/Voucherify/Model/ProductCollectionsCreateRequestBodyProductsItem.cs @@ -108,9 +108,6 @@ protected ProductCollectionsCreateRequestBodyProductsItem() { } /// The product ID. /// /// The product ID. - /* - prod_0a41bcf807c5fcaaf6 - */ [DataMember(Name = "id", IsRequired = false, EmitDefaultValue = true)] public string Id { diff --git a/src/Voucherify/Model/ReferralProgramRefereeReward.cs b/src/Voucherify/Model/ReferralProgramRefereeReward.cs index 7acceb07..60fce09c 100644 --- a/src/Voucherify/Model/ReferralProgramRefereeReward.cs +++ b/src/Voucherify/Model/ReferralProgramRefereeReward.cs @@ -87,7 +87,7 @@ public bool ShouldSerializeType() /// relatedObjectParent. /// Type of reward.. /// Define the number of `points` to add to a loyalty card or `credits` to the balance on a gift card. In case of the gift card, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.. - public ReferralProgramRefereeReward(ReferralProgramRefereeRewardRelatedObjectParent relatedObjectParent = default(ReferralProgramRefereeRewardRelatedObjectParent), TypeEnum? type = default(TypeEnum?), string amount = default(string)) + public ReferralProgramRefereeReward(ReferralProgramRefereeRewardRelatedObjectParent relatedObjectParent = default(ReferralProgramRefereeRewardRelatedObjectParent), TypeEnum? type = default(TypeEnum?), int? amount = default(int?)) { this._RelatedObjectParent = relatedObjectParent; if (this.RelatedObjectParent != null) @@ -135,7 +135,7 @@ public bool ShouldSerializeRelatedObjectParent() /// /// Define the number of `points` to add to a loyalty card or `credits` to the balance on a gift card. In case of the gift card, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. [DataMember(Name = "amount", EmitDefaultValue = true)] - public string Amount + public int? Amount { get{ return _Amount;} set @@ -144,7 +144,7 @@ public string Amount _flagAmount = true; } } - private string _Amount; + private int? _Amount; private bool _flagAmount; /// diff --git a/src/Voucherify/Model/RewardsCreateRequestBodyParametersCampaign.cs b/src/Voucherify/Model/RewardsCreateRequestBodyParametersCampaign.cs index 6396d9af..3ea5e160 100644 --- a/src/Voucherify/Model/RewardsCreateRequestBodyParametersCampaign.cs +++ b/src/Voucherify/Model/RewardsCreateRequestBodyParametersCampaign.cs @@ -37,7 +37,7 @@ public partial class RewardsCreateRequestBodyParametersCampaign : IValidatableOb /// Initializes a new instance of the class. /// /// id. - /// The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.. + /// The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.. public RewardsCreateRequestBodyParametersCampaign(string id = default(string), int? balance = default(int?)) { this._Id = id; @@ -77,9 +77,9 @@ public bool ShouldSerializeId() return _flagId; } /// - /// The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. + /// The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. /// - /// The incremental points to be added to the current balance on the loyalty card. and The incremental amout to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. + /// The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. [DataMember(Name = "balance", EmitDefaultValue = true)] public int? Balance { diff --git a/src/Voucherify/Model/SegmentsCreateResponseBody.cs b/src/Voucherify/Model/SegmentsCreateResponseBody.cs index d92a1261..2308c011 100644 --- a/src/Voucherify/Model/SegmentsCreateResponseBody.cs +++ b/src/Voucherify/Model/SegmentsCreateResponseBody.cs @@ -88,52 +88,6 @@ public bool ShouldSerializeType() return _flagType; } /// - /// Defines InitialSyncStatus - /// - [JsonConverter(typeof(SafeEnumConverter))] - public enum InitialSyncStatusEnum - { - /// - /// Enum INPROGRESS for value: IN_PROGRESS - /// - [EnumMember(Value = "IN_PROGRESS")] - INPROGRESS = 1, - - /// - /// Enum DONE for value: DONE - /// - [EnumMember(Value = "DONE")] - DONE = 2 - } - - - /// - /// Gets or Sets InitialSyncStatus - /// - - [JsonConverter(typeof(SafeEnumConverter))] - [DataMember(Name = "initial_sync_status", EmitDefaultValue = true)] - public InitialSyncStatusEnum? InitialSyncStatus - { - get{ return _InitialSyncStatus;} - set - { - _InitialSyncStatus = value; - _flagInitialSyncStatus = true; - } - } - private InitialSyncStatusEnum? _InitialSyncStatus; - private bool _flagInitialSyncStatus; - - /// - /// Returns false as InitialSyncStatus should not be serialized given that it's read-only. - /// - /// false (boolean) - public bool ShouldSerializeInitialSyncStatus() - { - return _flagInitialSyncStatus; - } - /// /// The type of the object represented by JSON. This object stores information about the customer segment. /// /// The type of the object represented by JSON. This object stores information about the customer segment. @@ -183,9 +137,8 @@ public bool ShouldSerializeObject() /// Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format.. /// Defines whether the segment is: - Active (`auto-update`): customers enter and leave the segment based on the defined filters and the `customer.segment.entered` and `customer.segment.left` events are triggered, - Passive (`passive`): customers enter and leave the segment based on the defined filters, but the `customer.segment.entered` and `customer.segment.left` events are not triggered, - Static (`static`): manually selected customers.. /// Defines a set of criteria for an `auto-update` or `passive` segment type.. - /// initialSyncStatus. /// The type of the object represented by JSON. This object stores information about the customer segment.. - public SegmentsCreateResponseBody(string id = default(string), string name = default(string), DateTimeOffset? createdAt = default(DateTimeOffset?), TypeEnum? type = default(TypeEnum?), Object filter = default(Object), InitialSyncStatusEnum? initialSyncStatus = default(InitialSyncStatusEnum?), ObjectEnum? varObject = default(ObjectEnum?)) + public SegmentsCreateResponseBody(string id = default(string), string name = default(string), DateTimeOffset? createdAt = default(DateTimeOffset?), TypeEnum? type = default(TypeEnum?), Object filter = default(Object), ObjectEnum? varObject = default(ObjectEnum?)) { this._Id = id; if (this.Id != null) @@ -212,11 +165,6 @@ public bool ShouldSerializeObject() { this._flagFilter = true; } - this._InitialSyncStatus = initialSyncStatus; - if (this.InitialSyncStatus != null) - { - this._flagInitialSyncStatus = true; - } this._Object = varObject; if (this.Object != null) { @@ -343,7 +291,6 @@ public override string ToString() sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Filter: ").Append(Filter).Append("\n"); - sb.Append(" InitialSyncStatus: ").Append(InitialSyncStatus).Append("\n"); sb.Append(" Object: ").Append(Object).Append("\n"); sb.Append("}\n"); return sb.ToString(); diff --git a/src/Voucherify/Model/SegmentsGetResponseBody.cs b/src/Voucherify/Model/SegmentsGetResponseBody.cs index 3d0aace0..19d53138 100644 --- a/src/Voucherify/Model/SegmentsGetResponseBody.cs +++ b/src/Voucherify/Model/SegmentsGetResponseBody.cs @@ -88,52 +88,6 @@ public bool ShouldSerializeType() return _flagType; } /// - /// Defines InitialSyncStatus - /// - [JsonConverter(typeof(SafeEnumConverter))] - public enum InitialSyncStatusEnum - { - /// - /// Enum INPROGRESS for value: IN_PROGRESS - /// - [EnumMember(Value = "IN_PROGRESS")] - INPROGRESS = 1, - - /// - /// Enum DONE for value: DONE - /// - [EnumMember(Value = "DONE")] - DONE = 2 - } - - - /// - /// Gets or Sets InitialSyncStatus - /// - - [JsonConverter(typeof(SafeEnumConverter))] - [DataMember(Name = "initial_sync_status", EmitDefaultValue = true)] - public InitialSyncStatusEnum? InitialSyncStatus - { - get{ return _InitialSyncStatus;} - set - { - _InitialSyncStatus = value; - _flagInitialSyncStatus = true; - } - } - private InitialSyncStatusEnum? _InitialSyncStatus; - private bool _flagInitialSyncStatus; - - /// - /// Returns false as InitialSyncStatus should not be serialized given that it's read-only. - /// - /// false (boolean) - public bool ShouldSerializeInitialSyncStatus() - { - return _flagInitialSyncStatus; - } - /// /// The type of the object represented by JSON. This object stores information about the customer segment. /// /// The type of the object represented by JSON. This object stores information about the customer segment. @@ -183,9 +137,8 @@ public bool ShouldSerializeObject() /// Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format.. /// Defines whether the segment is: - Active (`auto-update`): customers enter and leave the segment based on the defined filters and the `customer.segment.entered` and `customer.segment.left` events are triggered, - Passive (`passive`): customers enter and leave the segment based on the defined filters, but the `customer.segment.entered` and `customer.segment.left` events are not triggered, - Static (`static`): manually selected customers.. /// Defines a set of criteria for an `auto-update` or `passive` segment type.. - /// initialSyncStatus. /// The type of the object represented by JSON. This object stores information about the customer segment.. - public SegmentsGetResponseBody(string id = default(string), string name = default(string), DateTimeOffset? createdAt = default(DateTimeOffset?), TypeEnum? type = default(TypeEnum?), Object filter = default(Object), InitialSyncStatusEnum? initialSyncStatus = default(InitialSyncStatusEnum?), ObjectEnum? varObject = default(ObjectEnum?)) + public SegmentsGetResponseBody(string id = default(string), string name = default(string), DateTimeOffset? createdAt = default(DateTimeOffset?), TypeEnum? type = default(TypeEnum?), Object filter = default(Object), ObjectEnum? varObject = default(ObjectEnum?)) { this._Id = id; if (this.Id != null) @@ -212,11 +165,6 @@ public bool ShouldSerializeObject() { this._flagFilter = true; } - this._InitialSyncStatus = initialSyncStatus; - if (this.InitialSyncStatus != null) - { - this._flagInitialSyncStatus = true; - } this._Object = varObject; if (this.Object != null) { @@ -343,7 +291,6 @@ public override string ToString() sb.Append(" CreatedAt: ").Append(CreatedAt).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Filter: ").Append(Filter).Append("\n"); - sb.Append(" InitialSyncStatus: ").Append(InitialSyncStatus).Append("\n"); sb.Append(" Object: ").Append(Object).Append("\n"); sb.Append("}\n"); return sb.ToString(); diff --git a/src/Voucherify/Model/ValidationsValidateRequestBody.cs b/src/Voucherify/Model/ValidationsValidateRequestBody.cs index d74cbf84..4b7abf80 100644 --- a/src/Voucherify/Model/ValidationsValidateRequestBody.cs +++ b/src/Voucherify/Model/ValidationsValidateRequestBody.cs @@ -28,7 +28,7 @@ namespace Voucherify.Model { /// - /// Response body schema for **POST** `v1/validations`. + /// Request body schema for **POST** `v1/validations`. /// [DataContract(Name = "ValidationsValidateRequestBody")] public partial class ValidationsValidateRequestBody : IValidatableObject diff --git a/src/Voucherify/Model/ValidityHours.cs b/src/Voucherify/Model/ValidityHours.cs index 7f7e3446..51a7731b 100644 --- a/src/Voucherify/Model/ValidityHours.cs +++ b/src/Voucherify/Model/ValidityHours.cs @@ -36,7 +36,7 @@ public partial class ValidityHours : IValidatableObject /// /// Initializes a new instance of the class. /// - /// Defines the reccuring period(s) when the resource is active. The periods should not overlap.. + /// Defines the recurring period(s) when the resource is active. The periods should not overlap.. public ValidityHours(List daily = default(List)) { this._Daily = daily; @@ -47,9 +47,9 @@ public partial class ValidityHours : IValidatableObject } /// - /// Defines the reccuring period(s) when the resource is active. The periods should not overlap. + /// Defines the recurring period(s) when the resource is active. The periods should not overlap. /// - /// Defines the reccuring period(s) when the resource is active. The periods should not overlap. + /// Defines the recurring period(s) when the resource is active. The periods should not overlap. [DataMember(Name = "daily", EmitDefaultValue = true)] public List Daily { diff --git a/src/Voucherify/Model/ValidityHoursDailyItem.cs b/src/Voucherify/Model/ValidityHoursDailyItem.cs index dfac8639..7a67be83 100644 --- a/src/Voucherify/Model/ValidityHoursDailyItem.cs +++ b/src/Voucherify/Model/ValidityHoursDailyItem.cs @@ -28,7 +28,7 @@ namespace Voucherify.Model { /// - /// Defines the reccuring period(s) when the resource will be active. + /// Defines the recurring period(s) when the resource will be active. /// [DataContract(Name = "ValidityHoursDailyItem")] public partial class ValidityHoursDailyItem : IValidatableObject diff --git a/src/Voucherify/Model/VoucherTransaction.cs b/src/Voucherify/Model/VoucherTransaction.cs index 645112b8..315bea87 100644 --- a/src/Voucherify/Model/VoucherTransaction.cs +++ b/src/Voucherify/Model/VoucherTransaction.cs @@ -152,7 +152,7 @@ public bool ShouldSerializeType() /// The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.. /// Unique voucher ID.. /// Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.. - /// The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.. + /// The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.. /// Reason why the transaction occurred. In case of a redemption, this value is null.. /// The related transaction ID on the receiving card.. /// Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.. @@ -313,9 +313,9 @@ public bool ShouldSerializeCampaignId() return _flagCampaignId; } /// - /// The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + /// The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. /// - /// The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null. + /// The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null. [DataMember(Name = "source", EmitDefaultValue = true)] public string Source { diff --git a/src/Voucherify/Voucherify.csproj b/src/Voucherify/Voucherify.csproj index 9b9fe654..9b4c7efb 100644 --- a/src/Voucherify/Voucherify.csproj +++ b/src/Voucherify/Voucherify.csproj @@ -12,7 +12,7 @@ A library generated from a OpenAPI doc MIT Voucherify - 8.1.0 + 9.0.0 bin\$(Configuration)\$(TargetFramework)\Voucherify.xml https://github.com/voucherifyio/voucherify-dotNET-sdk git diff --git a/src/Voucherify/Voucherify.nuspec b/src/Voucherify/Voucherify.nuspec index be1b4662..76eb3c33 100644 --- a/src/Voucherify/Voucherify.nuspec +++ b/src/Voucherify/Voucherify.nuspec @@ -9,12 +9,18 @@ MIT https://github.com/voucherifyio/voucherify-dotNET-sdk false - 8.1.0 + 9.0.0 .Net SDK for Voucherify - coupons, vouchers, promo codes - http://www.voucherify.io MIT - 2024-10-21: 8.1.0 + 2025-12-14: 9.0.0 + - All POST requests now require a payload. As a result, the order of parameters in API method calls may have changed. If you encounter a build error, please check the documentation for the method you are calling. + β€” `OrdersImportCreateRequestBodyItem` no longer has `CreatedAt` property. + - `RelatedObjectParent` property `Amount` now is `int?` type, instead of `string?`. + - `SegmentsCreateResponseBody` and `SegmentsGetResponseBody` no longer have `InitialSyncStatus` property. + - Added support for advanced filtering while listing vouchers. + 2025-10-21: 8.1.0 - **Invalid/New Enums will be parsed as null** - **If a property is missing will be simply skipped, please ensure on your side if parameter is expected** - Added support for POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance