voucherify 8.0.1 → 8.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Dockerfile +1 -1
- data/ENDPOINTS-COVERAGE.md +69 -60
- data/Gemfile.lock +9 -7
- data/README.md +55 -2
- data/__tests__/spec/12_validation_rules_spec.rb +1 -15
- data/docs/AccessSettings.md +9 -0
- data/docs/AccessSettingsAssign.md +10 -0
- data/docs/AccessSettingsUnassign.md +10 -0
- data/docs/ApplicableTo.md +3 -2
- data/docs/ApplicableToOrderItemUnitsItem.md +9 -0
- data/docs/ApplicationDetailsItem.md +14 -0
- data/docs/AreaStoreCampaignAssignment.md +1 -0
- data/docs/BinApi.md +4 -4
- data/docs/Campaign.md +3 -3
- data/docs/CampaignBase.md +3 -2
- data/docs/CampaignsApi.md +3 -3
- data/docs/CampaignsCreateRequestBody.md +2 -1
- data/docs/CampaignsCreateResponseBody.md +3 -3
- data/docs/CampaignsGetResponseBody.md +3 -3
- data/docs/CampaignsUpdateRequestBody.md +3 -2
- data/docs/CampaignsUpdateResponseBody.md +3 -3
- data/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md +2 -1
- data/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md +2 -1
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItem.md +3 -2
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +1 -1
- data/docs/CustomerLoyalty.md +1 -1
- data/docs/Discount.md +1 -1
- data/docs/DiscountUnitMultipleOneUnit.md +1 -1
- data/docs/EarningRule.md +1 -0
- data/docs/EarningRulePendingPoints.md +9 -0
- data/docs/Error.md +1 -0
- data/docs/ErrorError.md +8 -0
- data/docs/EventSource.md +10 -0
- data/docs/EventSourceApiKey.md +9 -0
- data/docs/EventSourceUser.md +8 -0
- data/docs/InapplicableTo.md +3 -2
- data/docs/InapplicableToOrderItemUnitsItem.md +9 -0
- data/docs/LoyaltiesApi.md +334 -10
- data/docs/LoyaltiesCreateCampaignRequestBody.md +2 -1
- data/docs/LoyaltiesEarningRulesCreateResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesMembersBalanceUpdateResponseBody.md +1 -1
- data/docs/LoyaltiesMembersCreateResponseBodyLoyaltyCard.md +2 -1
- data/docs/LoyaltiesMembersGetResponseBodyLoyaltyCard.md +2 -1
- data/docs/LoyaltiesMembersPendingPointsActivateResponseBody.md +14 -0
- data/docs/LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject.md +9 -0
- data/docs/LoyaltiesMembersPendingPointsListResponseBody.md +12 -0
- data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItem.md +9 -9
- data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket.md +1 -1
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard.md +2 -1
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md +2 -1
- data/docs/LoyaltiesPendingPointsListResponseBody.md +12 -0
- data/docs/LoyaltiesUpdateCampaignRequestBody.md +3 -2
- data/docs/LoyaltyCardTransaction.md +2 -2
- data/docs/LoyaltyCardTransactionDetails.md +2 -0
- data/docs/LoyaltyCardTransactionDetailsBalance.md +5 -4
- data/docs/LoyaltyCardTransactionDetailsBalanceRelatedObject.md +1 -1
- data/docs/LoyaltyCardTransactionDetailsEarningRule.md +1 -1
- data/docs/LoyaltyCardTransactionDetailsHolderLoyaltyTier.md +9 -0
- data/docs/LoyaltyCardTransactionDetailsLoyaltyTier.md +2 -2
- data/docs/LoyaltyMemberLoyaltyCard.md +2 -1
- data/docs/LoyaltyPendingPoints.md +17 -0
- data/docs/LoyaltyPendingPointsDetails.md +12 -0
- data/docs/LoyaltyPendingPointsDetailsEarningRule.md +9 -0
- data/docs/LoyaltyPendingPointsDetailsEarningRuleSource.md +8 -0
- data/docs/LoyaltyPendingPointsDetailsEvent.md +14 -0
- data/docs/LoyaltyPendingPointsDetailsHolderLoyaltyTier.md +9 -0
- data/docs/LoyaltyPendingPointsDetailsLoyaltyTier.md +9 -0
- data/docs/LoyaltyPendingPointsDetailsOrder.md +9 -0
- data/docs/LoyaltyPointsBucket.md +16 -0
- data/docs/LoyaltyPointsBucketBucket.md +8 -0
- data/docs/LoyaltyTierExpiration.md +1 -1
- data/docs/Order.md +3 -3
- data/docs/OrderCalculated.md +12 -12
- data/docs/OrderCalculatedItem.md +2 -1
- data/docs/OrderCalculatedItemProduct.md +1 -1
- data/docs/OrderCalculatedItemSku.md +1 -0
- data/docs/OrderItem.md +1 -1
- data/docs/OrderItemProduct.md +1 -1
- data/docs/OrderItemSku.md +1 -0
- data/docs/OrderRedemptionsEntry.md +1 -1
- data/docs/OrdersCreateRequestBody.md +3 -3
- data/docs/OrdersCreateResponseBody.md +12 -12
- data/docs/OrdersGetResponseBody.md +12 -12
- data/docs/OrdersImportCreateRequestBodyItem.md +3 -3
- data/docs/OrdersUpdateRequestBody.md +3 -3
- data/docs/OrdersUpdateResponseBody.md +12 -12
- data/docs/ParameterOrderListPendingPoints.md +7 -0
- data/docs/Product.md +1 -1
- data/docs/ProductCollectionsProductsListResponseBodyDataItem.md +1 -1
- data/docs/ProductWithoutSkus.md +1 -1
- data/docs/ProductsCreateResponseBody.md +1 -1
- data/docs/ProductsGetResponseBody.md +1 -1
- data/docs/ProductsSkusCreateResponseBody.md +1 -1
- data/docs/ProductsSkusUpdateResponseBody.md +1 -1
- data/docs/ProductsUpdateResponseBody.md +1 -1
- data/docs/RedeemableLoyaltyCard.md +1 -1
- data/docs/RedeemableVoucherLoyaltyCard.md +2 -1
- data/docs/RedemptionEntryOrder.md +12 -12
- data/docs/RedemptionEntryVoucherLoyaltyCard.md +2 -1
- data/docs/RedemptionVoucherLoyaltyCard.md +2 -1
- data/docs/RedemptionsGetResponseBodyOrder.md +12 -12
- data/docs/RedemptionsGetResponseBodyVoucherLoyaltyCard.md +2 -1
- data/docs/RedemptionsListResponseBodyRedemptionsItemOrder.md +12 -12
- data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard.md +2 -1
- data/docs/SimpleLoyaltyCard.md +2 -1
- data/docs/Sku.md +1 -1
- data/docs/SkusGetResponseBody.md +1 -1
- data/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +2 -1
- data/docs/ValidationsRedeemableInapplicable.md +3 -2
- data/docs/ValidationsRedeemableSkipped.md +3 -2
- data/docs/ValidationsValidateResponseBodyRedeemablesItem.md +3 -2
- data/docs/ValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +1 -1
- data/docs/VoucherBalance.md +14 -0
- data/docs/VoucherBalanceRelatedObject.md +9 -0
- data/docs/VoucherLoyaltyCard.md +2 -1
- data/docs/VoucherTransaction.md +2 -2
- data/docs/VoucherTransactionDetails.md +2 -0
- data/docs/VoucherTransactionDetailsBalance.md +5 -4
- data/docs/VoucherTransactionDetailsBalanceRelatedObject.md +1 -1
- data/docs/VoucherTransactionDetailsCustomEvent.md +2 -2
- data/docs/VoucherTransactionDetailsEarningRule.md +1 -1
- data/docs/VoucherTransactionDetailsEventSchema.md +2 -2
- data/docs/VoucherTransactionDetailsHolderLoyaltyTier.md +9 -0
- data/docs/VoucherTransactionDetailsLoyaltyTier.md +2 -2
- data/docs/VoucherTransactionDetailsRollback.md +1 -1
- data/docs/VoucherTransactionDetailsSegment.md +2 -2
- data/docs/VoucherWithCategoriesLoyaltyCard.md +2 -1
- data/docs/VouchersApi.md +6 -6
- data/docs/VouchersBalanceUpdateResponseBody.md +1 -1
- data/docs/VouchersCreateResponseBodyLoyaltyCard.md +2 -1
- data/docs/VouchersDisableResponseBodyLoyaltyCard.md +2 -1
- data/docs/VouchersEnableResponseBodyLoyaltyCard.md +2 -1
- data/docs/VouchersGetResponseBodyLoyaltyCard.md +2 -1
- data/docs/VouchersUpdateResponseBodyLoyaltyCard.md +2 -1
- data/lib/VoucherifySdk/api/bin_api.rb +4 -4
- data/lib/VoucherifySdk/api/campaigns_api.rb +4 -4
- data/lib/VoucherifySdk/api/loyalties_api.rb +334 -8
- data/lib/VoucherifySdk/api/vouchers_api.rb +10 -10
- data/lib/VoucherifySdk/models/access_settings.rb +219 -0
- data/lib/VoucherifySdk/models/access_settings_assign.rb +238 -0
- data/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb +1 -1
- data/lib/VoucherifySdk/models/access_settings_unassign.rb +238 -0
- data/lib/VoucherifySdk/models/applicable_to.rb +16 -3
- data/lib/VoucherifySdk/models/applicable_to_order_item_units_item.rb +220 -0
- data/lib/VoucherifySdk/models/application_details_item.rb +284 -0
- data/lib/VoucherifySdk/models/area_store_campaign_assignment.rb +12 -1
- data/lib/VoucherifySdk/models/campaign.rb +16 -16
- data/lib/VoucherifySdk/models/campaign_base.rb +16 -7
- data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +11 -2
- data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +16 -16
- data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +16 -16
- data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +12 -3
- data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +16 -16
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item.rb +18 -7
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_discount.rb +1 -0
- data/lib/VoucherifySdk/models/customer_loyalty.rb +1 -1
- data/lib/VoucherifySdk/models/discount.rb +1 -0
- data/lib/VoucherifySdk/models/discount_unit_multiple_one_unit.rb +1 -0
- data/lib/VoucherifySdk/models/earning_rule.rb +11 -1
- data/lib/VoucherifySdk/models/earning_rule_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/error.rb +15 -5
- data/lib/VoucherifySdk/models/error_error.rb +210 -0
- data/lib/VoucherifySdk/models/event_source.rb +254 -0
- data/lib/VoucherifySdk/models/event_source_api_key.rb +221 -0
- data/lib/VoucherifySdk/models/event_source_user.rb +210 -0
- data/lib/VoucherifySdk/models/inapplicable_to.rb +16 -3
- data/lib/VoucherifySdk/models/inapplicable_to_order_item_units_item.rb +220 -0
- data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb +11 -2
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_members_balance_update_response_body.rb +1 -0
- data/lib/VoucherifySdk/models/loyalties_members_create_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/loyalties_members_get_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body.rb +309 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body_related_object.rb +247 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item.rb +27 -77
- data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item_bucket.rb +3 -9
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/loyalties_pending_points_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb +12 -3
- data/lib/VoucherifySdk/models/loyalty_card_transaction.rb +24 -31
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details.rb +20 -2
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance.rb +18 -19
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance_related_object.rb +1 -7
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_earning_rule.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_holder_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_loyalty_tier.rb +3 -1
- data/lib/VoucherifySdk/models/loyalty_card_transactions_type.rb +2 -1
- data/lib/VoucherifySdk/models/loyalty_member_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/loyalty_pending_points.rb +314 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details.rb +249 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule.rb +220 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule_source.rb +210 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_event.rb +302 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_holder_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_order.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_points_bucket.rb +323 -0
- data/lib/VoucherifySdk/models/loyalty_points_bucket_bucket.rb +210 -0
- data/lib/VoucherifySdk/models/loyalty_tier_expiration.rb +1 -1
- data/lib/VoucherifySdk/models/order.rb +3 -3
- data/lib/VoucherifySdk/models/order_calculated.rb +29 -29
- data/lib/VoucherifySdk/models/order_calculated_item.rb +18 -6
- data/lib/VoucherifySdk/models/order_calculated_item_product.rb +1 -1
- data/lib/VoucherifySdk/models/order_calculated_item_sku.rb +16 -5
- data/lib/VoucherifySdk/models/order_item.rb +1 -1
- data/lib/VoucherifySdk/models/order_item_product.rb +1 -1
- data/lib/VoucherifySdk/models/order_item_sku.rb +16 -5
- data/lib/VoucherifySdk/models/order_redemptions_entry.rb +1 -1
- data/lib/VoucherifySdk/models/orders_create_request_body.rb +3 -3
- data/lib/VoucherifySdk/models/orders_create_response_body.rb +29 -29
- data/lib/VoucherifySdk/models/orders_get_response_body.rb +29 -29
- data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +3 -3
- data/lib/VoucherifySdk/models/orders_update_request_body.rb +3 -3
- data/lib/VoucherifySdk/models/orders_update_response_body.rb +29 -29
- data/lib/VoucherifySdk/models/parameter_expand_list_campaigns.rb +2 -1
- data/lib/VoucherifySdk/models/parameter_order_list_pending_points.rb +40 -0
- data/lib/VoucherifySdk/models/product.rb +1 -1
- data/lib/VoucherifySdk/models/product_collections_products_list_response_body_data_item.rb +1 -1
- data/lib/VoucherifySdk/models/product_without_skus.rb +1 -1
- data/lib/VoucherifySdk/models/products_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_get_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_skus_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_skus_update_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/products_update_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/qualifications_option.rb +3 -3
- data/lib/VoucherifySdk/models/redeemable_loyalty_card.rb +1 -1
- data/lib/VoucherifySdk/models/redeemable_voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/redemption_entry_order.rb +29 -29
- data/lib/VoucherifySdk/models/redemption_entry_voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/redemption_voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/redemptions_get_response_body_order.rb +29 -29
- data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_order.rb +28 -29
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/simple_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/sku.rb +1 -1
- data/lib/VoucherifySdk/models/skus_get_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body.rb +11 -2
- data/lib/VoucherifySdk/models/validations_redeemable_inapplicable.rb +18 -7
- data/lib/VoucherifySdk/models/validations_redeemable_skipped.rb +18 -7
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item.rb +18 -7
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_discount.rb +1 -0
- data/lib/VoucherifySdk/models/voucher_balance.rb +305 -0
- data/lib/VoucherifySdk/models/voucher_balance_related_object.rb +247 -0
- data/lib/VoucherifySdk/models/voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/voucher_transaction.rb +27 -31
- data/lib/VoucherifySdk/models/voucher_transaction_details.rb +20 -2
- data/lib/VoucherifySdk/models/voucher_transaction_details_balance.rb +18 -19
- data/lib/VoucherifySdk/models/voucher_transaction_details_balance_related_object.rb +1 -7
- data/lib/VoucherifySdk/models/voucher_transaction_details_custom_event.rb +2 -2
- data/lib/VoucherifySdk/models/voucher_transaction_details_earning_rule.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_event_schema.rb +2 -2
- data/lib/VoucherifySdk/models/voucher_transaction_details_holder_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_loyalty_tier.rb +3 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_rollback.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_segment.rb +2 -0
- data/lib/VoucherifySdk/models/voucher_with_categories_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/vouchers_balance_update_response_body.rb +1 -0
- data/lib/VoucherifySdk/models/vouchers_create_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/vouchers_disable_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/vouchers_enable_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/vouchers_get_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/vouchers_update_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/version.rb +1 -1
- data/lib/VoucherifySdk.rb +35 -0
- metadata +106 -36
@@ -4,6 +4,6 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** |
|
8
|
-
| **name** | **String** |
|
7
|
+
| **id** | **String** | Unique identifier of the loyalty tier, assigned by Voucherify. | [optional] |
|
8
|
+
| **name** | **String** | User-defined name of the loyalty tier. | [optional] |
|
9
9
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** |
|
8
|
-
| **name** | **String** |
|
7
|
+
| **id** | **String** | Unique identifier of the segment. | [optional] |
|
8
|
+
| **name** | **String** | Name of the segment. | [optional] |
|
9
9
|
|
@@ -4,8 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card. | [optional] |
|
7
|
+
| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card, minus the expired points. | [optional] |
|
8
8
|
| **balance** | **Integer** | Points available for reward redemption. | [optional] |
|
9
9
|
| **next_expiration_date** | **Date** | The next closest date when the next set of points are due to expire. | [optional] |
|
10
10
|
| **next_expiration_points** | **Integer** | The amount of points that are set to expire next. | [optional] |
|
11
|
+
| **pending_points** | **Integer** | Determines the number of pending points that will be added to the loyalty card after the predefined time. | [optional] |
|
11
12
|
|
data/docs/VouchersApi.md
CHANGED
@@ -28,7 +28,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
28
28
|
|
29
29
|
Create Voucher
|
30
30
|
|
31
|
-
Create a standalone voucher. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters.
|
31
|
+
Create a standalone voucher. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new standalone voucher 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 the case of the loyalty card, a campaign name or ID is required. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), 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 standalone voucher campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004) for more details about released features.
|
32
32
|
|
33
33
|
### Examples
|
34
34
|
|
@@ -290,7 +290,7 @@ end
|
|
290
290
|
api_instance = VoucherifySdk::VouchersApi.new
|
291
291
|
code = 'GIFT-CARD-1' # String | A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
|
292
292
|
opts = {
|
293
|
-
vouchers_transactions_export_create_request_body: VoucherifySdk::VouchersTransactionsExportCreateRequestBody.new # VouchersTransactionsExportCreateRequestBody | Specify the parameters for the transaction export.
|
293
|
+
vouchers_transactions_export_create_request_body: VoucherifySdk::VouchersTransactionsExportCreateRequestBody.new # VouchersTransactionsExportCreateRequestBody | Specify the parameters for the camapign transaction export.
|
294
294
|
}
|
295
295
|
|
296
296
|
begin
|
@@ -307,7 +307,7 @@ end
|
|
307
307
|
| Name | Type | Description | Notes |
|
308
308
|
| ---- | ---- | ----------- | ----- |
|
309
309
|
| **code** | **String** | A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. | |
|
310
|
-
| **vouchers_transactions_export_create_request_body** | [**VouchersTransactionsExportCreateRequestBody**](VouchersTransactionsExportCreateRequestBody.md) | Specify the parameters for the transaction export. | [optional] |
|
310
|
+
| **vouchers_transactions_export_create_request_body** | [**VouchersTransactionsExportCreateRequestBody**](VouchersTransactionsExportCreateRequestBody.md) | Specify the parameters for the camapign transaction export. | [optional] |
|
311
311
|
|
312
312
|
### Return type
|
313
313
|
|
@@ -329,7 +329,7 @@ end
|
|
329
329
|
|
330
330
|
Generate Random Code
|
331
331
|
|
332
|
-
Create a standalone voucher. 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
|
332
|
+
Create a standalone voucher. 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 standalone voucher 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), 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 standalone voucher campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004) for more details about released features.
|
333
333
|
|
334
334
|
### Examples
|
335
335
|
|
@@ -447,7 +447,7 @@ end
|
|
447
447
|
|
448
448
|
Import Vouchers
|
449
449
|
|
450
|
-
Import 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.
|
450
|
+
Import 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. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), 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.
|
451
451
|
|
452
452
|
### Examples
|
453
453
|
|
@@ -505,7 +505,7 @@ end
|
|
505
505
|
|
506
506
|
Import Vouchers using CSV
|
507
507
|
|
508
|
-
Import 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 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 norms. 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. 📘 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 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.
|
508
|
+
Import 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 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 norms. 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. 📘 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 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. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), 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.
|
509
509
|
|
510
510
|
### Examples
|
511
511
|
|
@@ -8,7 +8,7 @@
|
|
8
8
|
| **total** | **Integer** | Total income incurred over the lifespan of the gift card or loyalty card. | [optional] |
|
9
9
|
| **balance** | **Integer** | The balance after adding or subtracting a specified amount. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | [optional] |
|
10
10
|
| **type** | **String** | The type of voucher being modified. | [optional] |
|
11
|
-
| **operation_type** | **String** |
|
11
|
+
| **operation_type** | **String** | The type of the operation being performed. | [optional][default to 'MANUAL'] |
|
12
12
|
| **object** | **String** | The type of the object represented by JSON. Default is `balance`. | [optional][default to 'balance'] |
|
13
13
|
| **related_object** | [**VouchersBalanceUpdateResponseBodyRelatedObject**](VouchersBalanceUpdateResponseBodyRelatedObject.md) | | [optional] |
|
14
14
|
|
@@ -4,8 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card. | [optional] |
|
7
|
+
| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card, minus the expired points. | [optional] |
|
8
8
|
| **balance** | **Integer** | Points available for reward redemption. | [optional] |
|
9
9
|
| **next_expiration_date** | **Date** | The next closest date when the next set of points are due to expire. | [optional] |
|
10
10
|
| **next_expiration_points** | **Integer** | The amount of points that are set to expire next. | [optional] |
|
11
|
+
| **pending_points** | **Integer** | Determines the number of pending points that will be added to the loyalty card after the predefined time. | [optional] |
|
11
12
|
|
@@ -4,8 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card. | [optional] |
|
7
|
+
| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card, minus the expired points. | [optional] |
|
8
8
|
| **balance** | **Integer** | Points available for reward redemption. | [optional] |
|
9
9
|
| **next_expiration_date** | **Date** | The next closest date when the next set of points are due to expire. | [optional] |
|
10
10
|
| **next_expiration_points** | **Integer** | The amount of points that are set to expire next. | [optional] |
|
11
|
+
| **pending_points** | **Integer** | Determines the number of pending points that will be added to the loyalty card after the predefined time. | [optional] |
|
11
12
|
|
@@ -4,8 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card. | [optional] |
|
7
|
+
| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card, minus the expired points. | [optional] |
|
8
8
|
| **balance** | **Integer** | Points available for reward redemption. | [optional] |
|
9
9
|
| **next_expiration_date** | **Date** | The next closest date when the next set of points are due to expire. | [optional] |
|
10
10
|
| **next_expiration_points** | **Integer** | The amount of points that are set to expire next. | [optional] |
|
11
|
+
| **pending_points** | **Integer** | Determines the number of pending points that will be added to the loyalty card after the predefined time. | [optional] |
|
11
12
|
|
@@ -4,8 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card. | [optional] |
|
7
|
+
| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card, minus the expired points. | [optional] |
|
8
8
|
| **balance** | **Integer** | Points available for reward redemption. | [optional] |
|
9
9
|
| **next_expiration_date** | **Date** | The next closest date when the next set of points are due to expire. | [optional] |
|
10
10
|
| **next_expiration_points** | **Integer** | The amount of points that are set to expire next. | [optional] |
|
11
|
+
| **pending_points** | **Integer** | Determines the number of pending points that will be added to the loyalty card after the predefined time. | [optional] |
|
11
12
|
|
@@ -4,8 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card. | [optional] |
|
7
|
+
| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card, minus the expired points. | [optional] |
|
8
8
|
| **balance** | **Integer** | Points available for reward redemption. | [optional] |
|
9
9
|
| **next_expiration_date** | **Date** | The next closest date when the next set of points are due to expire. | [optional] |
|
10
10
|
| **next_expiration_points** | **Integer** | The amount of points that are set to expire next. | [optional] |
|
11
|
+
| **pending_points** | **Integer** | Determines the number of pending points that will be added to the loyalty card after the predefined time. | [optional] |
|
11
12
|
|
@@ -80,8 +80,8 @@ module VoucherifySdk
|
|
80
80
|
# Retrieves a list of resources moved to the bin. The following resources can be moved to the bin: - campaigns - vouchers - products - SKUs To use this endpoint, you must have the following permissions: - vouchers.read - campaigns.read - products.read
|
81
81
|
# @param [Hash] opts the optional parameters
|
82
82
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
83
|
-
# @option opts [ParameterOrderListBin] :order Orders the bin entries according
|
84
|
-
# @option opts [String] :starting_after_id A cursor for pagination. It retrieves the
|
83
|
+
# @option opts [ParameterOrderListBin] :order Orders the bin entries according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order.
|
84
|
+
# @option opts [String] :starting_after_id A cursor for pagination. It retrieves the results starting after a result with the given ID.
|
85
85
|
# @option opts [ParameterFiltersListBin] :filters Filters for listing bin entries.
|
86
86
|
# @return [TrashBinListResponseBody]
|
87
87
|
def list_bin_entries(opts = {})
|
@@ -93,8 +93,8 @@ module VoucherifySdk
|
|
93
93
|
# Retrieves a list of resources moved to the bin. The following resources can be moved to the bin: - campaigns - vouchers - products - SKUs To use this endpoint, you must have the following permissions: - vouchers.read - campaigns.read - products.read
|
94
94
|
# @param [Hash] opts the optional parameters
|
95
95
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
96
|
-
# @option opts [ParameterOrderListBin] :order Orders the bin entries according
|
97
|
-
# @option opts [String] :starting_after_id A cursor for pagination. It retrieves the
|
96
|
+
# @option opts [ParameterOrderListBin] :order Orders the bin entries according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order.
|
97
|
+
# @option opts [String] :starting_after_id A cursor for pagination. It retrieves the results starting after a result with the given ID.
|
98
98
|
# @option opts [ParameterFiltersListBin] :filters Filters for listing bin entries.
|
99
99
|
# @return [Array<(TrashBinListResponseBody, Integer, Hash)>] TrashBinListResponseBody data, response status code and response headers
|
100
100
|
private def list_bin_entries_with_http_info(opts = {})
|
@@ -157,7 +157,7 @@ module VoucherifySdk
|
|
157
157
|
end
|
158
158
|
|
159
159
|
# Create Campaign
|
160
|
-
# 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 description.
|
160
|
+
# 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 description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), 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#v20241004) for more details about released features.
|
161
161
|
# @param [Hash] opts the optional parameters
|
162
162
|
# @option opts [CampaignsCreateRequestBody] :campaigns_create_request_body Specify the details of the campaign that you would like to create.
|
163
163
|
# @return [CampaignsCreateResponseBody]
|
@@ -167,7 +167,7 @@ module VoucherifySdk
|
|
167
167
|
end
|
168
168
|
|
169
169
|
# Create Campaign
|
170
|
-
# 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 description.
|
170
|
+
# 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 description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), 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#v20241004) for more details about released features.
|
171
171
|
# @param [Hash] opts the optional parameters
|
172
172
|
# @option opts [CampaignsCreateRequestBody] :campaigns_create_request_body Specify the details of the campaign that you would like to create.
|
173
173
|
# @return [Array<(CampaignsCreateResponseBody, Integer, Hash)>] CampaignsCreateResponseBody data, response status code and response headers
|
@@ -598,7 +598,7 @@ module VoucherifySdk
|
|
598
598
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
599
599
|
# @option opts [Integer] :page Which page of results to return. The lowest value is 1.
|
600
600
|
# @option opts [ParameterCampaignType] :campaign_type This attribute allows filtering by campaign type.
|
601
|
-
# @option opts [ParameterExpandListCampaigns] :expand
|
601
|
+
# @option opts [ParameterExpandListCampaigns] :expand Includes an expanded categories object in the response. If the [Areas and Stores](https://support.voucherify.io/article/623-areas-and-stores) Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores.
|
602
602
|
# @option opts [ParameterOrderListCampaigns] :order Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
603
603
|
# @option opts [ParameterFiltersListCampaigns] :filters Filters the results by campaign status or whether the campaign is a referral campaign.
|
604
604
|
# @return [CampaignsListResponseBody]
|
@@ -613,7 +613,7 @@ module VoucherifySdk
|
|
613
613
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
614
614
|
# @option opts [Integer] :page Which page of results to return. The lowest value is 1.
|
615
615
|
# @option opts [ParameterCampaignType] :campaign_type This attribute allows filtering by campaign type.
|
616
|
-
# @option opts [ParameterExpandListCampaigns] :expand
|
616
|
+
# @option opts [ParameterExpandListCampaigns] :expand Includes an expanded categories object in the response. If the [Areas and Stores](https://support.voucherify.io/article/623-areas-and-stores) Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores.
|
617
617
|
# @option opts [ParameterOrderListCampaigns] :order Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
|
618
618
|
# @option opts [ParameterFiltersListCampaigns] :filters Filters the results by campaign status or whether the campaign is a referral campaign.
|
619
619
|
# @return [Array<(CampaignsListResponseBody, Integer, Hash)>] CampaignsListResponseBody data, response status code and response headers
|