Update API definitions

Author: rebilly-machine-user

CONTRIBUTING.md

@@ -124,7 +124,7 @@ Rebilly uses the following lint rules:
 - [rule/info-description](https://redocly.com/docs/cli/rules/custom-rules/) (custom rules)
 - [rule/description-capitalization](https://redocly.com/docs/cli/rules/custom-rules/) (custom rules)
 - [rule/description-punctuation](https://redocly.com/docs/cli/rules/custom-rules/) (custom rules)
-- [rule/no-anthropmorphic-possessives](https://redocly.com/docs/cli/rules/custom-rules/) (custom rules)
+- [rule/no-anthropomorphic-possessives](https://redocly.com/docs/cli/rules/custom-rules/) (custom rules)
 - [rule/no-past-future](https://redocly.com/docs/cli/rules/custom-rules/) (custom rules)
 - [rule/no-description-start-with-the-a-an](https://redocly.com/docs/cli/rules/custom-rules/) (custom rules)
 

openapi/components/schemas/OneTimeSale.yaml

@@ -153,7 +153,6 @@ properties:
   notes:
     description: Notes for the customer displayed on the order invoice.
     type: string
-
   revision:
     description: |-
       Number of times the order data has been modified.
@@ -163,7 +162,6 @@ properties:
     type: integer
     readOnly: true
   riskMetadata:
-    example: null
     description: |-
       Risk metadata.
       If this value is `null`, this field uses risk metadata that is captured when creating the payment token.

openapi/components/schemas/StorefrontSubscription.yaml

@@ -161,82 +161,13 @@ properties:
           Plans without trial prices are free trials.
         type: boolean
         readOnly: true
-      trial:
-        type: object
-        description: |-
-          Trial details.
-          To use plan defaults do not send the `trial` key, or send a `null` value.
-        properties:
-          enabled:
-            description: |-
-              Specifies if there is a trial for this subscription.
-              Plans without trial prices are free trials.
-            type: boolean
-          endTime:
-            description: |-
-              Time and date when the trial ends.
-              If a trial is enabled on this subscription, a value must be provided.
-            type: string
-            format: date-time
-      isTrialOnly:
-        description: |-
-          Specifies if a subscription ends after a trial period.
-          If this value is `true`, recurring settings are ignored.
-        type: boolean
-        default: false
-      invoiceTimeShift:
-        description: |-
-          Shifts issue time and due time of invoices for this subscription.
-
-          This setting overrides plan settings.
-          To use plan settings, set this value to `null`.
-
-          To use multiple plans in one subscription,
-          all plans must have the same billing period,
-          this property enables the customer to subscribe to different plans.
-        example: null
-        oneOf:
-          - $ref: ./InvoiceTimeShift.yaml
-          - type: 'null'
-      recurringInterval:
-        type:
-          - 'object'
-          - 'null'
-        description: |-
-          Recurring interval to override plan settings.
-          To use plan settings, set this value to `null`.
-
-          To use multiple plans in one subscription,
-          all plans must have the same same recurring period length,
-          this property enables the customer to subscribe to different plans.
-        example: null
-        properties:
-          periodAnchorInstruction:
-            $ref: ./ServicePeriodAnchorInstruction.yaml
-      autopay:
-        description: |-
-          Specifies if payment attempts are made automatically.
-          If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
-          or the default payment instrument on the subscription.
-        type: boolean
-        default: true
-      startTime:
-        description: |-
-          Date and time when the subscription starts.
-          If this value is `null`, the current time is used.
-          This value cannot be more than one service period in the past.
-        type:
-          - 'string'
-          - 'null'
-        x-sortable: true
-        x-basic: true
-        example: null
-        format: date-time
       endTime:
         description: |-
           Time and date when the trial ends.
           If a trial is enabled on this subscription, a value must be provided.
-        type: string
+        type:
+          - 'string'
+          - 'null'
         format: date-time
   isTrialOnly:
     description: |-
@@ -254,10 +185,7 @@ properties:
       To use multiple plans in one subscription,
       all plans must have the same billing period,
       this property enables the customer to subscribe to different plans.
-    example: null
-    oneOf:
-      - $ref: ./InvoiceTimeShift.yaml
-      - type: 'null'
+    $ref: ./InvoiceTimeShift.yaml
   recurringInterval:
     type:
       - 'object'

openapi/components/schemas/Subscription.yaml

@@ -128,10 +128,7 @@ properties:
       To use multiple plans in one subscription,
       all plans must have the same billing period,
       this property enables the customer to subscribe to different plans.
-    example: null
-    oneOf:
-      - $ref: ./InvoiceTimeShift.yaml
-      - type: 'null'
+    $ref: ./InvoiceTimeShift.yaml
   recurringInterval:
     type:
       - 'object'
@@ -444,15 +441,12 @@ properties:
     type: integer
     readOnly: true
   riskMetadata:
-    type:
-      - 'object'
-      - 'null'
-    example: null
     description: |-
       Risk metadata.
       If this value is `null`, this field uses risk metadata that is captured when creating the payment token.
-    allOf:
+    oneOf:
       - $ref: ./RiskMetadata.yaml
+      - type: 'null'
   billingPortalToken:
     description: |-
       Customer JWT to access billing portal. This field is presented only if billing portal exists.

openapi/components/schemas/SubscriptionChange.yaml

@@ -115,6 +115,6 @@ properties:
     description: |-
       Specifies if the subscription order must ignore the recurring settings of items in the order.
       This field is only applicable if the subscription is trial-only and the `keepTrial` value is `true`.
-      For more information, see [Trial-only subscription](https://www.rebilly.com/docs/dev-docs/subscriptions#trial-only-subscription)
+      For more information, see [Trial-only subscription](https://www.rebilly.com/docs/dev-docs/subscriptions#trial-only-subscription).
     type: boolean
     default: false

openapi/components/schemas/Website.yaml

@@ -109,7 +109,7 @@ properties:
                 type:
                   - 'boolean'
                   - 'null'
-                description: Specifies whether the hosted payment form will display 0 amount line items in the summary.
+                description: Specifies whether the hosted payment form displays 0 amount line items in the summary.
                 default: false
   logoId:
     type:

redocly.yaml

@@ -385,14 +385,14 @@ rules:
       type: any
       property: description
     assertions:
-      pattern: /^([A-Z]|#+ [A-Z]|dLocal|ecoPayz|eMerchantPay|ePay|eZeeWallet|ezyEFT|iCanPay|iCheque|iDebit|loonie|vegaaH)/
+      pattern: /^([A-Z]|#+ [A-Z]|dLocal|ecoPayz|eMerchantPay|ePay|eZeeWallet|ezyEFT|iCanPay|iCheque|iDebit|loonie|vegaaH|gate2way)/
   rule/description-punctuation:
     subject:
       type: any
       property: description
     assertions:
       pattern: /(\.\n?|server)$/
-  rule/no-anthropmorphic-possessives:
+  rule/no-anthropomorphic-possessives:
     subject:
       type: any
       property: description