asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated OAS (#6752)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-03-20 11:30:24 +01:00
committed by GitHub
co-authored by olivermrbl
parent 95738804cd
commit 53653f5266
198 changed files with 8998 additions and 331 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs-util/oas-output/operations/admin/delete_admin_api-keys_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/api-keys/{id}
* operationId: DeleteApiKeysId
* summary: Delete a Api Key
* description: Delete a api key.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The api key's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/api-keys/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Api Keys
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_campaigns_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/campaigns/{id}
* operationId: DeleteCampaignsId
* summary: Delete a Campaign
* description: Delete a campaign.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The campaign's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/campaigns/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Campaigns
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_collections_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/collections/{id}
* operationId: DeleteCollectionsId
* summary: Delete a Collection
* description: Delete a collection.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The collection's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/collections/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Collections
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_customer-groups_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/customer-groups/{id}
* operationId: DeleteCustomerGroupsId
* summary: Delete a Customer Group
* description: Delete a customer group.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer group's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/customer-groups/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customer Groups
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_customers_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/customers/{id}
* operationId: DeleteCustomersId
* summary: Delete a Customer
* description: Delete a customer.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/customers/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts
+52
View File
@@ -0,0 +1,52 @@
/**
* @oas [delete] /admin/customers/{id}/addresses/{address_id}
* operationId: DeleteCustomersIdAddressesAddress_id
* summary: Remove Addresses from Customer
* description: Remove a list of addresses from a customer. This doesn't delete the
* Address, only the association between the Address and the customer.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer's ID.
* required: true
* schema:
* type: string
* - name: address_id
* in: path
* description: The customer's address id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}'
* \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/inventory-items/{id}
* operationId: DeleteInventoryItemsId
* summary: Delete a Inventory Item
* description: Delete a inventory item.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The inventory item's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/inventory-items/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts
+53
View File
@@ -0,0 +1,53 @@
/**
* @oas [delete] /admin/inventory-items/{id}/location-levels/{location_id}
* operationId: DeleteInventoryItemsIdLocationLevelsLocation_id
* summary: Remove Location Levels from Inventory Item
* description: Remove a list of location levels from a inventory item. This
* doesn't delete the Location Level, only the association between the Location
* Level and the inventory item.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The inventory item's ID.
* required: true
* schema:
* type: string
* - name: location_id
* in: path
* description: The inventory item's location id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_invites_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/invites/{id}
* operationId: DeleteInvitesId
* summary: Delete a Invite
* description: Delete a invite.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The invite's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/invites/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Invites
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_price-lists_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/price-lists/{id}
* operationId: DeletePriceListsId
* summary: Delete a Price List
* description: Delete a price list.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The price list's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/price-lists/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Price Lists
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_pricing_rule-types_[id].ts
+49
View File
@@ -0,0 +1,49 @@
/**
* @oas [delete] /admin/pricing/rule-types/{id}
* operationId: DeletePricingRuleTypesId
* summary: Remove Rule Types from Pricing
* description: Remove a list of rule types from a pricing. This doesn't delete the
* Rule Type, only the association between the Rule Type and the pricing.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The pricing's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/pricing/rule-types/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Pricing
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_products_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/products/{id}
* operationId: DeleteProductsId
* summary: Delete a Product
* description: Delete a product.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The product's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/products/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Products
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts
+50
View File
@@ -0,0 +1,50 @@
/**
* @oas [delete] /admin/products/{id}/options/{option_id}
* operationId: DeleteProductsIdOptionsOption_id
* summary: Remove Options from Product
* description: Remove a list of options from a product. This doesn't delete the
* Option, only the association between the Option and the product.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The product's ID.
* required: true
* schema:
* type: string
* - name: option_id
* in: path
* description: The product's option id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/products/{id}/options/{option_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Products
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts
+50
View File
@@ -0,0 +1,50 @@
/**
* @oas [delete] /admin/products/{id}/variants/{variant_id}
* operationId: DeleteProductsIdVariantsVariant_id
* summary: Remove Variants from Product
* description: Remove a list of variants from a product. This doesn't delete the
* Variant, only the association between the Variant and the product.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The product's ID.
* required: true
* schema:
* type: string
* - name: variant_id
* in: path
* description: The product's variant id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/products/{id}/variants/{variant_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Products
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_promotions_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/promotions/{id}
* operationId: DeletePromotionsId
* summary: Delete a Promotion
* description: Delete a promotion.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The promotion's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/promotions/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_regions_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/regions/{id}
* operationId: DeleteRegionsId
* summary: Delete a Region
* description: Delete a region.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The region's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/regions/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Regions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_sales-channels_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/sales-channels/{id}
* operationId: DeleteSalesChannelsId
* summary: Delete a Sales Channel
* description: Delete a sales channel.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The sales channel's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/sales-channels/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Sales Channels
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/tax-rates/{id}
* operationId: DeleteTaxRatesId
* summary: Delete a Tax Rate
* description: Delete a tax rate.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The tax rate's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/tax-rates/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Tax Rates
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts
+50
View File
@@ -0,0 +1,50 @@
/**
* @oas [delete] /admin/tax-rates/{id}/rules/{rule_id}
* operationId: DeleteTaxRatesIdRulesRule_id
* summary: Remove Rules from Tax Rate
* description: Remove a list of rules from a tax rate. This doesn't delete the
* Rule, only the association between the Rule and the tax rate.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The tax rate's ID.
* required: true
* schema:
* type: string
* - name: rule_id
* in: path
* description: The tax rate's rule id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/tax-rates/{id}/rules/{rule_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Tax Rates
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_tax-regions_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/tax-regions/{id}
* operationId: DeleteTaxRegionsId
* summary: Delete a Tax Region
* description: Delete a tax region.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The tax region's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/tax-regions/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Tax Regions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/delete_admin_users_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/users/{id}
* operationId: DeleteUsersId
* summary: Delete a User
* description: Delete a user.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The user's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/users/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Users
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_api-keys.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/api-keys
* operationId: GetApiKeys
* summary: List Api Keys
* description: Retrieve a list of api keys. The api keys can be filtered by fields
* such as `id`. The api keys can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/api-keys' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Api Keys
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_api-keys_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/api-keys/{id}
* operationId: GetApiKeysId
* summary: Get a Api Key
* description: Retrieve a api key by its ID. You can expand the api key's
* relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The api key's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/api-keys/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Api Keys
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_campaigns.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/campaigns
* operationId: GetCampaigns
* summary: List Campaigns
* description: Retrieve a list of campaigns. The campaigns can be filtered by
* fields such as `id`. The campaigns can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/campaigns' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Campaigns
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_campaigns_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/campaigns/{id}
* operationId: GetCampaignsId
* summary: Get a Campaign
* description: Retrieve a campaign by its ID. You can expand the campaign's
* relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The campaign's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/campaigns/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Campaigns
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_collections.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/collections
* operationId: GetCollections
* summary: List Collections
* description: Retrieve a list of collections. The collections can be filtered by
* fields such as `id`. The collections can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/collections' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Collections
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_collections_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/collections/{id}
* operationId: GetCollectionsId
* summary: Get a Collection
* description: Retrieve a collection by its ID. You can expand the collection's
* relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The collection's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/collections/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Collections
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_currencies.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/currencies
* operationId: GetCurrencies
* summary: List Currencies
* description: Retrieve a list of currencies. The currencies can be filtered by
* fields such as `id`. The currencies can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/currencies' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Currencies
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_currencies_[code].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/currencies/{code}
* operationId: GetCurrenciesCode
* summary: Get a Currency
* description: Retrieve a currency by its ID. You can expand the currency's
* relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: code
* in: path
* description: The currency's code.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/currencies/{code}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Currencies
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_customer-groups.ts
+39
View File
@@ -0,0 +1,39 @@
/**
* @oas [get] /admin/customer-groups
* operationId: GetCustomerGroups
* summary: List Customer Groups
* description: Retrieve a list of customer groups. The customer groups can be
* filtered by fields such as `id`. The customer groups can also be sorted or
* paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/customer-groups' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customer Groups
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_customer-groups_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/customer-groups/{id}
* operationId: GetCustomerGroupsId
* summary: Get a Customer Group
* description: Retrieve a customer group by its ID. You can expand the customer
* group's relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer group's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/customer-groups/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customer Groups
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_customer-groups_[id]_customers.ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/customer-groups/{id}/customers
* operationId: GetCustomerGroupsIdCustomers
* summary: List Customers
* description: Retrieve a list of customers in a customer group. The customers can
* be filtered by fields like FILTER FIELDS. The customers can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer group's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/customer-groups/{id}/customers' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customer Groups
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_customers.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/customers
* operationId: GetCustomers
* summary: List Customers
* description: Retrieve a list of customers. The customers can be filtered by
* fields such as `id`. The customers can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/customers' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_customers_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/customers/{id}
* operationId: GetCustomersId
* summary: Get a Customer
* description: Retrieve a customer by its ID. You can expand the customer's
* relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/customers/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/customers/{id}/addresses
* operationId: GetCustomersIdAddresses
* summary: List Addresses
* description: Retrieve a list of addresses in a customer. The addresses can be
* filtered by fields like FILTER FIELDS. The addresses can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/customers/{id}/addresses' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts
+50
View File
@@ -0,0 +1,50 @@
/**
* @oas [get] /admin/customers/{id}/addresses/{address_id}
* operationId: GetCustomersIdAddressesAddress_id
* summary: List Addresses
* description: Retrieve a list of addresses in a customer. The addresses can be
* filtered by fields like FILTER FIELDS. The addresses can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer's ID.
* required: true
* schema:
* type: string
* - name: address_id
* in: path
* description: The customer's address id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/customers/{id}/addresses/{address_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_inventory-items.ts
+39
View File
@@ -0,0 +1,39 @@
/**
* @oas [get] /admin/inventory-items
* operationId: GetInventoryItems
* summary: List Inventory Items
* description: Retrieve a list of inventory items. The inventory items can be
* filtered by fields such as `id`. The inventory items can also be sorted or
* paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/inventory-items' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_inventory-items_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/inventory-items/{id}
* operationId: GetInventoryItemsId
* summary: Get a Inventory Item
* description: Retrieve a inventory item by its ID. You can expand the inventory
* item's relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The inventory item's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/inventory-items/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_invites.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/invites
* operationId: GetInvites
* summary: List Invites
* description: Retrieve a list of invites. The invites can be filtered by fields
* such as `id`. The invites can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/invites' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Invites
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_invites_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/invites/{id}
* operationId: GetInvitesId
* summary: Get a Invite
* description: Retrieve a invite by its ID. You can expand the invite's relations
* or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The invite's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/invites/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Invites
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_payments.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/payments
* operationId: GetPayments
* summary: List Payments
* description: Retrieve a list of payments. The payments can be filtered by fields
* such as `id`. The payments can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/payments' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Payments
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_payments_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/payments/{id}
* operationId: GetPaymentsId
* summary: Get a Payment
* description: Retrieve a payment by its ID. You can expand the payment's
* relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The payment's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/payments/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Payments
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_price-lists.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/price-lists
* operationId: GetPriceLists
* summary: List Price Lists
* description: Retrieve a list of price lists. The price lists can be filtered by
* fields such as `id`. The price lists can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/price-lists' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Price Lists
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_price-lists_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/price-lists/{id}
* operationId: GetPriceListsId
* summary: Get a Price List
* description: Retrieve a price list by its ID. You can expand the price list's
* relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The price list's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/price-lists/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Price Lists
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_pricing_rule-types.ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [get] /admin/pricing/rule-types
* operationId: GetPricingRuleTypes
* summary: List Pricing
* description: Retrieve a list of pricing. The pricing can be filtered by fields
* such as `id`. The pricing can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminGetPricingRuleTypesParams"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/pricing/rule-types' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Pricing
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_pricing_rule-types_[id].ts
+49
View File
@@ -0,0 +1,49 @@
/**
* @oas [get] /admin/pricing/rule-types/{id}
* operationId: GetPricingRuleTypesId
* summary: List Rule Types
* description: Retrieve a list of rule types in a pricing. The rule types can be
* filtered by fields like FILTER FIELDS. The rule types can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The pricing's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminGetPricingRuleTypesRuleTypeParams"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/pricing/rule-types/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Pricing
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_products.ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [get] /admin/products
* operationId: GetProducts
* summary: List Products
* description: Retrieve a list of products. The products can be filtered by fields
* such as `id`. The products can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminGetProductsParams"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/products' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Products
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_products_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/products/{id}
* operationId: GetProductsId
* summary: Get a Product
* description: Retrieve a product by its ID. You can expand the product's
* relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The product's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/products/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Products
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_products_[id]_options.ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/products/{id}/options
* operationId: GetProductsIdOptions
* summary: List Options
* description: Retrieve a list of options in a product. The options can be
* filtered by fields like FILTER FIELDS. The options can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The product's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/products/{id}/options' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Products
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts
+50
View File
@@ -0,0 +1,50 @@
/**
* @oas [get] /admin/products/{id}/options/{option_id}
* operationId: GetProductsIdOptionsOption_id
* summary: List Options
* description: Retrieve a list of options in a product. The options can be
* filtered by fields like FILTER FIELDS. The options can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The product's ID.
* required: true
* schema:
* type: string
* - name: option_id
* in: path
* description: The product's option id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/products/{id}/options/{option_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Products
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_products_[id]_variants.ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/products/{id}/variants
* operationId: GetProductsIdVariants
* summary: List Variants
* description: Retrieve a list of variants in a product. The variants can be
* filtered by fields like FILTER FIELDS. The variants can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The product's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/products/{id}/variants' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Products
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts
+50
View File
@@ -0,0 +1,50 @@
/**
* @oas [get] /admin/products/{id}/variants/{variant_id}
* operationId: GetProductsIdVariantsVariant_id
* summary: List Variants
* description: Retrieve a list of variants in a product. The variants can be
* filtered by fields like FILTER FIELDS. The variants can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The product's ID.
* required: true
* schema:
* type: string
* - name: variant_id
* in: path
* description: The product's variant id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/products/{id}/variants/{variant_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Products
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_promotions.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/promotions
* operationId: GetPromotions
* summary: List Promotions
* description: Retrieve a list of promotions. The promotions can be filtered by
* fields such as `id`. The promotions can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/promotions' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_promotions_[id].ts
+49
View File
@@ -0,0 +1,49 @@
/**
* @oas [get] /admin/promotions/{id}
* operationId: GetPromotionsId
* summary: Get a Promotion
* description: Retrieve a promotion by its ID. You can expand the promotion's
* relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The promotion's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminGetPromotionsParams"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/promotions/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_regions.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/regions
* operationId: GetRegions
* summary: List Regions
* description: Retrieve a list of regions. The regions can be filtered by fields
* such as `id`. The regions can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/regions' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Regions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_regions_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/regions/{id}
* operationId: GetRegionsId
* summary: Get a Region
* description: Retrieve a region by its ID. You can expand the region's relations
* or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The region's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/regions/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Regions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_sales-channels.ts
+39
View File
@@ -0,0 +1,39 @@
/**
* @oas [get] /admin/sales-channels
* operationId: GetSalesChannels
* summary: List Sales Channels
* description: Retrieve a list of sales channels. The sales channels can be
* filtered by fields such as `id`. The sales channels can also be sorted or
* paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/sales-channels' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Sales Channels
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_sales-channels_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/sales-channels/{id}
* operationId: GetSalesChannelsId
* summary: Get a Sales Channel
* description: Retrieve a sales channel by its ID. You can expand the sales
* channel's relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The sales channel's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/sales-channels/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Sales Channels
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_stores.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/stores
* operationId: GetStores
* summary: List Stores
* description: Retrieve a list of stores. The stores can be filtered by fields
* such as `id`. The stores can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/stores' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Stores
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_stores_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/stores/{id}
* operationId: GetStoresId
* summary: Get a Store
* description: Retrieve a store by its ID. You can expand the store's relations or
* select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The store's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/stores/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Stores
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_tax-rates.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/tax-rates
* operationId: GetTaxRates
* summary: List Tax Rates
* description: Retrieve a list of tax rates. The tax rates can be filtered by
* fields such as `id`. The tax rates can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/tax-rates' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Tax Rates
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_tax-rates_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/tax-rates/{id}
* operationId: GetTaxRatesId
* summary: Get a Tax Rate
* description: Retrieve a tax rate by its ID. You can expand the tax rate's
* relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The tax rate's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/tax-rates/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Tax Rates
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_users.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/users
* operationId: GetUsers
* summary: List Users
* description: Retrieve a list of users. The users can be filtered by fields such
* as `id`. The users can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/users' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Users
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_users_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/users/{id}
* operationId: GetUsersId
* summary: Get a User
* description: Retrieve a user by its ID. You can expand the user's relations or
* select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The user's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/users/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Users
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_users_me.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/users/me
* operationId: GetUsersMe
* summary: List Users
* description: Retrieve a list of users. The users can be filtered by fields such
* as `id`. The users can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/users/me' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Users
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_workflows-executions.ts
+39
View File
@@ -0,0 +1,39 @@
/**
* @oas [get] /admin/workflows-executions
* operationId: GetWorkflowsExecutions
* summary: List Workflows Executions
* description: Retrieve a list of workflows executions. The workflows executions
* can be filtered by fields such as `id`. The workflows executions can also be
* sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/workflows-executions' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Workflows Executions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_workflows-executions_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/workflows-executions/{id}
* operationId: GetWorkflowsExecutionsId
* summary: Get a Workflows Execution
* description: Retrieve a workflows execution by its ID. You can expand the
* workflows execution's relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The workflows execution's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/workflows-executions/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Workflows Executions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts
+53
View File
@@ -0,0 +1,53 @@
/**
* @oas [get] /admin/workflows-executions/{workflow_id}/{transaction_id}
* operationId: GetWorkflowsExecutionsWorkflow_idTransaction_id
* summary: "List "
* description: Retrieve a list of in a workflows execution. The can be filtered
* by fields like FILTER FIELDS. The can also be paginated.
* x-authenticated: true
* parameters:
* - name: workflow_id
* in: path
* description: The workflows execution's workflow id.
* required: true
* schema:
* type: string
* - name: transaction_id
* in: path
* description: The workflows execution's transaction id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl
* '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}'
* \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Workflows Executions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts
+60
View File
@@ -0,0 +1,60 @@
/**
* @oas [get] /admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe
* operationId: GetWorkflowsExecutionsWorkflow_idTransaction_idStep_idSubscribe
* summary: List Subscribes
* description: Retrieve a list of subscribes in a workflows execution. The
* subscribes can be filtered by fields like FILTER FIELDS. The subscribes can
* also be paginated.
* x-authenticated: true
* parameters:
* - name: workflow_id
* in: path
* description: The workflows execution's workflow id.
* required: true
* schema:
* type: string
* - name: transaction_id
* in: path
* description: The workflows execution's transaction id.
* required: true
* schema:
* type: string
* - name: step_id
* in: path
* description: The workflows execution's step id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl
* '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe'
* \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Workflows Executions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts
+45
View File
@@ -0,0 +1,45 @@
/**
* @oas [get] /admin/workflows-executions/{workflow_id}/subscribe
* operationId: GetWorkflowsExecutionsWorkflow_idSubscribe
* summary: List Subscribes
* description: Retrieve a list of subscribes in a workflows execution. The
* subscribes can be filtered by fields like FILTER FIELDS. The subscribes can
* also be paginated.
* x-authenticated: true
* parameters:
* - name: workflow_id
* in: path
* description: The workflows execution's workflow id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/workflows-executions/{workflow_id}/subscribe' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Workflows Executions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_api-keys.ts
+37
View File
@@ -0,0 +1,37 @@
/**
* @oas [post] /admin/api-keys
* operationId: PostApiKeys
* summary: Create Api Key
* description: Create a api key.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/api-keys' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Api Keys
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_api-keys_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [post] /admin/api-keys/{id}
* operationId: PostApiKeysId
* summary: Update a Api Key
* description: Update a api key's details.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The api key's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/api-keys/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Api Keys
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [post] /admin/api-keys/{id}/revoke
* operationId: PostApiKeysIdRevoke
* summary: Add Revokes to Api Key
* description: Add a list of revokes to a api key.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The api key's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/api-keys/{id}/revoke' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Api Keys
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_campaigns.ts
+37
View File
@@ -0,0 +1,37 @@
/**
* @oas [post] /admin/campaigns
* operationId: PostCampaigns
* summary: Create Campaign
* description: Create a campaign.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/campaigns' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Campaigns
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_campaigns_[id].ts
+52
View File
@@ -0,0 +1,52 @@
/**
* @oas [post] /admin/campaigns/{id}
* operationId: PostCampaignsId
* summary: Update a Campaign
* description: Update a campaign's details.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The campaign's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostCampaignsReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/campaigns/{id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "name": "Moriah"
* }'
* tags:
* - Campaigns
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_collections.ts
+37
View File
@@ -0,0 +1,37 @@
/**
* @oas [post] /admin/collections
* operationId: PostCollections
* summary: Create Collection
* description: Create a collection.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/collections' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Collections
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_collections_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [post] /admin/collections/{id}
* operationId: PostCollectionsId
* summary: Update a Collection
* description: Update a collection's details.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The collection's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/collections/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Collections
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_customer-groups.ts
+37
View File
@@ -0,0 +1,37 @@
/**
* @oas [post] /admin/customer-groups
* operationId: PostCustomerGroups
* summary: Create Customer Group
* description: Create a customer group.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customer-groups' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customer Groups
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_customer-groups_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [post] /admin/customer-groups/{id}
* operationId: PostCustomerGroupsId
* summary: Update a Customer Group
* description: Update a customer group's details.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer group's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customer-groups/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customer Groups
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_batch.ts
+56
View File
@@ -0,0 +1,56 @@
/**
* @oas [post] /admin/customer-groups/{id}/customers/batch
* operationId: PostCustomerGroupsIdCustomersBatch
* summary: Add Customers to Customer Group
* description: Add a list of customers to a customer group.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer group's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customer-groups/{id}/customers/batch' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "customer_ids": [
* {
* "id": "id_dx2Wieq4uGG"
* }
* ]
* }'
* tags:
* - Customer Groups
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_remove.ts
+56
View File
@@ -0,0 +1,56 @@
/**
* @oas [post] /admin/customer-groups/{id}/customers/remove
* operationId: PostCustomerGroupsIdCustomersRemove
* summary: Add Removes to Customer Group
* description: Add a list of removes to a customer group.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer group's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customer-groups/{id}/customers/remove' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "customer_ids": [
* {
* "id": "id_oAhMZi39hsjIOqPA6"
* }
* ]
* }'
* tags:
* - Customer Groups
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_customers.ts
+37
View File
@@ -0,0 +1,37 @@
/**
* @oas [post] /admin/customers
* operationId: PostCustomers
* summary: Create Customer
* description: Create a customer.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customers' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_customers_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [post] /admin/customers/{id}
* operationId: PostCustomersId
* summary: Update a Customer
* description: Update a customer's details.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customers/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [post] /admin/customers/{id}/addresses
* operationId: PostCustomersIdAddresses
* summary: Add Addresses to Customer
* description: Add a list of addresses to a customer.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customers/{id}/addresses' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts
+49
View File
@@ -0,0 +1,49 @@
/**
* @oas [post] /admin/customers/{id}/addresses/{address_id}
* operationId: PostCustomersIdAddressesAddress_id
* summary: Add Addresses to Customer
* description: Add a list of addresses to a customer.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer's ID.
* required: true
* schema:
* type: string
* - name: address_id
* in: path
* description: The customer's address id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customers/{id}/addresses/{address_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_add.ts
+60
View File
@@ -0,0 +1,60 @@
/**
* @oas [post] /admin/fulfillment/shipping-options/{id}/rules/batch/add
* operationId: PostFulfillmentShippingOptionsIdRulesBatchAdd
* summary: Add Adds to Fulfillment
* description: Add a list of adds to a fulfillment.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The fulfillment's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X POST
* '{backend_url}/admin/fulfillment/shipping-options/{id}/rules/batch/add' \
*
* -H 'x-medusa-access-token: {api_token}' \
*
* -H 'Content-Type: application/json' \
*
* --data-raw '{
* "rules": [
* {
* "attribute": "{value}"
* }
* ]
* }'
* tags:
* - Fulfillment
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_remove.ts
+60
View File
@@ -0,0 +1,60 @@
/**
* @oas [post] /admin/fulfillment/shipping-options/{id}/rules/batch/remove
* operationId: PostFulfillmentShippingOptionsIdRulesBatchRemove
* summary: Add Removes to Fulfillment
* description: Add a list of removes to a fulfillment.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The fulfillment's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemove\
* Req"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X POST
* '{backend_url}/admin/fulfillment/shipping-options/{id}/rules/batch/remove'
* \
*
* -H 'x-medusa-access-token: {api_token}' \
*
* -H 'Content-Type: application/json' \
*
* --data-raw '{
* "rule_ids": [
* "{value}"
* ]
* }'
* tags:
* - Fulfillment
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_inventory-items.ts
+42
View File
@@ -0,0 +1,42 @@
/**
* @oas [post] /admin/inventory-items
* operationId: PostInventoryItems
* summary: Create Inventory Item
* description: Create a inventory item.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostInventoryItemsReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/inventory-items' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts
+53
View File
@@ -0,0 +1,53 @@
/**
* @oas [post] /admin/inventory-items/{id}/location-levels
* operationId: PostInventoryItemsIdLocationLevels
* summary: Add Location Levels to Inventory Item
* description: Add a list of location levels to a inventory item.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The inventory item's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "location_id": "{value}",
* "stocked_quantity": 1506469662949376
* }'
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_invites.ts
+37
View File
@@ -0,0 +1,37 @@
/**
* @oas [post] /admin/invites
* operationId: PostInvites
* summary: Create Invite
* description: Create a invite.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/invites' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Invites
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_invites_[id]_resend.ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [post] /admin/invites/{id}/resend
* operationId: PostInvitesIdResend
* summary: Add Resends to Invite
* description: Add a list of resends to a invite.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The invite's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/invites/{id}/resend' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Invites
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_invites_accept.ts
+47
View File
@@ -0,0 +1,47 @@
/**
* @oas [post] /admin/invites/accept
* operationId: PostInvitesAccept
* summary: Create Invite
* description: Create a invite.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostInvitesInviteAcceptReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/invites/accept' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "first_name": "{value}",
* "last_name": "{value}"
* }'
* tags:
* - Invites
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_payments_[id]_capture.ts
+48
View File
@@ -0,0 +1,48 @@
/**
* @oas [post] /admin/payments/{id}/capture
* operationId: PostPaymentsIdCapture
* summary: Add Captures to Payment
* description: Add a list of captures to a payment.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The payment's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostPaymentsCapturesReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/payments/{id}/capture' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Payments
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_payments_[id]_refund.ts
+48
View File
@@ -0,0 +1,48 @@
/**
* @oas [post] /admin/payments/{id}/refund
* operationId: PostPaymentsIdRefund
* summary: Add Refunds to Payment
* description: Add a list of refunds to a payment.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The payment's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostPaymentsRefundsReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/payments/{id}/refund' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Payments
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_price-lists.ts
+54
View File
@@ -0,0 +1,54 @@
/**
* @oas [post] /admin/price-lists
* operationId: PostPriceLists
* summary: Create Price List
* description: Create a price list.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostPriceListsReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/price-lists' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "title": "{value}",
* "description": "{value}",
* "prices": [
* {
* "currency_code": "{value}",
* "amount": 1270314195484672,
* "variant_id": "{value}"
* }
* ]
* }'
* tags:
* - Price Lists
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_price-lists_[id].ts
+58
View File
@@ -0,0 +1,58 @@
/**
* @oas [post] /admin/price-lists/{id}
* operationId: PostPriceListsId
* summary: Update a Price List
* description: Update a price list's details.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The price list's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostPriceListsPriceListReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/price-lists/{id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "prices": [
* {
* "currency_code": "{value}",
* "amount": 1670236243755008,
* "variant_id": "{value}"
* }
* ]
* }'
* tags:
* - Price Lists
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_add.ts
+58
View File
@@ -0,0 +1,58 @@
/**
* @oas [post] /admin/price-lists/{id}/prices/batch/add
* operationId: PostPriceListsIdPricesBatchAdd
* summary: Add Adds to Price List
* description: Add a list of adds to a price list.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The price list's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch/add' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "prices": [
* {
* "currency_code": "{value}",
* "amount": 6595965345595392,
* "variant_id": "{value}"
* }
* ]
* }'
* tags:
* - Price Lists
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_remove.ts
+54
View File
@@ -0,0 +1,54 @@
/**
* @oas [post] /admin/price-lists/{id}/prices/batch/remove
* operationId: PostPriceListsIdPricesBatchRemove
* summary: Add Removes to Price List
* description: Add a list of removes to a price list.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The price list's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch/remove' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "ids": [
* "{value}"
* ]
* }'
* tags:
* - Price Lists
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_pricing_rule-types.ts
+48
View File
@@ -0,0 +1,48 @@
/**
* @oas [post] /admin/pricing/rule-types
* operationId: PostPricingRuleTypes
* summary: Create Pricing
* description: Create a pricing.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostPricingRuleTypesReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/pricing/rule-types' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "name": "Thurman",
* "rule_attribute": "{value}",
* "default_priority": 4640267816665088
* }'
* tags:
* - Pricing
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/
docs-util/oas-output/operations/admin/post_admin_pricing_rule-types_[id].ts
+48
View File
@@ -0,0 +1,48 @@
/**
* @oas [post] /admin/pricing/rule-types/{id}
* operationId: PostPricingRuleTypesId
* summary: Add Rule Types to Pricing
* description: Add a list of rule types to a pricing.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The pricing's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostPricingRuleTypesRuleTypeReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/pricing/rule-types/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Pricing
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "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"
*
*/

Some files were not shown because too many files have changed in this diff Show More