From cac3bf864edebb0afcbf24dfc3cde722e364d5f3 Mon Sep 17 00:00:00 2001 From: Chris <85164331+noon-dawg@users.noreply.github.com> Date: Wed, 20 Dec 2023 14:41:20 +0000 Subject: [PATCH] Update references --- README.md | 16 +++++++++------- .../components/parameters/collectionExpand.yaml | 2 +- .../components/parameters/collectionFilter.yaml | 2 +- .../requestBodies/PostDepositRequest.yaml | 6 +++--- .../components/schemas/ApplicationInstance.yaml | 2 +- openapi/components/schemas/Bind.yaml | 2 +- openapi/components/schemas/DepositRequest.yaml | 4 ++-- openapi/components/schemas/DepositStrategy.yaml | 6 +++--- openapi/components/schemas/FlexiblePlan.yaml | 2 +- openapi/components/schemas/GatewayAccount.yaml | 5 ++--- openapi/components/schemas/GlobalWebhook.yaml | 2 +- openapi/components/schemas/OneTimeOrder.yaml | 2 +- openapi/components/schemas/OriginalPlan.yaml | 2 +- .../schemas/ReadyToPayMethodFilters.yaml | 2 +- openapi/components/schemas/RebillyShipping.yaml | 2 +- .../components/schemas/ResourceCustomFields.yaml | 2 +- .../schemas/StorefrontOneTimeOrder.yaml | 2 +- .../schemas/StorefrontSubscriptionOrder.yaml | 2 +- .../components/schemas/SubscriptionOrder.yaml | 2 +- .../components/schemas/VaultedInstrument.yaml | 2 +- openapi/description.md | 14 +++++++------- openapi/openapi.yaml | 6 +++--- openapi/paths/ready-to-pay.yaml | 2 +- openapi/paths/reports@revenue-audit.yaml | 2 +- openapi/paths/storefront/ready-to-pay.yaml | 2 +- plugins/products-bundler/mapping/Users.yaml | 2 +- 26 files changed, 48 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index be23693b3c..05ad09be21 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,14 @@ TBD: Add Redocly validation status badge. -## Links +## View API docs -- [Core API docs](https://api-reference.rebilly.com/) -- [Users API docs](https://user-api-docs.rebilly.com/) -- [Reports API docs](https://reports-api-docs.rebilly.com/) -- [Storefront API docs](https://storefront-api-docs.rebilly.com/) (this API is in development and subject to change) +To view the full Rebilly API reference documentation, go to [https://www.rebilly.com/catalog/all/](https://www.rebilly.com/catalog/all/). + +The full Rebilly API reference documentation has over 500 operations. This is likely more than you may need to implement your use cases. If you would like to implement a particular use case, [contact Rebilly](https://www.rebilly.com/support/) for guidance and feedback on the best API operations to use for the task. + +To integrate Rebilly, and learn about related resources and concepts, +see [Get started](https://www.rebilly.com/docs/dev-docs/get-started/). ## Contributing @@ -29,7 +31,7 @@ If you use VS Code, use the [Redocly VS Code extension](https://marketplace.visu #### Preview -This process describes how to start a development server docs preview for the Rebilly API docs. +This process describes how to start a development server docs preview for the Rebilly API docs. Changes made to the API specification while the development server is running are immediately displayed in the docs preview. Rebilly uses [Redocly](https://redocly.com/) to generate, manage, and preview API docs. @@ -42,7 +44,7 @@ Rebilly uses [Redocly](https://redocly.com/) to generate, manage, and preview AP 1. In the **Personal API keys** section, click **Add API key**. 1. Enter an API key name, then click **Save**. 1. Copy the API key. -1. In a terminal, execute the following command: `npx @redocly/cli login`. +1. In a terminal, execute the following command: `npx @redocly/cli login`. 1. When prompted, paste your API key. 1. Execute one of the following commands to start a development server docs preview: - Core API docs: `npx @redocly/cli preview-docs core@latest` diff --git a/openapi/components/parameters/collectionExpand.yaml b/openapi/components/parameters/collectionExpand.yaml index 9e6a051c59..037656b195 100644 --- a/openapi/components/parameters/collectionExpand.yaml +++ b/openapi/components/parameters/collectionExpand.yaml @@ -5,6 +5,6 @@ description: |- property of the response. This field accepts a comma-separated list of objects. For more information, see - [Expand to include embedded objects](https://all-rebilly.redoc.ly/#section/Expand-to-include-embedded-objects). + [Expand to include embedded objects](https://www.rebilly.com/catalog/all/#section/Expand-to-include-embedded-objects). schema: type: string diff --git a/openapi/components/parameters/collectionFilter.yaml b/openapi/components/parameters/collectionFilter.yaml index d07c848032..4303f13d6c 100644 --- a/openapi/components/parameters/collectionFilter.yaml +++ b/openapi/components/parameters/collectionFilter.yaml @@ -5,6 +5,6 @@ description: |- a special format. Use `,` for multiple allowed values. Use `;` for multiple fields. For more information, see - [Using filter with collections](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections). + [Using filter with collections](https://www.rebilly.com/catalog/all/#section/Using-filter-with-collections). schema: type: string diff --git a/openapi/components/requestBodies/PostDepositRequest.yaml b/openapi/components/requestBodies/PostDepositRequest.yaml index 1ae5429eb2..78ac1cdfed 100644 --- a/openapi/components/requestBodies/PostDepositRequest.yaml +++ b/openapi/components/requestBodies/PostDepositRequest.yaml @@ -27,7 +27,7 @@ properties: multipleOf: 1 maximum: 10000 ``` - For more information, see [Create a deposit strategy](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositStrategy). + For more information, see [Create a deposit strategy](https://www.rebilly.com/catalog/all/Deposits/PostDepositStrategy). type: - 'string' - 'null' @@ -43,7 +43,7 @@ properties: List of available deposit amounts. If `amounts` is not specified when a deposit request is created, amounts are determined from the chosen strategy. - For more information, see the [`strategyId` property](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositRequest#!path=strategyId&t=request). + For more information, see the [`strategyId` property](https://www.rebilly.com/catalog/all/tag/Deposits/#operation/PostDepositRequest#!path=strategyId&t=request). items: type: number format: double @@ -80,7 +80,7 @@ properties: Custom amount restrictions. If this value is `null`, custom amounts are prohibited. If `customAmount` is not specified when a deposit request is created, amount restrictions are determined from the chosen strategy. - For more information, see the [`strategyId` property](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositRequest#!path=strategyId&t=request). + For more information, see the [`strategyId` property](https://www.rebilly.com/catalog/all/tag/Deposits/#operation/PostDepositRequest#!path=strategyId&t=request). required: - minimum - multipleOf diff --git a/openapi/components/schemas/ApplicationInstance.yaml b/openapi/components/schemas/ApplicationInstance.yaml index ed2e23a88e..173f4ada37 100644 --- a/openapi/components/schemas/ApplicationInstance.yaml +++ b/openapi/components/schemas/ApplicationInstance.yaml @@ -13,7 +13,7 @@ properties: isConfigured: description: |- Determines if the configuration of the application instance is complete. - Configuration is completed using the [PutApplicationInstanceConfiguration](https://all-rebilly.redoc.ly/tag/Application-users/operation/PutApplicationInstanceConfiguration) operation. + Configuration is completed using the [Upsert an application instance configuration](https://www.rebilly.com/catalog/all/Application-users/PutApplicationInstanceConfiguration) operation. type: boolean readOnly: true settings: diff --git a/openapi/components/schemas/Bind.yaml b/openapi/components/schemas/Bind.yaml index 8c93c276e2..b8383299eb 100644 --- a/openapi/components/schemas/Bind.yaml +++ b/openapi/components/schemas/Bind.yaml @@ -30,7 +30,7 @@ properties: This field requires a special format. Use `,` for multiple allowed values. Use `;` for multiple fields. - For more information, see [Using filter with collections](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections). + For more information, see [Using filter with collections](https://www.rebilly.com/catalog/all/#section/Using-filter-with-collections). type: string actions: description: Actions that execute when an event occurs. diff --git a/openapi/components/schemas/DepositRequest.yaml b/openapi/components/schemas/DepositRequest.yaml index 7c6033e09c..96890f52c7 100644 --- a/openapi/components/schemas/DepositRequest.yaml +++ b/openapi/components/schemas/DepositRequest.yaml @@ -47,7 +47,7 @@ properties: List of available deposit amounts. If `amounts` is not specified when a deposit is created, amounts are determined from the chosen strategy. - For more information, see the [`strategyId` property](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositRequest#!path=strategyId&t=request). + For more information, see the [`strategyId` property](https://www.rebilly.com/catalog/all/Deposits/PostDepositRequest/#!t=request&path=strategyId). items: type: number format: double @@ -60,7 +60,7 @@ properties: Custom amount restrictions. If this value is `null`, custom amounts are prohibited. If `customAmount` is not specified when a deposit request is created, amount restrictions are determined from the chosen strategy. - For more information, see the [`strategyId` property](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositRequest#!path=strategyId&t=request). + For more information, see the [`strategyId` property](https://www.rebilly.com/catalog/all/Deposits/PostDepositRequest/#!t=request&path=strategyId). required: - minimum - multipleOf diff --git a/openapi/components/schemas/DepositStrategy.yaml b/openapi/components/schemas/DepositStrategy.yaml index a7e1dd8758..3083f5f90d 100644 --- a/openapi/components/schemas/DepositStrategy.yaml +++ b/openapi/components/schemas/DepositStrategy.yaml @@ -53,7 +53,7 @@ properties: description: |- List of incremental amounts that are displayed to customer. - For more information, see the [`calculator` property](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositStrategy#!path=amounts/calculator&t=request). + For more information, see the [`calculator` property](https://www.rebilly.com/catalog/all/Deposits/PostDepositStrategy#!t=request&path=amounts/calculator. items: type: number format: double @@ -63,7 +63,7 @@ properties: default: false description: |- Specifies if the base amount must be adjusted based on the last deposit. - If this value is `true`, the `baseAmount` is changed to the last successful deposit amount made using [Create a deposit request](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositRequest). + If this value is `true`, the `baseAmount` is changed to the last successful deposit amount made using [Create a deposit request](https://www.rebilly.com/catalog/all/Deposits/PostDepositRequest). If the customer has no successful deposits, `baseAmount` is not adjusted. customAmount: @@ -74,7 +74,7 @@ properties: Custom amount restrictions. If this value is `null`, custom amounts are prohibited. If `customAmount` is not specified when a deposit request is created, amount restrictions are determined from the chosen strategy. - For more information, see the [`strategyId` property](https://all-rebilly.redoc.ly/tag/Deposits/#operation/PostDepositRequest#!path=strategyId&t=request). + For more information, see the [`strategyId` property](https://www.rebilly.com/catalog/all/tag/Deposits/#operation/PostDepositRequest#!path=strategyId&t=request). required: - minimum - multipleOf diff --git a/openapi/components/schemas/FlexiblePlan.yaml b/openapi/components/schemas/FlexiblePlan.yaml index 6f8d1331e3..7233801601 100644 --- a/openapi/components/schemas/FlexiblePlan.yaml +++ b/openapi/components/schemas/FlexiblePlan.yaml @@ -3,7 +3,7 @@ allOf: description: |- Customize an existing plan for the current order. - To create a new plan, see [Create a plan](https://all-rebilly.redoc.ly/tag/Plans/operation/PostPlan). + To create a new plan, see [Create a plan](https://www.rebilly.com/catalog/all/tag/Plans/PostPlan). required: - id properties: diff --git a/openapi/components/schemas/GatewayAccount.yaml b/openapi/components/schemas/GatewayAccount.yaml index e5cefa978b..acc40c6ce7 100755 --- a/openapi/components/schemas/GatewayAccount.yaml +++ b/openapi/components/schemas/GatewayAccount.yaml @@ -321,7 +321,7 @@ properties: If a transaction exceeds this value, the gateway account is not used. For more information see, - [Using filters](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections). + [Using filters](https://www.rebilly.com/catalog/all/#section/Using-filter-with-collections). type: - 'string' - 'null' @@ -376,8 +376,7 @@ properties: readyToPayoutInstruction: type: string default: none - description: |- - Defines the mode of gateway payout behaviour for the [Ready to payout](https://all-rebilly.redoc.ly/tag/Purchases/operation/StorefrontPostReadyToPayout) operation. + description: Defines the mode of gateway payout behaviour for the [Ready to payout](https://www.rebilly.com/catalog/all/Purchases/StorefrontPostReadyToPayout) operation. enum: - all - covered-payout diff --git a/openapi/components/schemas/GlobalWebhook.yaml b/openapi/components/schemas/GlobalWebhook.yaml index aca76649b8..7b55fe5ce3 100644 --- a/openapi/components/schemas/GlobalWebhook.yaml +++ b/openapi/components/schemas/GlobalWebhook.yaml @@ -87,7 +87,7 @@ properties: Use `;` for multiple fields. For more information, - see [Using filters](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections). + see [Using filters](https://www.rebilly.com/catalog/all/#section/Using-filter-with-collections). type: - 'string' - 'null' diff --git a/openapi/components/schemas/OneTimeOrder.yaml b/openapi/components/schemas/OneTimeOrder.yaml index d124e8b709..45cb36e0bb 100644 --- a/openapi/components/schemas/OneTimeOrder.yaml +++ b/openapi/components/schemas/OneTimeOrder.yaml @@ -118,7 +118,7 @@ properties: description: |- Date and time when the pending order is automatically abandoned. If this value is not passed during order creation, - a [pending order TTL](https://all-rebilly.redoc.ly/tag/Organizations/operation/PatchOrganization/#!path=settings/billing/pendingOrderTtl&t=request) setting is used to calculate the value. + a [pending order TTL](https://www.rebilly.com/catalog/all/Organizations/PatchOrganization/#!t=request&path=settings/billing/pendingOrderTtl) setting is used to calculate the value. format: date-time couponIds: type: diff --git a/openapi/components/schemas/OriginalPlan.yaml b/openapi/components/schemas/OriginalPlan.yaml index 6e2498a808..51924a6679 100644 --- a/openapi/components/schemas/OriginalPlan.yaml +++ b/openapi/components/schemas/OriginalPlan.yaml @@ -2,7 +2,7 @@ type: object description: |- Use an existing plan without changes for the current order. - To create a new plan, see [Create a plan](https://all-rebilly.redoc.ly/tag/Plans/operation/PostPlan). + To create a new plan, see [Create a plan](https://www.rebilly.com/catalog/all/Plans/PostPlan). required: - id properties: diff --git a/openapi/components/schemas/ReadyToPayMethodFilters.yaml b/openapi/components/schemas/ReadyToPayMethodFilters.yaml index e86bdd9956..5609a8d0ab 100644 --- a/openapi/components/schemas/ReadyToPayMethodFilters.yaml +++ b/openapi/components/schemas/ReadyToPayMethodFilters.yaml @@ -2,6 +2,6 @@ type: array description: |- For the method to be applicable, one or more of the following filters must match. If no filters are sent, no restrictions are applied. - For more information, see [Using filters](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections). + For more information, see [Using filters](https://www.rebilly.com/catalog/all/#section/Using-filter-with-collections). items: type: string diff --git a/openapi/components/schemas/RebillyShipping.yaml b/openapi/components/schemas/RebillyShipping.yaml index 16704e026f..b4deb5a8f6 100644 --- a/openapi/components/schemas/RebillyShipping.yaml +++ b/openapi/components/schemas/RebillyShipping.yaml @@ -19,4 +19,4 @@ properties: type: number format: double readOnly: true - description: Shipping amount which is calculated from [Shipping rates](https://all-rebilly.redoc.ly/tag/Shipping-rates). + description: Shipping amount which is calculated from [Shipping rates](https://www.rebilly.com/catalog/all/Shipping-rates). diff --git a/openapi/components/schemas/ResourceCustomFields.yaml b/openapi/components/schemas/ResourceCustomFields.yaml index 59e561aca8..67588f0eec 100644 --- a/openapi/components/schemas/ResourceCustomFields.yaml +++ b/openapi/components/schemas/ResourceCustomFields.yaml @@ -1,6 +1,6 @@ description: |- Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. - For more information, see [Custom fields](https://all-rebilly.redoc.ly/tag/Custom-fields). + For more information, see [Custom fields](https://www.rebilly.com/catalog/all/Custom-fields). type: object default: {} example: {"foo": "bar"} diff --git a/openapi/components/schemas/StorefrontOneTimeOrder.yaml b/openapi/components/schemas/StorefrontOneTimeOrder.yaml index 68a57fa7cb..3690849d28 100644 --- a/openapi/components/schemas/StorefrontOneTimeOrder.yaml +++ b/openapi/components/schemas/StorefrontOneTimeOrder.yaml @@ -86,7 +86,7 @@ properties: description: |- Date and time when the pending order is automatically abandoned. If this value is not passed during order creation, - a [pending order TTL](https://all-rebilly.redoc.ly/tag/Organizations/operation/PatchOrganization/#!path=settings/billing/pendingOrderTtl&t=request) setting is used to calculate the value. + a [pending order TTL](https://www.rebilly.com/catalog/all/Organizations/PatchOrganization/#!t=request&path=settings/billing/pendingOrderTtl) setting is used to calculate the value. format: date-time couponIds: type: diff --git a/openapi/components/schemas/StorefrontSubscriptionOrder.yaml b/openapi/components/schemas/StorefrontSubscriptionOrder.yaml index f2ed66baf5..b864fb77e5 100644 --- a/openapi/components/schemas/StorefrontSubscriptionOrder.yaml +++ b/openapi/components/schemas/StorefrontSubscriptionOrder.yaml @@ -86,7 +86,7 @@ properties: description: |- Date and time when the pending order is automatically abandoned. If this value is not passed during order creation, - a [pending order TTL](https://all-rebilly.redoc.ly/tag/Organizations/operation/PatchOrganization/#!path=settings/billing/pendingOrderTtl&t=request) setting is used to calculate the value. + a [pending order TTL](https://www.rebilly.com/catalog/all/Organizations/PatchOrganization/#!t=request&path=settings/billing/pendingOrderTtl) setting is used to calculate the value. format: date-time couponIds: type: diff --git a/openapi/components/schemas/SubscriptionOrder.yaml b/openapi/components/schemas/SubscriptionOrder.yaml index fedfb22974..f5697571ed 100644 --- a/openapi/components/schemas/SubscriptionOrder.yaml +++ b/openapi/components/schemas/SubscriptionOrder.yaml @@ -331,7 +331,7 @@ properties: description: |- Date and time when the pending order is automatically abandoned. If this value is not passed during order creation, - a [pending order TTL](https://all-rebilly.redoc.ly/tag/Organizations/operation/PatchOrganization/#!path=settings/billing/pendingOrderTtl&t=request) setting is used to calculate the value. + a [pending order TTL](https://www.rebilly.com/catalog/all/Organizations/PatchOrganization/#!t=request&path=settings/billing/pendingOrderTtl) setting is used to calculate the value. format: date-time couponIds: type: diff --git a/openapi/components/schemas/VaultedInstrument.yaml b/openapi/components/schemas/VaultedInstrument.yaml index 0fe5dac5ab..2033751e18 100644 --- a/openapi/components/schemas/VaultedInstrument.yaml +++ b/openapi/components/schemas/VaultedInstrument.yaml @@ -7,7 +7,7 @@ properties: method: description: |- Payment method supported vault. - For more information, see [Payment instrument](https://all-rebilly.redoc.ly/tag/Payment-instruments). + For more information, see [Payment instrument](https://www.rebilly.com/catalog/all/Payment-instruments). type: string enum: - payment-card diff --git a/openapi/description.md b/openapi/description.md index 2602799e3a..97ac9bb52f 100644 --- a/openapi/description.md +++ b/openapi/description.md @@ -27,7 +27,7 @@ Rebilly offers four forms of authentication: secret key, publishable key, JSON W To create or manage API keys, select one of the following: - Use the Rebilly UI: see [Manage API keys](https://www.rebilly.com/docs/dev-docs/api-keys/#manage-api-keys) -- Use the Rebilly API: see the [API key operations](https://all-rebilly.redoc.ly/tag/API-keys). +- Use the Rebilly API: see the [API key operations](https://www.rebilly.com/catalog/all/API-keys). For more information on API keys, see [API keys](https://www.rebilly.com/docs/concepts-and-features/concept/api-keys). @@ -42,7 +42,7 @@ However, no SDK is required to use the API. Rebilly also provides [FramePay](https://www.rebilly.com/docs/developer-docs/framepay/), a client-side iFrame-based solution, to help create payment tokens while minimizing PCI DSS compliance burdens and maximizing your customization ability. -[FramePay](https://www.rebilly.com/docs/developer-docs/framepay/) interacts with the [payment tokens creation operation](https://all-rebilly.redoc.ly/tag/Payment-tokens/operation/PostToken). +[FramePay](https://www.rebilly.com/docs/developer-docs/framepay/) interacts with the [payment tokens creation operation](https://www.rebilly.com/catalog/all/Payment-tokens/PostToken). ## JavaScript SDK @@ -87,11 +87,11 @@ Format description: - To use a gte (greater than or equals) filter, use: `?filter=amount:1..`. This also works for datetime-based fields. - + - To use a lte (less than or equals) filter, use: `?filter=amount:..10`. This also works for datetime-based fields. -- To create [specified values lists](https://all-rebilly.redoc.ly/#tag/Lists) and use them in filters, use: `?filter=firstName:@yourListName`. \ +- To create [specified values lists](https://www.rebilly.com/catalog/all/Lists) and use them in filters, use: `?filter=firstName:@yourListName`. \ You can also exclude list values: `?filter=firstName:!@yourListName`. \ Use value lists to compare against a list of data when setting conditions for rules or binds, or applying filters to data table segments. @@ -127,13 +127,13 @@ Expand may be used on `GET`, `PATCH`, `POST`, `PUT` requests. # Limit on collections offset For performance reasons, take note that we have a `1000` limit on `?offset=...`. -For example, attempting to retrieve a collection using `?offset=1001` or `?offset=2000` returns the same results as if you used `?offset=1000`. +For example, attempting to retrieve a collection using `?offset=1001` or `?offset=2000` returns the same results as if you used `?offset=1000`. -Visit our [Data Exports API](https://all-rebilly.redoc.ly/tag/Data-exports) for an asynchronous solution. +Visit our [Data Exports API](https://www.rebilly.com/catalog/all/Data-exports) for an asynchronous solution. # Get started -The full [Rebilly API](https://all-rebilly.redoc.ly/) has over 500 operations. +The full [Rebilly API](https://www.rebilly.com/catalog/all/) has over 500 operations. This is likely more than you may need to implement your use cases. If you would like to implement a particular use case, [contact Rebilly](https://www.rebilly.com/support/) for guidance and feedback on the best API operations to use for the task. diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml index 92ad11c28f..4450428e4a 100644 --- a/openapi/openapi.yaml +++ b/openapi/openapi.yaml @@ -53,7 +53,7 @@ components: ApplicationJWT: description: |- Applications in the Rebilly App Store can create a JSON Web Token (JWT) by fetching an user's instance. - For more information, see [Retrieve an application instance](https://all-rebilly.redoc.ly/tag/Application-owners#operation/GetApplicationInstanceByOrganization). + For more information, see [Retrieve an application instance](https://www.rebilly.com/catalog/all/Application-owners/GetApplicationInstanceByOrganization/). Usage format: `Bearer `. type: http @@ -64,7 +64,7 @@ components: description: |- This authentication method is applicable to specific operations. - To create a publishable API key, see [Create an API key](https://all-rebilly.redoc.ly/tag/API-keys/operation/PostApiKey). + To create a publishable API key, see [Create an API key](https://www.rebilly.com/catalog/all/API-keys/PostApiKey). name: Authorization type: apiKey in: header @@ -83,7 +83,7 @@ components: CustomerJWT: description: |- To create a JSON Web Token (JWT) using Storefront authentication, - see [Create a session with username and password](https://all-rebilly.redoc.ly/tag/Authentication/operation/StorefrontPostLogin). + see [Create a session with username and password](https://www.rebilly.com/catalog/all/tag/Authentication/operation/StorefrontPostLogin). Usage format: `Bearer `. type: http diff --git a/openapi/paths/ready-to-pay.yaml b/openapi/paths/ready-to-pay.yaml index 438987ad08..572914d088 100644 --- a/openapi/paths/ready-to-pay.yaml +++ b/openapi/paths/ready-to-pay.yaml @@ -17,7 +17,7 @@ post: To invert this behavior, place an all matching rule at the end of the `ready-to-pay-requested` event in the rules engine, and include an empty `paymentMethods` property for the `adjust-ready-to-pay` action. - For more information, see [Update event rules](https://all-rebilly.redoc.ly/tag/Rules#operation/PutEventRule) and [Gateway accounts](https://all-rebilly.redoc.ly/tag/Gateway-accounts). + For more information, see [Update event rules](https://www.rebilly.com/catalog/all/Rules#operation/PutEventRule) and [Gateway accounts](https://www.rebilly.com/catalog/all/Gateway-accounts). requestBody: content: application/json: diff --git a/openapi/paths/reports@revenue-audit.yaml b/openapi/paths/reports@revenue-audit.yaml index 3940ca6e94..5b57232928 100644 --- a/openapi/paths/reports@revenue-audit.yaml +++ b/openapi/paths/reports@revenue-audit.yaml @@ -31,7 +31,7 @@ get: A revenue audit report is a combination of a granular [revenue waterfall](https://www.rebilly.com/docs/data-tables/revenue-recognition/#revenue-waterfall) and a journal report, which describes revenue per account. - Use [`filter`](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections) `limit` and `offset` parameters to restrict the output. + Use [`filter`](https://www.rebilly.com/catalog/all/#section/Using-filter-with-collections) `limit` and `offset` parameters to restrict the output. security: - SecretApiKey: [] - JWT: [] diff --git a/openapi/paths/storefront/ready-to-pay.yaml b/openapi/paths/storefront/ready-to-pay.yaml index aab160be86..b4323b1fad 100644 --- a/openapi/paths/storefront/ready-to-pay.yaml +++ b/openapi/paths/storefront/ready-to-pay.yaml @@ -19,7 +19,7 @@ post: To invert this behavior, place an all matching rule at the end of the `ready-to-pay-requested` event in the rules engine, and include an empty `paymentMethods` property for the `adjust-ready-to-pay` action. - For more information, see [Update event rules](https://all-rebilly.redoc.ly/tag/Rules#operation/PutEventRule) and [Gateway accounts](https://all-rebilly.redoc.ly/tag/Gateway-accounts). + For more information, see [Update event rules](https://www.rebilly.com/catalog/all/Rules/PutEventRule) and [Gateway accounts](https://www.rebilly.com/catalog/all/Gateway-accounts). If this operation to pay is used with a transaction-scoped JSON Web Token (JWT), all fields are ignored except `riskMetadata`. requestBody: diff --git a/plugins/products-bundler/mapping/Users.yaml b/plugins/products-bundler/mapping/Users.yaml index e1acf5cca7..6d4a2031e4 100644 --- a/plugins/products-bundler/mapping/Users.yaml +++ b/plugins/products-bundler/mapping/Users.yaml @@ -31,7 +31,7 @@ info: To create or manage API keys, select one of the following: - Use the Rebilly UI: see [Manage API keys](https://www.rebilly.com/docs/dev-docs/api-keys/#manage-api-keys) - - Use the Rebilly API: see the [API key operations](https://all-rebilly.redoc.ly/tag/API-keys). + - Use the Rebilly API: see the [API key operations](https://www.rebilly.com/catalog/all/API-keys). For more information on API keys, see [API keys](https://www.rebilly.com/docs/concepts-and-features/concept/api-keys).