You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/BusValRuleAssignment.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -12,9 +12,9 @@ Assignments of business validation rule
12
12
|**ruleId**|**String**| The unique identifier for a rule ||
13
13
|**relatedObjectId**|**String**| The unique identifier for a related object ||
14
14
|**relatedObjectType**|**String**| The type of related object ||
15
-
|**createdAt**|**OffsetDateTime**| Timestamp representing the date and time when the object was created in ISO 8601 format. |[optional]|
15
+
|**createdAt**|**OffsetDateTime**| Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. |[optional]|
16
16
|**updatedAt**|**OffsetDateTime**| Timestamp representing the date and time when the object was last updated in ISO 8601 format. |[optional]|
17
-
|**_object**|[**ObjectEnum**](#ObjectEnum)| The type of object represented by JSON. ||
17
+
|**_object**|[**ObjectEnum**](#ObjectEnum)| The type of the object represented by JSON. ||
18
18
|**validationStatus**|[**ValidationStatusEnum**](#ValidationStatusEnum)| The validation status of the assignment |[optional]|
19
19
|**validationOmittedRules**|**List<String>**| The list of omitted rules |[optional]|
Copy file name to clipboardexpand all lines: docs/Campaign.md
+20-5
Original file line number
Diff line number
Diff line change
@@ -17,22 +17,23 @@
17
17
|**joinOnce**|**Boolean**| If this value is set to `true`, customers will be able to join the campaign only once. ||
18
18
|**useVoucherMetadataSchema**|**Boolean**| Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. ||
|**validityDayOfWeek**|**List<Integer>**| Integer array corresponding to the particular days of the week in which the campaign is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday |[optional]|
20
+
|**validityDayOfWeek**|[**List<ValidityDayOfWeekEnum>**](#List<ValidityDayOfWeekEnum>)| Integer array corresponding to the particular days of the week in which the campaign is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday |[optional]|
|**activityDurationAfterPublishing**|**String**| Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a `duration` of `P24D` will be valid for a duration of 24 days. |[optional]|
22
23
|**vouchersCount**|**Integer**| Total number of unique vouchers in campaign. |[optional]|
23
24
|**startDate**|**OffsetDateTime**| Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date. |[optional]|
24
25
|**expirationDate**|**OffsetDateTime**| Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is *inactive after* this date. |[optional]|
25
26
|**active**|**Boolean**| A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign |[optional]|
26
27
|**metadata**|**Object**| The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. |[optional]|
27
-
|**createdAt**|**OffsetDateTime**| Timestamp representing the date and time when the campaign was created in ISO 8601 format. ||
28
-
|**updatedAt**|**OffsetDateTime**| Timestamp representing the date and time when the voucher was updated in ISO 8601 format. |[optional]|
28
+
|**createdAt**|**OffsetDateTime**| Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. ||
29
+
|**updatedAt**|**OffsetDateTime**| Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. |[optional]|
|**creationStatus**|[**CreationStatusEnum**](#CreationStatusEnum)| Indicates the status of the campaign creation. ||
31
-
|**vouchersGenerationStatus**|[**VouchersGenerationStatusEnum**](#VouchersGenerationStatusEnum)| Indicates the status of the campaign's vouchers. ||
32
+
|**vouchersGenerationStatus**|[**VouchersGenerationStatusEnum**](#VouchersGenerationStatusEnum)| Indicates the status of the campaign's voucher generation. ||
32
33
|**_protected**|**Boolean**| Indicates whether the resource can be deleted. ||
33
34
|**categoryId**|**String**| Unique category ID that this campaign belongs to. |[optional]|
34
35
|**categories**|[**List<Category>**](Category.md)| Contains details about the category. ||
35
-
|**_object**|**String**| The type of object represented by JSON. This object stores information about the campaign. ||
36
+
|**_object**|**String**| The type of the object represented by JSON. This object stores information about the campaign. ||
Copy file name to clipboardexpand all lines: docs/CampaignBase.md
+20-5
Original file line number
Diff line number
Diff line change
@@ -18,22 +18,23 @@ This is an object representing a campaign.
18
18
|**joinOnce**|**Boolean**| If this value is set to `true`, customers will be able to join the campaign only once. ||
19
19
|**useVoucherMetadataSchema**|**Boolean**| Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. ||
|**validityDayOfWeek**|**List<Integer>**| Integer array corresponding to the particular days of the week in which the campaign is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday |[optional]|
21
+
|**validityDayOfWeek**|[**List<ValidityDayOfWeekEnum>**](#List<ValidityDayOfWeekEnum>)| Integer array corresponding to the particular days of the week in which the campaign is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday |[optional]|
|**activityDurationAfterPublishing**|**String**| Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a `duration` of `P24D` will be valid for a duration of 24 days. |[optional]|
23
24
|**vouchersCount**|**Integer**| Total number of unique vouchers in campaign. |[optional]|
24
25
|**startDate**|**OffsetDateTime**| Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date. |[optional]|
25
26
|**expirationDate**|**OffsetDateTime**| Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is *inactive after* this date. |[optional]|
26
27
|**active**|**Boolean**| A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign |[optional]|
27
28
|**metadata**|**Object**| The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. |[optional]|
28
-
|**createdAt**|**OffsetDateTime**| Timestamp representing the date and time when the campaign was created in ISO 8601 format. ||
29
-
|**updatedAt**|**OffsetDateTime**| Timestamp representing the date and time when the voucher was updated in ISO 8601 format. |[optional]|
29
+
|**createdAt**|**OffsetDateTime**| Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. ||
30
+
|**updatedAt**|**OffsetDateTime**| Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. |[optional]|
|**creationStatus**|[**CreationStatusEnum**](#CreationStatusEnum)| Indicates the status of the campaign creation. ||
32
-
|**vouchersGenerationStatus**|[**VouchersGenerationStatusEnum**](#VouchersGenerationStatusEnum)| Indicates the status of the campaign's vouchers. ||
33
+
|**vouchersGenerationStatus**|[**VouchersGenerationStatusEnum**](#VouchersGenerationStatusEnum)| Indicates the status of the campaign's voucher generation. ||
33
34
|**_protected**|**Boolean**| Indicates whether the resource can be deleted. ||
34
35
|**categoryId**|**String**| Unique category ID that this campaign belongs to. |[optional]|
35
36
|**categories**|[**List<Category>**](Category.md)| Contains details about the category. ||
36
-
|**_object**|**String**| The type of object represented by JSON. This object stores information about the campaign. ||
37
+
|**_object**|**String**| The type of the object represented by JSON. This object stores information about the campaign. ||
Copy file name to clipboardexpand all lines: docs/CampaignVoucher.md
+16
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,22 @@ Schema model for a campaign voucher.
18
18
|**startDate**|**OffsetDateTime**| Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date. |[optional]|
19
19
|**expirationDate**|**OffsetDateTime**| Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is *inactive after* this date. |[optional]|
|**validityDayOfWeek**|[**List<ValidityDayOfWeekEnum>**](#List<ValidityDayOfWeekEnum>)| Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday |[optional]|
Copy file name to clipboardexpand all lines: docs/CampaignsApi.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -256,7 +256,7 @@ public class Example {
256
256
257
257
Delete Campaign
258
258
259
-
Permanently deletes a campaign and all related vouchers. This action cannot be undone. Also, this method immediately removes any redemptions on the voucher. 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](ref:get-async-action).
259
+
Deletes a campaign and all related vouchers. This action cannot be undone. Also, this method immediately removes any redemptions on the voucher. If the `force` parameter is set to `false` or not set at all, the campaign and all related vouchers will be moved to [the bin](ref:list-bin-entries). 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](ref:get-async-action).
String 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.
290
-
Boolean force =true; // Boolean | If this flag is set to `true`, the campaign and related vouchers will be removed permanently. Going forward, the user will be able to create the next campaign with exactly the same name.
290
+
Boolean force =true; // Boolean | If this flag is set to `true`, the campaign and related vouchers will be removed permanently. If it is set to `false` or not set at all, the campaign and related vouchers will be moved to the bin. Going forward, the user will be able to create the next campaign with exactly the same name.
291
291
try {
292
292
CampaignsDeleteResponseBody result = apiInstance.deleteCampaign(campaignId, force);
|**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. ||
310
-
|**force**|**Boolean**| If this flag is set to `true`, the campaign and related vouchers will be removed permanently. Going forward, the user will be able to create the next campaign with exactly the same name. |[optional]|
310
+
|**force**|**Boolean**| If this flag is set to `true`, the campaign and related vouchers will be removed permanently. If it is set to `false` or not set at all, the campaign and related vouchers will be moved to the bin. Going forward, the user will be able to create the next campaign with exactly the same name. |[optional]|
Integer limit =56; // Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
746
-
Integer page =56; // Integer | Which page of results to return.
745
+
Integer limit =56; // Integer | 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.
746
+
Integer page =56; // Integer | Which page of results to return. The lowest value is `1`.
747
747
ParameterCampaignType campaignType =ParameterCampaignType.fromValue("PROMOTION"); // ParameterCampaignType | This attribute allows filtering by campaign type.
748
748
ParameterExpandListCampaigns expand =ParameterExpandListCampaigns.fromValue("category"); // ParameterExpandListCampaigns | Include an expanded `categories` object in the response.
749
749
ParameterOrderListCampaigns order =ParameterOrderListCampaigns.fromValue("created_at"); // ParameterOrderListCampaigns | Sorts the results using one of the filtering options, where the dash `-` preceding a sorting option means sorting in a descending order.
|**limit**|**Integer**|A limit on the number of objects to be returned. Limit can range between 1 and 100 items. |[optional]|
769
-
|**page**|**Integer**| Which page of results to return. |[optional]|
768
+
|**limit**|**Integer**|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. |[optional]|
769
+
|**page**|**Integer**| Which page of results to return. The lowest value is `1`. |[optional]|
770
770
|**campaignType**|[**ParameterCampaignType**](.md)| This attribute allows filtering by campaign type. |[optional][enum: PROMOTION, GIFT_VOUCHERS, REFERRAL_PROGRAM, DISCOUNT_COUPONS, LOYALTY_PROGRAM, LUCKY_DRAW]|
771
771
|**expand**|[**ParameterExpandListCampaigns**](.md)| Include an expanded `categories` object in the response. |[optional][default to category][enum: category]|
772
772
|**order**|[**ParameterOrderListCampaigns**](.md)| Sorts the results using one of the filtering options, where the dash `-` preceding a sorting option means sorting in a descending order. |[optional][enum: created_at, -created_at, updated_at, -updated_at]|
0 commit comments