chore(docs): Updated API Reference (v2) (#9437)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-03 07:48:54 +00:00
parent 97c193be1b
commit 21badd069d
894 changed files with 35649 additions and 28168 deletions
@@ -60,12 +60,150 @@
 *     type: array
 *     description: The shipping method's tax lines.
 *     items:
- *       $ref: "#/components/schemas/BaseShippingMethodTaxLine"
+ *       allOf:
+ *         - type: object
+ *           description: The tax line's details
+ *           x-schemaName: BaseShippingMethodTaxLine
+ *           required:
+ *             - shipping_method
+ *             - shipping_method_id
+ *             - total
+ *             - subtotal
+ *             - id
+ *             - code
+ *             - rate
+ *             - created_at
+ *             - updated_at
+ *           properties:
+ *             shipping_method:
+ *               type: object
+ *               title: shipping_method
+ *               description: The details of the method that the tax line belongs to.
+ *             shipping_method_id:
+ *               type: string
+ *               title: shipping_method_id
+ *               description: The ID of the shipping method this tax line belongs to.
+ *             total:
+ *               type: number
+ *               title: total
+ *               description: The method's total including taxes and promotions.
+ *             subtotal:
+ *               type: number
+ *               title: subtotal
+ *               description: The method's total excluding taxes, including promotions.
+ *             id:
+ *               type: string
+ *               title: id
+ *               description: The tax line's ID.
+ *             description:
+ *               type: string
+ *               title: description
+ *               description: The tax line's description.
+ *             tax_rate_id:
+ *               type: string
+ *               title: tax_rate_id
+ *               description: The ID of the applied tax rate.
+ *             code:
+ *               type: string
+ *               title: code
+ *               description: The code that the tax rate is identified by.
+ *             rate:
+ *               type: number
+ *               title: rate
+ *               description: The charged rate.
+ *             provider_id:
+ *               type: string
+ *               title: provider_id
+ *               description: The ID of the tax provider used to calculate the tax line.
+ *             created_at:
+ *               type: string
+ *               format: date-time
+ *               title: created_at
+ *               description: The date the tax line was created.
+ *             updated_at:
+ *               type: string
+ *               format: date-time
+ *               title: updated_at
+ *               description: The date the tax line was updated.
+ *         - type: object
+ *           description: The tax line's details.
+ *           required:
+ *             - shipping_method
+ *           properties:
+ *             shipping_method:
+ *               type: object
+ *               title: shipping_method
+ *               description: The details of the method that the tax line belongs to.
+ *       description: The tax line's details.
 *   adjustments:
 *     type: array
 *     description: The shipping method's adjustments, such as applied promotions.
 *     items:
- *       $ref: "#/components/schemas/BaseShippingMethodAdjustment"
+ *       allOf:
+ *         - type: object
+ *           description: The adjustment's details.
+ *           x-schemaName: BaseShippingMethodAdjustment
+ *           required:
+ *             - shipping_method
+ *             - shipping_method_id
+ *             - id
+ *             - amount
+ *             - cart_id
+ *             - created_at
+ *             - updated_at
+ *           properties:
+ *             shipping_method:
+ *               type: object
+ *               title: shipping_method
+ *               description: The details of the method that the adjustment belongs to.
+ *             id:
+ *               type: string
+ *               title: id
+ *               description: The adjustment's ID.
+ *             code:
+ *               type: string
+ *               title: code
+ *               description: The adjustment's code.
+ *             amount:
+ *               type: number
+ *               title: amount
+ *               description: The adjustment's amount.
+ *             cart_id:
+ *               type: string
+ *               title: cart_id
+ *               description: The ID of the associated cart.
+ *             description:
+ *               type: string
+ *               title: description
+ *               description: The adjustment's description.
+ *             promotion_id:
+ *               type: string
+ *               title: promotion_id
+ *               description: The ID of the applied promotion.
+ *             provider_id:
+ *               type: string
+ *               title: provider_id
+ *               description: The adjustment's provider ID.
+ *             created_at:
+ *               type: string
+ *               format: date-time
+ *               title: created_at
+ *               description: The date the adjustment was created.
+ *             updated_at:
+ *               type: string
+ *               format: date-time
+ *               title: updated_at
+ *               description: The date the adjustment was updated.
+ *         - type: object
+ *           description: The adjustment's details.
+ *           required:
+ *             - shipping_method
+ *           properties:
+ *             shipping_method:
+ *               type: object
+ *               title: shipping_method
+ *               description: The details of the method that the adjustment belongs to.
+ *       description: The adjustment's details.
 *   created_at:
 *     type: string
 *     format: date-time