chore(docs): Updated API Reference (automated) (#10685)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-12-23 08:35:12 +00:00
1 parent 326f190b73
commit 198fa53120
@@ -0,0 +1,47 @@
+/**
+ * @oas [get] /admin/fulfillment-providers/{id}/options
+ * operationId: GetFulfillmentProvidersIdOptions
+ * summary: List Fulfillment Options
+ * description: Retrieve the list of fulfillment options of a fulfillment provider. These options may be retrieved from an integrated third-party service.
+ * x-authenticated: true
+ * parameters:
+ *   - name: id
+ *     in: path
+ *     description: The fulfillment provider'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/fulfillment-providers/{id}/options' \
+ *       -H 'Authorization: Bearer {access_token}'
+ * tags:
+ *   - Fulfillment Providers
+ * responses:
+ *   "200":
+ *     description: OK
+ *     content:
+ *       application/json:
+ *         schema:
+ *           $ref: "#/components/schemas/AdminFulfillmentProviderOptionsListResponse"
+ *   "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"
+ * 
+*/
+
@@ -0,0 +1,20 @@
+/**
+ * @schema AdminFulfillmentProviderOption
+ * type: object
+ * description: The fulfillment option's details.
+ * x-schemaName: AdminFulfillmentProviderOption
+ * required:
+ *   - id
+ *   - is_return
+ * properties:
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The fulfillment option's ID.
+ *   is_return:
+ *     type: boolean
+ *     title: is_return
+ *     description: Whether the fulfillment option is used for returns.
+ * 
+*/
+
@@ -0,0 +1,31 @@
+/**
+ * @schema AdminFulfillmentProviderOptionsListResponse
+ * type: object
+ * description: The paginated list of fulfillment options.
+ * x-schemaName: AdminFulfillmentProviderOptionsListResponse
+ * required:
+ *   - limit
+ *   - offset
+ *   - count
+ *   - fulfillment_options
+ * properties:
+ *   limit:
+ *     type: number
+ *     title: limit
+ *     description: The maximum number of items returned.
+ *   offset:
+ *     type: number
+ *     title: offset
+ *     description: The number of items skipped before retrieving the returned items.
+ *   count:
+ *     type: number
+ *     title: count
+ *     description: The total number of items.
+ *   fulfillment_options:
+ *     type: array
+ *     description: The list of fulfillment options.
+ *     items:
+ *       $ref: "#/components/schemas/AdminFulfillmentProviderOption"
+ * 
+*/
+
@@ -213,6 +213,11 @@
 *     type: number
 *     title: display_id
 *     description: The order's display ID.
+ *   credit_lines:
+ *     type: array
+ *     description: The order's credit lines, useful to add additional payment amounts for an order.
+ *     items:
+ *       $ref: "#/components/schemas/OrderCreditLine"
 * 
 */

@@ -0,0 +1,49 @@
+/**
+ * @schema OrderCreditLine
+ * type: object
+ * description: The credit line's details.
+ * x-schemaName: OrderCreditLine
+ * required:
+ *   - id
+ *   - order_id
+ *   - order
+ *   - reference
+ *   - reference_id
+ *   - metadata
+ *   - created_at
+ *   - updated_at
+ * properties:
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The credit line's ID.
+ *   order_id:
+ *     type: string
+ *     title: order_id
+ *     description: The ID of the associated order.
+ *   order:
+ *     $ref: "#/components/schemas/Order"
+ *   reference:
+ *     type: string
+ *     title: reference
+ *     description: The table that this credit line references. For example, `payment_collection`.
+ *   reference_id:
+ *     type: string
+ *     title: reference_id
+ *     description: The ID of the record in the referenced table. For example, `paycol_123`.
+ *   metadata:
+ *     type: object
+ *     description: The credit line's metadata, can hold custom key-value pairs.
+ *   created_at:
+ *     type: string
+ *     format: date-time
+ *     title: created_at
+ *     description: The date the credit line was created.
+ *   updated_at:
+ *     type: string
+ *     format: date-time
+ *     title: updated_at
+ *     description: The date the credit line was updated.
+ * 
+*/
+