chore(docs): Generated JS Client Reference (#5334)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-10-10 17:47:07 +00:00
committed by GitHub
parent 378ca1b36e
commit daea35fe73
1091 changed files with 140791 additions and 25954 deletions

View File

@@ -0,0 +1,84 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostGiftCardsReq
[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostGiftCardsReq
**`Schema`**
AdminPostGiftCardsReq
type: object
required:
- region_id
properties:
value:
type: integer
description: The value (excluding VAT) that the Gift Card should represent.
is_disabled:
type: boolean
description: Whether the Gift Card is disabled on creation. If set to `true`, the gift card will not be available for customers.
ends_at:
type: string
format: date-time
description: The date and time at which the Gift Card should no longer be available.
region_id:
description: The ID of the Region in which the Gift Card can be used.
type: string
metadata:
description: An optional set of key-value pairs to hold additional information.
type: object
externalDocs:
description: "Learn about the metadata attribute, and how to delete and update it."
url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute"
## Properties
### ends\_at
`Optional` **ends\_at**: `Date`
#### Defined in
packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:92
___
### is\_disabled
`Optional` **is\_disabled**: `boolean`
#### Defined in
packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:93
___
### metadata
`Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
#### Defined in
packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:95
___
### region\_id
**region\_id**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:94
___
### value
`Optional` **value**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:91