chore(docs): Generated API Reference (#2417)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
c4c83c9717
commit
10b9b0dc49
@@ -1610,58 +1610,6 @@ paths:
|
||||
$ref: '#/components/responses/invalid_request_error'
|
||||
'500':
|
||||
$ref: '#/components/responses/500_error'
|
||||
'/gift-cards/{code}':
|
||||
get:
|
||||
operationId: GetGiftCardsCode
|
||||
summary: Get Gift Card by Code
|
||||
description: Retrieves a Gift Card by its associated unqiue code.
|
||||
parameters:
|
||||
- in: path
|
||||
name: code
|
||||
required: true
|
||||
description: The unique Gift Card code.
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source: >
|
||||
import Medusa from "@medusajs/medusa-js"
|
||||
|
||||
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
|
||||
3 })
|
||||
|
||||
medusa.giftCards.retrieve(code)
|
||||
|
||||
.then(({ gift_card }) => {
|
||||
console.log(gift_card.id);
|
||||
});
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source: >
|
||||
curl --location --request GET
|
||||
'https://medusa-url.com/store/gift-cards/{code}'
|
||||
tags:
|
||||
- Gift Card
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
gift_card:
|
||||
$ref: '#/components/schemas/gift_card'
|
||||
'400':
|
||||
$ref: '#/components/responses/400_error'
|
||||
'404':
|
||||
$ref: '#/components/responses/not_found_error'
|
||||
'409':
|
||||
$ref: '#/components/responses/invalid_state_error'
|
||||
'422':
|
||||
$ref: '#/components/responses/invalid_request_error'
|
||||
'500':
|
||||
$ref: '#/components/responses/500_error'
|
||||
/customers/me/addresses:
|
||||
post:
|
||||
operationId: PostCustomersCustomerAddresses
|
||||
@@ -1677,8 +1625,16 @@ paths:
|
||||
properties:
|
||||
address:
|
||||
description: The Address to add to the Customer.
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/address'
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/address_fields'
|
||||
- type: object
|
||||
required:
|
||||
- first_name
|
||||
- last_name
|
||||
- address_1
|
||||
- city
|
||||
- country_code
|
||||
- postal_code
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
@@ -1937,7 +1893,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/address'
|
||||
- $ref: '#/components/schemas/address_fields'
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
@@ -2069,7 +2025,7 @@ paths:
|
||||
billing_address:
|
||||
description: The Address to be used for billing purposes.
|
||||
anyOf:
|
||||
- $ref: '#/components/schemas/address'
|
||||
- $ref: '#/components/schemas/address_fields'
|
||||
description: The full billing address object
|
||||
- type: string
|
||||
description: The ID of an existing billing address
|
||||
@@ -2588,6 +2544,58 @@ paths:
|
||||
$ref: '#/components/responses/invalid_request_error'
|
||||
'500':
|
||||
$ref: '#/components/responses/500_error'
|
||||
'/gift-cards/{code}':
|
||||
get:
|
||||
operationId: GetGiftCardsCode
|
||||
summary: Get Gift Card by Code
|
||||
description: Retrieves a Gift Card by its associated unqiue code.
|
||||
parameters:
|
||||
- in: path
|
||||
name: code
|
||||
required: true
|
||||
description: The unique Gift Card code.
|
||||
schema:
|
||||
type: string
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
source: >
|
||||
import Medusa from "@medusajs/medusa-js"
|
||||
|
||||
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
|
||||
3 })
|
||||
|
||||
medusa.giftCards.retrieve(code)
|
||||
|
||||
.then(({ gift_card }) => {
|
||||
console.log(gift_card.id);
|
||||
});
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source: >
|
||||
curl --location --request GET
|
||||
'https://medusa-url.com/store/gift-cards/{code}'
|
||||
tags:
|
||||
- Gift Card
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
gift_card:
|
||||
$ref: '#/components/schemas/gift_card'
|
||||
'400':
|
||||
$ref: '#/components/responses/400_error'
|
||||
'404':
|
||||
$ref: '#/components/responses/not_found_error'
|
||||
'409':
|
||||
$ref: '#/components/responses/invalid_state_error'
|
||||
'422':
|
||||
$ref: '#/components/responses/invalid_request_error'
|
||||
'500':
|
||||
$ref: '#/components/responses/500_error'
|
||||
'/order-edits/{id}/complete':
|
||||
post:
|
||||
operationId: PostOrderEditsOrderEditComplete
|
||||
@@ -2994,7 +3002,17 @@ paths:
|
||||
schema:
|
||||
properties:
|
||||
product:
|
||||
$ref: '#/components/schemas/product'
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/product'
|
||||
- type: object
|
||||
properties:
|
||||
variants:
|
||||
type: array
|
||||
items:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/product_variant'
|
||||
- $ref: >-
|
||||
#/components/schemas/product_variant_prices_fields
|
||||
'400':
|
||||
$ref: '#/components/responses/400_error'
|
||||
'404':
|
||||
@@ -3173,7 +3191,17 @@ paths:
|
||||
products:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/product'
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/product'
|
||||
- type: object
|
||||
properties:
|
||||
variants:
|
||||
type: array
|
||||
items:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/product_variant'
|
||||
- $ref: >-
|
||||
#/components/schemas/product_variant_prices_fields
|
||||
count:
|
||||
type: integer
|
||||
description: The total number of items available
|
||||
@@ -3975,7 +4003,9 @@ paths:
|
||||
schema:
|
||||
properties:
|
||||
variant:
|
||||
$ref: '#/components/schemas/product_variant'
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/product_variant'
|
||||
- $ref: '#/components/schemas/product_variant_prices_fields'
|
||||
'400':
|
||||
$ref: '#/components/responses/400_error'
|
||||
'404':
|
||||
@@ -4071,7 +4101,9 @@ paths:
|
||||
variants:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/product_variant'
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/product_variant'
|
||||
- $ref: '#/components/schemas/product_variant_prices_fields'
|
||||
'400':
|
||||
$ref: '#/components/responses/400_error'
|
||||
'404':
|
||||
@@ -4283,6 +4315,60 @@ components:
|
||||
|
||||
Where `{sid}` is the value of `connect.sid` that you copied.
|
||||
schemas:
|
||||
address_fields:
|
||||
title: Address Fields
|
||||
description: Address fields used when creating/updating an address.
|
||||
x-resourceId: address
|
||||
properties:
|
||||
company:
|
||||
type: string
|
||||
description: Company name
|
||||
example: Acme
|
||||
first_name:
|
||||
type: string
|
||||
description: First name
|
||||
example: Arno
|
||||
last_name:
|
||||
type: string
|
||||
description: Last name
|
||||
example: Willms
|
||||
address_1:
|
||||
type: string
|
||||
description: Address line 1
|
||||
example: 14433 Kemmer Court
|
||||
address_2:
|
||||
type: string
|
||||
description: Address line 2
|
||||
example: Suite 369
|
||||
city:
|
||||
type: string
|
||||
description: City
|
||||
example: South Geoffreyview
|
||||
country_code:
|
||||
type: string
|
||||
description: The 2 character ISO code of the country in lower case
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
|
||||
description: See a list of codes.
|
||||
example: st
|
||||
province:
|
||||
type: string
|
||||
description: Province
|
||||
example: Kentucky
|
||||
postal_code:
|
||||
type: string
|
||||
description: Postal Code
|
||||
example: 72093
|
||||
phone:
|
||||
type: string
|
||||
description: Phone Number
|
||||
example: 16128234334802
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
example:
|
||||
car: white
|
||||
address:
|
||||
title: Address
|
||||
description: An address.
|
||||
@@ -7909,6 +7995,46 @@ components:
|
||||
description: An optional key-value map with additional details
|
||||
example:
|
||||
car: white
|
||||
product_variant_prices_fields:
|
||||
title: Product Variant Prices Fields
|
||||
description: Product Variants Prices Fields that are only available in some requests.
|
||||
x-resourceId: product_variant_prices_fields
|
||||
properties:
|
||||
original_price:
|
||||
type: number
|
||||
description: >-
|
||||
The original price of the variant without any discounted prices
|
||||
applied.
|
||||
calculated_price:
|
||||
type: number
|
||||
description: The calculated price of the variant. Can be a discounted price.
|
||||
original_price_incl_tax:
|
||||
type: number
|
||||
description: The original price of the variant including taxes.
|
||||
calculated_price_incl_tax:
|
||||
type: number
|
||||
description: The calculated price of the variant including taxes.
|
||||
original_tax:
|
||||
type: number
|
||||
description: The taxes applied on the original price.
|
||||
calculated_tax:
|
||||
type: number
|
||||
description: The taxes applied on the calculated price.
|
||||
tax_rates:
|
||||
type: array
|
||||
description: An array of applied tax rates
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
rate:
|
||||
type: number
|
||||
description: The tax rate value
|
||||
name:
|
||||
type: string
|
||||
description: The name of the tax rate
|
||||
code:
|
||||
type: string
|
||||
description: The code of the tax rate
|
||||
product:
|
||||
title: Product
|
||||
description: >-
|
||||
|
||||
Reference in New Issue
Block a user