@voucherify/sdk 2.9.4 → 3.0.0

package/docs/ManagementProjectsBrandingUpdateRequestBodyContact.md

@@ -0,0 +1,10 @@
+# Voucherify.ManagementProjectsBrandingUpdateRequestBodyContact
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Defines the brand's email address. It must be a valid email format. | [optional] 
+**phone** | **String** | Defines the brand's phone number. | [optional] 
+
+

package/docs/ManagementProjectsBrandingUpdateResponseBody.md

@@ -0,0 +1,13 @@
+# Voucherify.ManagementProjectsBrandingUpdateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the brand configuration. | [optional] 
+**brand** | [**ManagementProjectsBrandingUpdateResponseBodyBrand**](ManagementProjectsBrandingUpdateResponseBodyBrand.md) |  | [optional] 
+**address** | [**ManagementProjectsBrandingUpdateResponseBodyAddress**](ManagementProjectsBrandingUpdateResponseBodyAddress.md) |  | [optional] 
+**contact** | [**ManagementProjectsBrandingUpdateResponseBodyContact**](ManagementProjectsBrandingUpdateResponseBodyContact.md) |  | [optional] 
+**cockpits** | [**ManagementProjectsBrandingUpdateResponseBodyCockpits**](ManagementProjectsBrandingUpdateResponseBodyCockpits.md) |  | [optional] 
+
+

package/docs/ManagementProjectsBrandingUpdateResponseBodyAddress.md

@@ -0,0 +1,13 @@
+# Voucherify.ManagementProjectsBrandingUpdateResponseBodyAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**street** | **String** | Defines the brand's street. | [optional] 
+**city** | **String** | Defines the brand's city. | [optional] 
+**postal** | **String** | Defines the brand's postal code. | [optional] 
+**state** | **String** | Defines the brand's state or similar administrative area. | [optional] 
+**country** | **String** | Defines the brand's country. | [optional] 
+
+

package/docs/ManagementProjectsBrandingUpdateResponseBodyBrand.md

@@ -0,0 +1,13 @@
+# Voucherify.ManagementProjectsBrandingUpdateResponseBodyBrand
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Defines brand name. | [optional] 
+**privacyPolicyUrl** | **String** | Defines the URL to the brand's privacy policy. It must be a valid URL format. | [optional] 
+**termsOfUseUrl** | **String** | Defines the URL to the brand's terms of use.  It must be a valid URL format. | [optional] 
+**permissionReminder** | **String** | Defines the message that is displayed to customers who opted in an email newsletter. | [optional] 
+**websiteUrl** | **String** | Defines the URL to the brand's website. It must be a valid URL format. | [optional] 
+
+

package/docs/ManagementProjectsBrandingUpdateResponseBodyCockpits.md

@@ -0,0 +1,39 @@
+# Voucherify.ManagementProjectsBrandingUpdateResponseBodyCockpits
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaignsOverviewEnabled** | **Boolean** | Enables the campaign overview for customers. | [optional] 
+**loyaltyEnabled** | **Boolean** | Enables the loyalty campaign overview for customers. | [optional] 
+**giftCardsEnabled** | **Boolean** | Enables the gift card overview for customers. | [optional] 
+**couponsEnabled** | **Boolean** | Enables the discount coupon overview for customers. | [optional] 
+**referralsEnabled** | **Boolean** | Enables the referral campaign overview for customers. | [optional] 
+**theme** | **String** | Determines the color scheme of the customer cockpit. | [optional] 
+**useCustomDoubleOptInRedirectUrl** | **Boolean** | Enables the double opt-in option. It must be a valid URL format. | [optional] 
+**customDoubleOptInRedirectUrl** | **String** | Defines the URL for the double opt-in consent. It must be a valid URL format. | [optional] 
+
+
+
+## Enum: ThemeEnum
+
+
+* `blue` (value: `"blue"`)
+
+* `dark-green` (value: `"dark-green"`)
+
+* `default` (value: `"default"`)
+
+* `green` (value: `"green"`)
+
+* `grey` (value: `"grey"`)
+
+* `orange` (value: `"orange"`)
+
+* `purple` (value: `"purple"`)
+
+* `red` (value: `"red"`)
+
+
+
+

package/docs/ManagementProjectsBrandingUpdateResponseBodyContact.md

@@ -0,0 +1,10 @@
+# Voucherify.ManagementProjectsBrandingUpdateResponseBodyContact
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Defines the brand's email address. It must be a valid email format. | [optional] 
+**phone** | **String** | Defines the brand's phone number. | [optional] 
+
+

package/docs/ManagementProjectsCreateRequestBody.md

@@ -0,0 +1,45 @@
+# Voucherify.ManagementProjectsCreateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**caseSensitiveCodes** | **Boolean** | Determines if the vouchers in the project will be case sensitive (if `true`, `C0dE-cfV` is not equal to `c0de-cfv`) or case insensitive (if false, `C0dE-cfV` is equal to `c0de-cfv`). | [optional] 
+**name** | **String** | The name of the project. | [optional] 
+**description** | **String** | A user-defined description of the project, e.g. its purpose, scope, region. | [optional] 
+**timezone** | **String** | The time zone in which the project is established. It can be in the GMT format or in accordance with IANA time zone database. | [optional] 
+**currency** | **String** | The currency used in the project. It is equal to a 3-letter ISO 4217 code. | [optional] 
+**dialCode** | **String** | The country dial code for the project. It is equal to an ITU country code. | [optional] 
+**webhookVersion** | **String** | The webhook version used in the project. | [optional] [default to 'v2024-01-01']
+**clientTrustedDomains** | **[String]** | An array of URL addresses that allow client requests. | [optional] 
+**clientRedeemEnabled** | **Boolean** | Enables client-side redemption. | [optional] 
+**clientPublishEnabled** | **Boolean** | Enables client-side publication. | [optional] 
+**clientListVouchersEnabled** | **Boolean** | Enables client-side listing of vouchers. | [optional] 
+**clientCreateCustomerEnabled** | **Boolean** | Enables client-side creation of customers. | [optional] 
+**clientLoyaltyEventsEnabled** | **Boolean** | Enables client-side events for loyalty and referral programs. | [optional] 
+**clientSetVoucherExpirationDateEnabled** | **Boolean** | Enables client-side setting of voucher expiration date. | [optional] 
+**webhooksCalloutNotifications** | [**ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications**](ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications.md) |  | [optional] 
+**apiUsageNotifications** | [**ManagementProjectsCreateRequestBodyApiUsageNotifications**](ManagementProjectsCreateRequestBodyApiUsageNotifications.md) |  | [optional] 
+**clusterId** | **String** | The identifier of the cluster where the project will be created. The default cluster is `eu1` unless otherwise configured. | [optional] 
+**apiVersion** | **String** | The API version used in the project. Currently, the default and only value is `v2018-08-01`. | [optional] [default to 'v2018-08-01']
+**users** | [**[ManagementProjectsCreateRequestBodyUsersItem]**](ManagementProjectsCreateRequestBodyUsersItem.md) | The users (their identifiers, logins, and roles) who will be assigned to the project. You can assign only existing Voucherify users.  It must be used either in the following combinations: - `id` and `role`, or - `login` and `role`. | [optional] 
+
+
+
+## Enum: WebhookVersionEnum
+
+
+* `v2024-01-01` (value: `"v2024-01-01"`)
+
+
+
+
+
+## Enum: ApiVersionEnum
+
+
+* `v2018-08-01` (value: `"v2018-08-01"`)
+
+
+
+

package/docs/ManagementProjectsCreateRequestBodyApiUsageNotifications.md

@@ -0,0 +1,13 @@
+# Voucherify.ManagementProjectsCreateRequestBodyApiUsageNotifications
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**apiCalls** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**bulkApiCalls** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**webhookCalls** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**cycleCalls** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+
+

package/docs/ManagementProjectsCreateRequestBodyUsersItem.md

@@ -0,0 +1,11 @@
+# Voucherify.ManagementProjectsCreateRequestBodyUsersItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique identifier of the user who will be assigned to the project. It can be found in Team Settings > Team > Edit member. **Required** with the `role` string.  Do **not** use with the `login` string. | [optional] 
+**login** | **String** | The login data of the user who will be assigned to the project. **Required** with the `role` string.  Do **not** use with the `id` string. | [optional] 
+**role** | **String** | The role of the user to be added. It can be one of the following predefined roles: `ADMIN`, `USER`, `VIEWER`, `MERCHANT` or an ID of a custom role. | 
+
+

package/docs/ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications.md

@@ -0,0 +1,10 @@
+# Voucherify.ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**distributions** | [**ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsDistributions**](ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsDistributions.md) |  | [optional] 
+**webhooks** | [**ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsWebhooks**](ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsWebhooks.md) |  | [optional] 
+
+

package/docs/ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsDistributions.md

@@ -0,0 +1,11 @@
+# Voucherify.ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsDistributions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **Boolean** | Enables the notification through an email. | [optional] 
+**inApp** | **Boolean** | Enables the notification through an email. | [optional] 
+**emails** | **[String]** | An array of email addresses which will receive the notification. | [optional] 
+
+

package/docs/ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsWebhooks.md

@@ -0,0 +1,11 @@
+# Voucherify.ManagementProjectsCreateRequestBodyWebhooksCalloutNotificationsWebhooks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **Boolean** | Enables the notification through an email. | [optional] 
+**inApp** | **Boolean** | Enables the notification through an email. | [optional] 
+**emails** | **[String]** | An array of email addresses which will receive the notification. | [optional] 
+
+

package/docs/ManagementProjectsCreateResponseBody.md

@@ -0,0 +1,49 @@
+# Voucherify.ManagementProjectsCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the project. | [optional] 
+**name** | **String** | The name of the project. | [optional] 
+**description** | **String** | A user-defined description of the project, e.g. its purpose, scope, region. | [optional] 
+**timezone** | **String** | The time zone in which the project is established. It can be in the GMT format or in accordance with IANA time zone database. | [optional] 
+**currency** | **String** | The currency used in the project. It is equal to a 3-letter ISO 4217 code. | [optional] 
+**dialCode** | **String** | The country dial code for the project. It is equal to an ITU country code. | [optional] 
+**webhookVersion** | **String** | The webhook version used in the project. | [optional] [default to 'v2024-01-01']
+**clientTrustedDomains** | **[String]** | An array of URL addresses that allow client requests. | [optional] 
+**clientRedeemEnabled** | **Boolean** | Enables client-side redemption. | [optional] 
+**clientPublishEnabled** | **Boolean** | Enables client-side publication. | [optional] 
+**clientListVouchersEnabled** | **Boolean** | Enables client-side listing of vouchers. | [optional] 
+**clientCreateCustomerEnabled** | **Boolean** | Enables client-side creation of customers. | [optional] 
+**clientLoyaltyEventsEnabled** | **Boolean** | Enables client-side events for loyalty and referral programs. | [optional] 
+**clientSetVoucherExpirationDateEnabled** | **Boolean** | Enables client-side setting of voucher expiration date. | [optional] 
+**webhooksCalloutNotifications** | [**ManagementProjectsCreateResponseBodyWebhooksCalloutNotifications**](ManagementProjectsCreateResponseBodyWebhooksCalloutNotifications.md) |  | [optional] 
+**apiUsageNotifications** | [**ManagementProjectsCreateResponseBodyApiUsageNotifications**](ManagementProjectsCreateResponseBodyApiUsageNotifications.md) |  | [optional] 
+**clusterId** | **String** | The identifier of the cluster where the project will be created. | [optional] 
+**caseSensitiveCodes** | **Boolean** | Determines if the vouchers in the project will be: - case sensitive - if `true`, `C0dE-cfV` is **not** equal to `c0de-cfv`), - case insensitive - if `false`, `C0dE-cfV` is equal to `c0de-cfv`. | [optional] 
+**apiVersion** | **String** | The API version used in the project. Currently, the default and only value is `v2018-08-01`. | [optional] [default to 'v2018-08-01']
+**isSandbox** | **Boolean** | Determines if the project is a sandbox project. | [optional] 
+**webhookToken** | **String** | Webhook token used for authentication. | [optional] 
+**serverSideKey** | [**ManagementProjectsCreateResponseBodyServerSideKey**](ManagementProjectsCreateResponseBodyServerSideKey.md) |  | [optional] 
+**clientSideKey** | [**ManagementProjectsCreateResponseBodyClientSideKey**](ManagementProjectsCreateResponseBodyClientSideKey.md) |  | [optional] 
+
+
+
+## Enum: WebhookVersionEnum
+
+
+* `v2024-01-01` (value: `"v2024-01-01"`)
+
+
+
+
+
+## Enum: ApiVersionEnum
+
+
+* `v2018-08-01` (value: `"v2018-08-01"`)
+
+
+
+

package/docs/ManagementProjectsCreateResponseBodyApiUsageNotifications.md

@@ -0,0 +1,14 @@
+# Voucherify.ManagementProjectsCreateResponseBodyApiUsageNotifications
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redemptions** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**messages** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**apiCalls** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**bulkApiCalls** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**webhookCalls** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**cycleCalls** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+
+

package/docs/ManagementProjectsCreateResponseBodyClientSideKey.md

@@ -0,0 +1,10 @@
+# Voucherify.ManagementProjectsCreateResponseBodyClientSideKey
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**appId** | **String** | Application ID to be used as `X-App-Id` header in every HTTP request. | [optional] 
+**appToken** | **String** | Application token to be used as `X-App-Token` header in every HTTP request.  The application token (secret key) for the client-side authentication is visible in the Project Settings for 14 days when it is first generated in a newly-created project. Write your application token down and keep it in a safe place. | [optional] 
+
+

package/docs/ManagementProjectsCreateResponseBodyServerSideKey.md

@@ -0,0 +1,10 @@
+# Voucherify.ManagementProjectsCreateResponseBodyServerSideKey
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**appId** | **String** | Application ID to be used as `X-App-Id` header in every HTTP request. | [optional] 
+**appToken** | **String** | Application token to be used as `X-App-Token` header in every HTTP request.  The application token (secret key) for the server-side authentication is visible in the Project Settings for 14 days when it is first generated in a newly-created project. Write your application token down and keep it in a safe place. | [optional] 
+
+

package/docs/ManagementProjectsCreateResponseBodyWebhooksCalloutNotifications.md

@@ -0,0 +1,10 @@
+# Voucherify.ManagementProjectsCreateResponseBodyWebhooksCalloutNotifications
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**distributions** | [**ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsDistributions**](ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsDistributions.md) |  | [optional] 
+**webhooks** | [**ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsWebhooks**](ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsWebhooks.md) |  | [optional] 
+
+

package/docs/ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsDistributions.md

@@ -0,0 +1,11 @@
+# Voucherify.ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsDistributions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **Boolean** | Enables the notification through an email. | [optional] 
+**inApp** | **Boolean** | Enables the notification through an email. | [optional] 
+**emails** | **[String]** | An array of email addresses which will receive the notification. | [optional] 
+
+

package/docs/ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsWebhooks.md

@@ -0,0 +1,11 @@
+# Voucherify.ManagementProjectsCreateResponseBodyWebhooksCalloutNotificationsWebhooks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **Boolean** | Enables the notification through an email. | [optional] 
+**inApp** | **Boolean** | Enables the notification through an email. | [optional] 
+**emails** | **[String]** | An array of email addresses which will receive the notification. | [optional] 
+
+

package/docs/ManagementProjectsCustomEventSchema.md

@@ -0,0 +1,23 @@
+# Voucherify.ManagementProjectsCustomEventSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the custom event schema. | [optional] 
+**name** | **String** | User-defined name of the custom event. This is also shown in **Project Settings** > **Event Schema** in the Voucherify Dashboard. | [optional] 
+**schema** | [**ManagementProjectsCustomEventSchemaSchema**](ManagementProjectsCustomEventSchemaSchema.md) |  | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the custom event schema was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the custom event schema was updated. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'custom-event-schema']
+
+
+
+## Enum: ObjectEnum
+
+
+* `custom-event-schema` (value: `"custom-event-schema"`)
+
+
+
+

package/docs/ManagementProjectsCustomEventSchemaSchema.md

@@ -0,0 +1,9 @@
+# Voucherify.ManagementProjectsCustomEventSchemaSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**properties** | [**{String: ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue}**](ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue.md) | Defines custom event custom attributes (metadata). | [optional] 
+
+

package/docs/ManagementProjectsCustomEventSchemasCreateRequestBody.md

@@ -0,0 +1,10 @@
+# Voucherify.ManagementProjectsCustomEventSchemasCreateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | User-defined name of the custom event. This is also shown in **Project Settings** > **Event Schema** in the Voucherify Dashboard. | [optional] 
+**schema** | [**ManagementProjectsCustomEventSchemasCreateRequestBodySchema**](ManagementProjectsCustomEventSchemasCreateRequestBodySchema.md) |  | [optional] 
+
+

package/docs/ManagementProjectsCustomEventSchemasCreateRequestBodySchema.md

@@ -0,0 +1,9 @@
+# Voucherify.ManagementProjectsCustomEventSchemasCreateRequestBodySchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**properties** | [**{String: ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue}**](ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue.md) | Defines custom event custom attributes (metadata). | [optional] 
+
+

package/docs/ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue.md

@@ -0,0 +1,28 @@
+# Voucherify.ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Indicates the type of the custom event. | 
+**optional** | **Boolean** | Indicates if this property is optional or not for the resource. | 
+**deleted** | **Boolean** | Indicates if the property has been deleted from the schema. A deleted schema is inactive, but it can be restored. | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `string` (value: `"string"`)
+
+* `number` (value: `"number"`)
+
+* `date` (value: `"date"`)
+
+* `datetime` (value: `"datetime"`)
+
+* `boolean` (value: `"boolean"`)
+
+
+
+

package/docs/ManagementProjectsCustomEventSchemasCreateResponseBody.md

@@ -0,0 +1,23 @@
+# Voucherify.ManagementProjectsCustomEventSchemasCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the custom event schema. | [optional] 
+**name** | **String** | User-defined name of the custom event. This is also shown in **Project Settings** > **Event Schema** in the Voucherify Dashboard. | [optional] 
+**schema** | [**ManagementProjectsCustomEventSchemasCreateResponseBodySchema**](ManagementProjectsCustomEventSchemasCreateResponseBodySchema.md) |  | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the custom event schema was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the custom event schema was updated. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'custom-event-schema']
+
+
+
+## Enum: ObjectEnum
+
+
+* `custom-event-schema` (value: `"custom-event-schema"`)
+
+
+
+

package/docs/ManagementProjectsCustomEventSchemasCreateResponseBodySchema.md

@@ -0,0 +1,9 @@
+# Voucherify.ManagementProjectsCustomEventSchemasCreateResponseBodySchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**properties** | [**{String: ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue}**](ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue.md) | Defines custom event custom attributes (metadata). | [optional] 
+
+

package/docs/ManagementProjectsCustomEventSchemasGetResponseBody.md

@@ -0,0 +1,23 @@
+# Voucherify.ManagementProjectsCustomEventSchemasGetResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the custom event schema. | [optional] 
+**name** | **String** | User-defined name of the custom event. This is also shown in **Project Settings** > **Event Schema** in the Voucherify Dashboard. | [optional] 
+**schema** | [**ManagementProjectsCustomEventSchemasGetResponseBodySchema**](ManagementProjectsCustomEventSchemasGetResponseBodySchema.md) |  | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the custom event schema was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the custom event schema was updated. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'custom-event-schema']
+
+
+
+## Enum: ObjectEnum
+
+
+* `custom-event-schema` (value: `"custom-event-schema"`)
+
+
+
+

package/docs/ManagementProjectsCustomEventSchemasGetResponseBodySchema.md

@@ -0,0 +1,9 @@
+# Voucherify.ManagementProjectsCustomEventSchemasGetResponseBodySchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**properties** | [**{String: ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue}**](ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue.md) | Defines custom event custom attributes (metadata). | [optional] 
+
+

package/docs/ManagementProjectsCustomEventSchemasListResponseBody.md

@@ -0,0 +1,30 @@
+# Voucherify.ManagementProjectsCustomEventSchemasListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about the custom event schemas in a dictionary. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of custom event schema objects. | [optional] [default to 'data']
+**data** | [**[ManagementProjectsCustomEventSchema]**](ManagementProjectsCustomEventSchema.md) | Array of custom event schema objects. | [optional] 
+**total** | **Number** | The total number of custom event schema objects. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `list` (value: `"list"`)
+
+
+
+
+
+## Enum: DataRefEnum
+
+
+* `data` (value: `"data"`)
+
+
+
+

package/docs/ManagementProjectsCustomEventSchemasUpdateRequestBody.md

@@ -0,0 +1,9 @@
+# Voucherify.ManagementProjectsCustomEventSchemasUpdateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schema** | [**ManagementProjectsCustomEventSchemasUpdateRequestBodySchema**](ManagementProjectsCustomEventSchemasUpdateRequestBodySchema.md) |  | [optional] 
+
+

package/docs/ManagementProjectsCustomEventSchemasUpdateRequestBodySchema.md

@@ -0,0 +1,9 @@
+# Voucherify.ManagementProjectsCustomEventSchemasUpdateRequestBodySchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**properties** | [**{String: ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue}**](ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue.md) | Defines custom event custom attributes (metadata). | [optional] 
+
+

package/docs/ManagementProjectsCustomEventSchemasUpdateResponseBody.md

@@ -0,0 +1,23 @@
+# Voucherify.ManagementProjectsCustomEventSchemasUpdateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the custom event schema. | [optional] 
+**name** | **String** | User-defined name of the custom event. This is also shown in **Project Settings** > **Event Schema** in the Voucherify Dashboard. | [optional] 
+**schema** | [**ManagementProjectsCustomEventSchemasUpdateResponseBodySchema**](ManagementProjectsCustomEventSchemasUpdateResponseBodySchema.md) |  | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the custom event schema was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the custom event schema was updated. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'custom-event-schema']
+
+
+
+## Enum: ObjectEnum
+
+
+* `custom-event-schema` (value: `"custom-event-schema"`)
+
+
+
+

package/docs/ManagementProjectsCustomEventSchemasUpdateResponseBodySchema.md

@@ -0,0 +1,9 @@
+# Voucherify.ManagementProjectsCustomEventSchemasUpdateResponseBodySchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**properties** | [**{String: ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue}**](ManagementProjectsCustomEventSchemasCreateRequestBodySchemaPropertiesEntryValue.md) | Defines custom event custom attributes (metadata). | [optional] 
+
+