Merge branch 'use-order-for-quotes' of github.com:Rebilly/api-definit…

…ions into use-order-for-quotes
Rebilly · May 14, 2024 · d15bf5f · d15bf5f
2 parents f6c612e + 55a8baf
commit d15bf5f
Show file tree

Hide file tree

Showing 22 changed files with 46 additions and 39 deletions.
diff --git a/openapi/components/requestBodies/PatchCreditMemo.yaml b/openapi/components/requestBodies/PatchCreditMemo.yaml
@@ -82,7 +82,7 @@ properties:
           description: ID of the credit memo item.
           readOnly: true
           maxLength: 50
-          example: crmm_itm_0YVCNN22TWC3G8H82QNPNVZCHG
+          example: crmm_itm_01HXC7PK2C6F367VYCFXDRYMAQ
         invoiceItemId:
           description: ID of the invoice item to which the credit item is referenced.
           type:

diff --git a/openapi/components/requestBodies/Webhooks/QuoteWebhook.yaml b/openapi/components/requestBodies/Webhooks/QuoteWebhook.yaml
@@ -5,7 +5,7 @@ content:
         quoteId:
           type: string
           description: ID of the quote.
-          example: qt_01GYJPRKHBD6ZYHH897QCJMBS4
+          example: qt_01HXBZMEGPETPHJZH6V4RHBMA8
         eventType:
           type: string
           description: Type of webhook event.

diff --git a/openapi/components/requestBodies/Webhooks/UsageLimitWebhook.yaml b/openapi/components/requestBodies/Webhooks/UsageLimitWebhook.yaml
@@ -13,7 +13,7 @@ content:
         planId:
           type: string
           description: ID of the plan.
-          example: plan_01GYJPRKHBD6ZYHH897QCJMBS4
+          example: plan_0YV7DENSVGDBW9S71XZNNYYQ0X
         usageQuantity:
           type: integer
           description: Reported usage quantity.

diff --git a/openapi/components/schemas/Allowlist.yaml b/openapi/components/schemas/Allowlist.yaml
@@ -9,7 +9,7 @@ properties:
     description: ID of the allowlist record.
     readOnly: true
     maxLength: 50
-    example: rsal_0YVF9605RKC62BP14NE2R7V2XT
+    example: rsal_01HXBY67D5CNWM2YK79PFZR4C2
   type:
     type: string
     description: |-

diff --git a/openapi/components/schemas/CouponRedemption.yaml b/openapi/components/schemas/CouponRedemption.yaml
@@ -6,7 +6,7 @@ properties:
     readOnly: true
     description: Unique resource ID.
     maxLength: 50
-    example: cpn_rdm_0YVCNKF81GD778N4YNVGDJK558
+    example: cpn_rdm_01HXC82EEPW6YD3MPWJY7151VR
   couponId:
     type: string
     description: ID of the coupon.

diff --git a/openapi/components/schemas/CreditMemo.yaml b/openapi/components/schemas/CreditMemo.yaml
@@ -95,7 +95,7 @@ properties:
           description: ID of the credit memo item.
           readOnly: true
           maxLength: 50
-          example: crmm_itm_0YVCNN22TWC3G8H82QNPNVZCHG
+          example: crmm_itm_01HXC7PK2C6F367VYCFXDRYMAQ
         invoiceItemId:
           description: ID of the invoice item to which the credit item is referenced.
           type:

diff --git a/openapi/components/schemas/GatewayAccountConfig/SecureTrading.yaml b/openapi/components/schemas/GatewayAccountConfig/SecureTrading.yaml
@@ -33,5 +33,13 @@ allOf:
           - websiteId
           - username
           - password
+      settings:
+        type: object
+        description: SecureTrading settings object.
+        properties:
+          enableRecurring:
+            type: boolean
+            description: Enables recurring payments.
+            default: false
       threeDSecureServer:
         $ref: ./ThreeDSecureIO3dsServer.yaml
diff --git a/openapi/components/schemas/Invoice.yaml b/openapi/components/schemas/Invoice.yaml
@@ -40,7 +40,7 @@ properties:
       This field is `null` if there are no related quotes.
     readOnly: true
     maxLength: 50
-    example: qt_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: qt_01HXBZMEGPETPHJZH6V4RHBMA8
   currency:
     x-sortable: true
     x-basic: true

diff --git a/openapi/components/schemas/OrganizationExport.yaml b/openapi/components/schemas/OrganizationExport.yaml
@@ -5,7 +5,7 @@ properties:
     type: string
     description: Unique resource ID.
     maxLength: 50
-    example: org_exp_0YVDMCH30ZC2XA5BYHH6B6SRTJ
+    example: org_exp_01HXC7MKK4GCS6WRRXY4X9CRMK
   userId:
     description: ID of the user who requested the organization data export.
     readOnly: true

diff --git a/openapi/components/schemas/QuoteChangeOrder.yaml b/openapi/components/schemas/QuoteChangeOrder.yaml
@@ -12,7 +12,7 @@ properties:
     description: ID of the quote.
     type: string
     maxLength: 50
-    example: qt_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: qt_01HXBZMEGPETPHJZH6V4RHBMA8
   type:
     description: |-
       Type of the quote.
@@ -82,7 +82,7 @@ properties:
     description: ID of the related order.
     type: string
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: ord_01HVKA5975PJBSQ1SX72G3MSZC
   orderChanges:
     type: object
     description: Related order properties.
@@ -130,7 +130,7 @@ properties:
           description: |-
             ID of the plan to which usages are transferred.
             If an item with a specified plan does not exist, or does not have a metered billing plan, this transfer is ignored.
-          example: plan_0YV7DENSVGDBW9S71XZNNYYQ0Y
+          example: plan_0YV7DENSVGDBW9S71XZNNYYQ0X
   invoicePreview:
     type: object
     description: Preview of the quote invoices.
@@ -211,7 +211,7 @@ properties:
             quoteItemId:
               description: ID of the related quote item.
               type: string
-              example: qti_0YV7DES3WPC5J8JD8QTVNZBZNZ
+              example: qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY
             type:
               type: string
               description: Type of the invoice item.

diff --git a/openapi/components/schemas/QuoteCreateOrder.yaml b/openapi/components/schemas/QuoteCreateOrder.yaml
@@ -11,7 +11,7 @@ properties:
     description: ID of the quote.
     type: string
     maxLength: 50
-    example: qt_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: qt_01HXBZMEGPETPHJZH6V4RHBMA8
   type:
     description: |-
       Type of the quote.
@@ -194,7 +194,7 @@ properties:
             quoteItemId:
               description: ID of the related quote item.
               type: string
-              example: qti_0YV7DES3WPC5J8JD8QTVNZBZNZ
+              example: qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY
             type:
               type: string
               description: Type of the invoice item.

diff --git a/openapi/components/schemas/QuoteOrderItem.yaml b/openapi/components/schemas/QuoteOrderItem.yaml
@@ -6,11 +6,10 @@ properties:
     description: ID of the quote item.
     readOnly: true
     type: string
-    example: qti_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY
   id:
     description: ID of the related order item.
     type: string
-    example: sub_0YV7DES3WPC5J8JD8QTVNZBZNZ
   type:
     description: Specifies the type of order item.
     type: string

diff --git a/openapi/components/schemas/QuoteReactivateOrder.yaml b/openapi/components/schemas/QuoteReactivateOrder.yaml
@@ -12,7 +12,7 @@ properties:
     description: ID of the quote.
     type: string
     maxLength: 50
-    example: qt_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: qt_01HXBZMEGPETPHJZH6V4RHBMA8
   type:
     description: |-
       Type of the quote.
@@ -82,7 +82,7 @@ properties:
     description: ID of the related order.
     type: string
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: ord_01HVKA5975PJBSQ1SX72G3MSZC
   orderChanges:
     type: object
     description: Related order properties.
@@ -192,7 +192,7 @@ properties:
             quoteItemId:
               description: ID of the related quote item.
               type: string
-              example: qti_0YV7DES3WPC5J8JD8QTVNZBZNZ
+              example: qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY
             type:
               type: string
               description: Type of the invoice item.

diff --git a/openapi/components/schemas/QuoteTrialConversionOrder.yaml b/openapi/components/schemas/QuoteTrialConversionOrder.yaml
@@ -12,7 +12,7 @@ properties:
     description: ID of the quote.
     type: string
     maxLength: 50
-    example: qt_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: qt_01HXBZMEGPETPHJZH6V4RHBMA8
   type:
     description: |-
       Type of the quote.
@@ -182,7 +182,7 @@ properties:
             quoteItemId:
               description: ID of the related quote item.
               type: string
-              example: qti_0YV7DES3WPC5J8JD8QTVNZBZNZ
+              example: qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY
             type:
               type: string
               description: Type of the invoice item.

diff --git a/openapi/components/schemas/StorefrontKycLivenessSession.yaml b/openapi/components/schemas/StorefrontKycLivenessSession.yaml
@@ -8,7 +8,7 @@ properties:
     readOnly: true
     description: ID of the KYC liveness session.
     maxLength: 50
-    example: kyc_liv_0YV7JMJ3DBCGRBR7K9D4HVGPP5
+    example: kyc_liv_01HXBZ0MS1GPS6S34MPQXYT5TZ
   customerId:
     $ref: ./CustomerId.yaml
     readOnly: true

diff --git a/openapi/components/schemas/StorefrontQuoteChangeOrder.yaml b/openapi/components/schemas/StorefrontQuoteChangeOrder.yaml
@@ -5,7 +5,7 @@ properties:
     description: ID of the quote.
     type: string
     maxLength: 50
-    example: qt_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: qt_01HXBZMEGPETPHJZH6V4RHBMA8
   type:
     description: |-
       Type of the quote.
@@ -76,7 +76,7 @@ properties:
     readOnly: true
     type: string
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: ord_01HVKA5975PJBSQ1SX72G3MSZC
   orderChanges:
     type: object
     description: Related order properties.
@@ -124,7 +124,7 @@ properties:
           description: |-
             ID of the plan to which usages are transferred.
             If an item with a specified plan does not exist, or does not have a metered billing plan, this transfer is ignored.
-          example: plan_0YV7DENSVGDBW9S71XZNNYYQ0Y
+          example: plan_0YV7DENSVGDBW9S71XZNNYYQ0X
   invoicePreview:
     type: object
     description: Preview of the quote invoices.
@@ -205,7 +205,7 @@ properties:
             quoteItemId:
               description: ID of the related quote item.
               type: string
-              example: qti_0YV7DES3WPC5J8JD8QTVNZBZNZ
+              example: qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY
             type:
               type: string
               description: Type of the invoice item.

diff --git a/openapi/components/schemas/StorefrontQuoteCreateOrder.yaml b/openapi/components/schemas/StorefrontQuoteCreateOrder.yaml
@@ -5,7 +5,7 @@ properties:
     description: ID of the quote.
     type: string
     maxLength: 50
-    example: qt_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: qt_01HXBZMEGPETPHJZH6V4RHBMA8
   type:
     description: |-
       Type of the quote.
@@ -78,7 +78,7 @@ properties:
       - 'string'
       - 'null'
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: ord_01HVKA5975PJBSQ1SX72G3MSZC
   orderChanges:
     type: object
     description: Related order properties.
@@ -188,7 +188,7 @@ properties:
             quoteItemId:
               description: ID of the related quote item.
               type: string
-              example: qti_0YV7DES3WPC5J8JD8QTVNZBZNZ
+              example: qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY
             type:
               type: string
               description: Type of the invoice item.

diff --git a/openapi/components/schemas/StorefrontQuoteReactivateOrder.yaml b/openapi/components/schemas/StorefrontQuoteReactivateOrder.yaml
@@ -5,7 +5,7 @@ properties:
     description: ID of the quote.
     type: string
     maxLength: 50
-    example: qt_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: qt_01HXBZMEGPETPHJZH6V4RHBMA8
   type:
     description: |-
       Type of the quote for churned or canceled order reactivation.
@@ -76,7 +76,7 @@ properties:
     readOnly: true
     type: string
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: ord_01HVKA5975PJBSQ1SX72G3MSZC
   orderChanges:
     type: object
     description: Related order properties.
@@ -186,7 +186,7 @@ properties:
             quoteItemId:
               description: ID of the related quote item.
               type: string
-              example: qti_0YV7DES3WPC5J8JD8QTVNZBZNZ
+              example: qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY
             type:
               type: string
               description: Type of the invoice item.

diff --git a/openapi/components/schemas/StorefrontQuoteTrialConversionOrder.yaml b/openapi/components/schemas/StorefrontQuoteTrialConversionOrder.yaml
@@ -5,7 +5,7 @@ properties:
     description: ID of the quote.
     type: string
     maxLength: 50
-    example: qt_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: qt_01HXBZMEGPETPHJZH6V4RHBMA8
   type:
     description: |-
       Type of the quote.
@@ -76,7 +76,7 @@ properties:
     readOnly: true
     type: string
     maxLength: 50
-    example: ord_0YV7DES3WPC5J8JD8QTVNZBZNZ
+    example: ord_01HVKA5975PJBSQ1SX72G3MSZC
   orderChanges:
     type: object
     description: Related order properties.
@@ -176,7 +176,7 @@ properties:
             quoteItemId:
               description: ID of the related quote item.
               type: string
-              example: qti_0YV7DES3WPC5J8JD8QTVNZBZNZ
+              example: qt_itm_01HXCEQNR3F1G2A6RX6HPS3KFY
             type:
               type: string
               description: Type of the invoice item.

diff --git a/openapi/components/schemas/Transaction.yaml b/openapi/components/schemas/Transaction.yaml
@@ -610,7 +610,7 @@ properties:
       - 'null'
     description: ID of the payout request if applicable. The created transaction is based on the properties of this payout request.
     maxLength: 50
-    example: pout_req_0YVJ65BSGYC3EAT58SEX8KY6J7
+    example: pout_req_0YVDMDE2BMC6KBB5MX76RF6T80
   _links:
     type: array
     description: Related links.

diff --git a/openapi/components/schemas/WebhookTracking.yaml b/openapi/components/schemas/WebhookTracking.yaml
@@ -6,7 +6,7 @@ properties:
     type: string
     description: ID of the webhook tracking log.
     maxLength: 50
-    example: hook_log_0YVBG8S0K0DG59J6S3RMN9K452
+    example: hook_log_01HXC7HJ1V2FNJD1R396WCG2HB
   status:
     type: integer
     x-sortable: true

diff --git a/openapi/paths/tags@{tag}@aml-checks.yaml b/openapi/paths/tags@{tag}@aml-checks.yaml
@@ -29,7 +29,7 @@ post:
               maxItems: 1000
               items:
                 type: string
-                example: aml_chk_0YV7JHY705C6DA487BFTAA33V8
+                example: aml_chk_0YV8XJT2ZWDR398Q8NFEM7DEPM
   responses:
     '204':
       description: AML checks tagging process has been scheduled.
@@ -68,7 +68,7 @@ delete:
               maxItems: 1000
               items:
                 type: string
-                example: aml_chk_0YV7JHY705C6DA487BFTAA33V8
+                example: aml_chk_0YV8XJT2ZWDR398Q8NFEM7DEPM
   responses:
     '204':
       description: AML checks untagging process has been scheduled.