Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Storefront tags #1738

Merged
merged 16 commits into from
Jan 15, 2024
Merged
2 changes: 1 addition & 1 deletion openapi/components/schemas/GatewayAccount.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ properties:
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.
Defines the mode of gateway payout behaviour for the [Ready to payout](https://all-rebilly.redoc.ly/tag/Storefront-purchases/operation/StorefrontPostReadyToPayout) operation.
enum:
- all
- covered-payout
Expand Down
80 changes: 63 additions & 17 deletions openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -83,18 +83,14 @@ 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://all-rebilly.redoc.ly/tag/Storefront-account/operation/StorefrontPostLogin).

Usage format: `Bearer <JWT>`.
type: http
scheme: bearer
bearerFormat: JWT

tags:
- name: Account
description: |-
Use these operations to manage Rebilly accounts.
An account in which you are subscribed to in order to use the Rebilly product.
- name: Allowlists
description: |-
Use allowlists to exclude specific customer attribute data from risk score checks.
Expand Down Expand Up @@ -126,8 +122,6 @@ tags:
Use these operations to install or uninstall apps from the Rebilly App Store to your Rebilly account, and to manage application instances.
An application user is a person or organization that uses an app that is installed from the Rebilly App Store.
For more information, see [Install or uninstall an app](https://www.rebilly.com/docs/dev-docs/install-an-app/).
- name: Authentication
description: Use these operations to manage the process of confirming the identity of users that are attempting to access resources.
- name: Balance transactions
description: |-
Use these operations to view and manage balance transactions.
Expand Down Expand Up @@ -286,10 +280,6 @@ tags:

Email notifications can also be used to notify teammates about new customers, blocklist matches, risk score changes, and more.
For more information, see [Email notifications](https://www.rebilly.com/docs/automations/email-notifications/).
- name: Email verification
description: |-
Use these operations to manage email verification.
Email verification is the process of confirming that an email address exists and is associated with an individual.
- name: External identifiers
description: |-
Use external identifier operations to associate entities such as customers,
Expand Down Expand Up @@ -415,8 +405,6 @@ tags:
For more information, see [My organizations and websites](https://www.rebilly.com/docs/settings/organizations-and-websites/).

Note: No data, including organizations, is shared between the live and sandbox environments.
- name: Password reset
description: Use these operations to manage password resets for a user or organization.
- name: Payment instruments
description: |-
Use these operations to manage payment instruments.
Expand Down Expand Up @@ -460,10 +448,6 @@ tags:
description: |-
Use these operations to manage user profiles.
A profile represents the person that is signed in to Rebilly.
- name: Purchases
description: |-
Use these operations to manage purchases.
Purchases are transactions that have been executed related to the purchase of goods or services.
- name: Quotes
description: |-
Use quote operations to create and manage quotations.
Expand Down Expand Up @@ -519,6 +503,68 @@ tags:
description: |-
Use this operation to check the status of the Rebilly API.
No authentication is required.
- name: Storefront account
description: |-
Use these operations to manage Storefront accounts.
An account in which you are subscribed to in order to use the Rebilly product.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront billing portals
description: |-
Use these operations to access Storefront billing portals.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront checkout forms
description: |-
Use these operations to access Storefront checkout forms.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront custom fields
description: |-
Use these operations to access Storefront custom fields.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront deposits
description: |-
Use these operations to access Storefront deposits.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront invoices
description: |-
Use these operations to access Storefront invoices.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront KYC documents
description: |-
Use these operations to access Storefront KYC documents.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront orders
description: |-
Use these operations to access Storefront orders.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront payment instruments
description: |-
Use these operations to access Storefront payment instruments.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront plans
description: |-
Use these operations to access Storefront plans.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront products
description: |-
Use these operations to access Storefront products.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront purchases
description: |-
Use these operations to manage Storefront purchases.
Purchases are transactions that have been executed related to the purchase of goods or services.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront quotes
description: |-
Use these operations to access Storefront quotes.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront transactions
description: |-
Use these operations to access Storefront transactions.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Storefront websites
description: |-
Use these operations to access Storefront websites.
APIs intended to be used directly from an untrusted browser.
ashkarpetin marked this conversation as resolved.
Show resolved Hide resolved
- name: Tags
description: Use tags to organize and categorize customers or KYC documents based on keywords.
- name: Tracking
Expand Down
5 changes: 2 additions & 3 deletions openapi/paths/storefront/account.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ get:
x-products:
- Storefront
tags:
- Account
- Storefront account
summary: Retrieve Account
operationId: StorefrontGetAccount
x-sdk-operation-name: get
Expand All @@ -26,7 +26,7 @@ patch:
x-products:
- Storefront
tags:
- Account
- Storefront account
summary: Update Account
operationId: StorefrontPatchAccount
x-sdk-operation-name: update
Expand All @@ -39,7 +39,6 @@ patch:
schema:
allOf:
- $ref: ../../components/schemas/StorefrontAccount.yaml

responses:
200:
description: Account updated.
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ post:
x-products:
- Storefront
tags:
- Password reset
- Storefront account
summary: Request a password reset
operationId: StorefrontPostForgotPassword
x-sdk-operation-name: requestPasswordReset
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ patch:
x-products:
- Storefront
tags:
- Account
- Storefront account
summary: Change an account password
operationId: StorefrontPatchAccountPassword
x-sdk-operation-name: changePassword
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ post:
x-products:
- Storefront
tags:
- Email verification
- Storefront account
summary: Resend email verification
operationId: StorefrontPostAccountResendVerification
x-sdk-operation-name: resendEmailVerification
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
x-products:
- Storefront
tags:
- Password reset
- Storefront account
summary: Finish password reset
operationId: StorefrontPostResetPassword
x-sdk-operation-name: confirmPasswordReset
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/account@verification@{token}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
x-products:
- Storefront
tags:
- Email verification
- Storefront account
summary: Verify an account email
operationId: StorefrontPostAccountVerification
x-sdk-operation-name: verifyEmail
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/billing-portals@{slug}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ get:
x-products:
- Storefront
tags:
- Billing portals
- Storefront billing portals
summary: Retrieve a billing portal
operationId: StorefrontGetBillingPortal
x-sdk-operation-name: get
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/checkout-forms@{id}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ get:
x-products:
- Storefront
tags:
- Checkout forms
- Storefront checkout forms
summary: Retrieve a checkout form
operationId: StorefrontGetCheckoutForm
x-sdk-operation-name: get
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/custom-fields@{resource}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ get:
x-products:
- Storefront
tags:
- Custom fields
- Storefront custom fields
summary: Retrieve custom fields
operationId: StorefrontGetCustomFieldCollection
x-sdk-operation-name: getAll
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/deposit-requests@{id}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ get:
- Storefront
x-badge: Experimental
tags:
- Deposits
- Storefront deposits
summary: Retrieve a deposit request
operationId: StorefrontGetDepositRequest
x-sdk-operation-name: get
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/deposit-strategies@{id}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ get:
- Storefront
x-badge: Experimental
tags:
- Deposits
- Storefront deposits
summary: Retrieve a deposit strategy
operationId: StorefrontGetDepositStrategy
x-sdk-operation-name: get
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/deposit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ post:
- Storefront
x-badge: Experimental
tags:
- Deposits
- Storefront deposits
summary: Create a deposit
operationId: StorefrontPostDeposit
x-sdk-operation-name: create
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/invoices.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ get:
x-products:
- Storefront
tags:
- Invoices
- Storefront invoices
summary: Retrieve invoices
operationId: StorefrontGetInvoiceCollection
x-sdk-operation-name: getAll
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/invoices@{id}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ get:
x-products:
- Storefront
tags:
- Invoices
- Storefront invoices
summary: Retrieve a Invoice
operationId: StorefrontGetInvoice
x-sdk-operation-name: get
Expand Down
4 changes: 2 additions & 2 deletions openapi/paths/storefront/kyc-documents.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ get:
x-products:
- Storefront
tags:
- KYC documents
- Storefront KYC documents
summary: Retrieve KYC documents
operationId: StorefrontGetKycDocumentCollection
x-sdk-operation-name: getAll
Expand Down Expand Up @@ -36,7 +36,7 @@ post:
x-products:
- Storefront
tags:
- KYC documents
- Storefront KYC documents
summary: Create a KYC document
operationId: StorefrontPostKycDocument
x-sdk-operation-name: create
Expand Down
4 changes: 2 additions & 2 deletions openapi/paths/storefront/kyc-documents@{id}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ get:
x-products:
- Storefront
tags:
- KYC documents
- Storefront KYC documents
summary: Retrieve a KYC Document
operationId: StorefrontGetKycDocument
x-sdk-operation-name: get
Expand All @@ -28,7 +28,7 @@ patch:
x-products:
- Storefront
tags:
- KYC documents
- Storefront KYC documents
summary: Update a KYC document
operationId: StorefrontPatchKycDocument
x-sdk-operation-name: update
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/kyc-liveness-sessions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ post:
x-products:
- Storefront
tags:
- KYC documents
- Storefront KYC documents
summary: Create a KYC liveness session
operationId: StorefrontPostKycLivenessSession
x-sdk-operation-name: create
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/kyc-liveness-sessions@{id}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ get:
x-products:
- Storefront
tags:
- KYC documents
- Storefront KYC documents
summary: Retrieve a KYC liveness session
operationId: StorefrontGetKycLivenessSession
x-sdk-operation-name: get
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
x-products:
- Storefront
tags:
- KYC documents
- Storefront KYC documents
summary: Finish KYC liveness session
operationId: StorefrontPostKycLivenessSessionFinish
x-sdk-operation-name: finish
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/kyc-requests@{id}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ get:
x-products:
- Storefront
tags:
- KYC documents
- Storefront KYC documents
summary: Retrieve a KYC request
operationId: StorefrontGetKycRequest
x-sdk-operation-name: get
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/login.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ post:
x-products:
- Storefront
tags:
- Authentication
- Storefront account
summary: Create a session with username and password
operationId: StorefrontPostLogin
x-sdk-operation-name: login
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/logout.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ post:
x-products:
- Storefront
tags:
- Authentication
- Storefront account
summary: Destroys the user's current session
operationId: StorefrontPostLogout
x-sdk-operation-name: logout
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/storefront/orders.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ get:
x-products:
- Storefront
tags:
- Orders
- Storefront orders
summary: Retrieve orders
operationId: StorefrontGetOrderCollection
x-sdk-operation-name: getAll
Expand Down
4 changes: 2 additions & 2 deletions openapi/paths/storefront/orders@{id}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ get:
x-products:
- Storefront
tags:
- Orders
- Storefront orders
summary: Retrieve an order
operationId: StorefrontGetOrder
x-sdk-operation-name: get
Expand All @@ -28,7 +28,7 @@ patch:
x-products:
- Storefront
tags:
- Orders
- Storefront orders
summary: Update an order
operationId: StorefrontPatchOrder
x-sdk-operation-name: update
Expand Down
Loading