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

chore(docs): Generated API Reference (automated) (#9962)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-11-07 09:14:58 +01:00
committed by GitHub
co-authored by olivermrbl
parent 0fbee723b4
commit 242d00b567
46 changed files with 1083 additions and 471 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts
+24 -6
View File
@@ -969,12 +969,16 @@
* description: Filter by region IDs to retrieve their associated draft orders.
* required: false
* schema:
* type: array
* description: Filter by region IDs to retrieve their associated draft orders.
* items:
* type: string
* title: region_id
* description: A region's ID.
* oneOf:
* - type: string
* title: region_id
* description: The draft order's region id.
* - type: array
* description: The draft order's region id.
* items:
* type: string
* title: region_id
* description: The region id's details.
* - name: q
* in: query
* description: Search term to filter the order's searchable properties.
@@ -1445,6 +1449,20 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: customer_id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: customer_id
* description: The draft order's customer id.
* - type: array
* description: The draft order's customer id.
* items:
* type: string
* title: customer_id
* description: The customer id's details.
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts
-14
View File
@@ -51,20 +51,6 @@
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: location_id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: location_id
* description: Filter by an associated location's ID.
* - type: array
* description: Filter by associated location IDs.
* items:
* type: string
* title: location_id
* description: An associated location ID.
* - name: $and
* in: query
* required: false
www/utils/generated/oas-output/operations/admin/get_admin_orders.ts
+24 -6
View File
@@ -149,12 +149,16 @@
* description: Filter by region IDs to retrieve their associated orders.
* required: false
* schema:
* type: array
* description: Filter by region IDs to retrieve their associated orders.
* items:
* type: string
* title: region_id
* description: A region ID.
* oneOf:
* - type: string
* title: region_id
* description: The order's region id.
* - type: array
* description: The order's region id.
* items:
* type: string
* title: region_id
* description: The region id's details.
* - name: q
* in: query
* description: Search term to filter the order's searchable properties.
@@ -625,6 +629,20 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: customer_id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: customer_id
* description: The order's customer id.
* - type: array
* description: The order's customer id.
* items:
* type: string
* title: customer_id
* description: The customer id's details.
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/get_admin_returns.ts
+24 -6
View File
@@ -149,12 +149,16 @@
* description: Filter by region IDs to retrieve their associated returns.
* required: false
* schema:
* type: array
* description: Filter by region IDs to retrieve their associated returns.
* items:
* type: string
* title: region_id
* description: The region id's details.
* oneOf:
* - type: string
* title: region_id
* description: The return's region id.
* - type: array
* description: The return's region id.
* items:
* type: string
* title: region_id
* description: The region id's details.
* - name: q
* in: query
* description: Search term to filter the return's searchable properties.
@@ -625,6 +629,20 @@
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: customer_id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: customer_id
* description: The return's customer id.
* - type: array
* description: The return's customer id.
* items:
* type: string
* title: customer_id
* description: The customer id's details.
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts
+83
View File
@@ -0,0 +1,83 @@
/**
* @oas [post] /admin/customers/{id}/customer-groups
* operationId: PostCustomersIdCustomerGroups
* summary: Add Customer Group to Customer
* description: Add a Customer Group to a customer
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer's ID.
* required: true
* schema:
* type: string
* - name: fields
* in: query
* description: |-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. Without prefix it will replace the entire default fields.
* externalDocs:
* url: "#select-fields-and-relations"
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* properties:
* add:
* type: array
* description: The customer's add.
* items:
* type: string
* title: add
* description: The add's details.
* remove:
* type: array
* description: The customer's remove.
* items:
* type: string
* title: remove
* description: The remove's details.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/customers/{id}/customer-groups' \
* -H 'Authorization: Bearer {access_token}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminCustomerResponse"
* "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"
* x-workflow: linkCustomerGroupsToCustomerWorkflow
*
*/