Skip to content

Commit

Permalink
Update references
Browse files Browse the repository at this point in the history
  • Loading branch information
noon-dawg committed Dec 20, 2023
1 parent 65472f7 commit cac3bf8
Show file tree
Hide file tree
Showing 26 changed files with 48 additions and 47 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand All @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/parameters/collectionExpand.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion openapi/components/parameters/collectionFilter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 3 additions & 3 deletions openapi/components/requestBodies/PostDepositRequest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/schemas/ApplicationInstance.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/schemas/Bind.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions openapi/components/schemas/DepositRequest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions openapi/components/schemas/DepositStrategy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/schemas/FlexiblePlan.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 2 additions & 3 deletions openapi/components/schemas/GatewayAccount.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/schemas/GlobalWebhook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/schemas/OneTimeOrder.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/schemas/OriginalPlan.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/schemas/ReadyToPayMethodFilters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion openapi/components/schemas/RebillyShipping.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion openapi/components/schemas/ResourceCustomFields.yaml
Original file line number Diff line number Diff line change
@@ -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"}
2 changes: 1 addition & 1 deletion openapi/components/schemas/StorefrontOneTimeOrder.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/schemas/SubscriptionOrder.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/schemas/VaultedInstrument.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions openapi/description.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 <JWT>`.
type: http
Expand All @@ -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
Expand All @@ -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 <JWT>`.
type: http
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/ready-to-pay.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading

0 comments on commit cac3bf8

Please sign in to comment.