Rename Storefront tags (#1738)

* Update Storefront products tags * Add description * Rename more tags * Rename more tags * Fix errors * Fix tags * Fix tags * Fix links * Update openapi/openapi.yaml * Apply suggestions from code review Co-authored-by: Chris <[email protected]> * Fix descriptions * Fix paths --------- Co-authored-by: Chris <[email protected]>
Rebilly · Jan 15, 2024 · e8eaf9a · e8eaf9a
1 parent 8f401ed
commit e8eaf9a
Show file tree

Hide file tree

Showing 52 changed files with 217 additions and 77 deletions.
diff --git a/openapi/components/schemas/GatewayAccount.yaml b/openapi/components/schemas/GatewayAccount.yaml
@@ -376,7 +376,7 @@ properties:
   readyToPayoutInstruction:
     type: string
     default: none
-    description: Defines the mode of gateway payout behaviour for the [Ready to payout](https://www.rebilly.com/catalog/all/Purchases/StorefrontPostReadyToPayout) operation.
+    description: Defines the mode of gateway payout behaviour for the [Ready to payout](https://www.rebilly.com/catalog/all/Storefront-purchases/StorefrontPostReadyToPayout) operation.
     enum:
       - all
       - covered-payout

diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -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://www.rebilly.com/catalog/all/Authentication/StorefrontPostLogin).
+        see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/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.
@@ -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.
@@ -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,
@@ -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.
@@ -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.
@@ -519,6 +503,163 @@ 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.
+      A Storefront account is an account that the customer is subscribed to in order to use the Rebilly product.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations,
+      the customer must be issued a JWT with limited permissions.
+      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - name: Storefront billing portals
+    description: |-
+      Use these operations to access Storefront billing portals.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations,
+      the customer must be issued a JWT with limited permissions.
+      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - name: Storefront checkout forms
+    description: |-
+      Use these operations to access Storefront checkout forms.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations,
+      the customer must be issued a JWT with limited permissions.
+      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - name: Storefront custom fields
+    description: |-
+      Use these operations to access Storefront custom fields.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations,
+      the customer must be issued a JWT with limited permissions.
+      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - name: Storefront deposits
+    description: |-
+      Use these operations to access Storefront deposits.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - name: Storefront invoices
+    description: |-
+      Use these operations to access Storefront invoices.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - name: Storefront KYC documents
+    description: |-
+      Use these operations to access Storefront KYC documents.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - name: Storefront orders
+    description: |-
+      Use these operations to access Storefront orders.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - name: Storefront payment instruments
+    description: |-
+      Use these operations to access Storefront payment instruments.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - name: Storefront plans
+    description: |-
+      Use these operations to access Storefront plans.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations,
+      the customer must be issued a JWT with limited permissions.
+      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - name: Storefront products
+    description: |-
+      Use these operations to access Storefront products.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations,
+      the customer must be issued a JWT with limited permissions.
+      For more information,
+      see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - 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.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations,
+      the customer must be issued a JWT with limited permissions.
+      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - name: Storefront quotes
+    description: |-
+      Use these operations to access Storefront quotes.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - name: Storefront transactions
+    description: |-
+      Use these operations to access Storefront transactions.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations,
+      the customer must be issued a JWT with limited permissions.
+      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
+  - name: Storefront websites
+    description: |-
+      Use these operations to access Storefront websites.
+
+      Storefront operations interact directly with the customer,
+      and provide the customer with access to their own data.
+
+      To use Storefront operations,
+      the customer must be issued a JWT with limited permissions.
+      For more information, see [Create a session with username and password](https://www.rebilly.com/catalog/all/Storefront-account/StorefrontPostLogin) and [Exchange an authentication token](https://www.rebilly.com/catalog/all/Customer-authentication/PostAuthenticationTokenExchange).
+      Storefront operations are intended to be used directly from an untrusted browser.
   - name: Tags
     description: Use tags to organize and categorize customers or KYC documents based on keywords.
   - name: Tracking

diff --git a/openapi/paths/storefront/account.yaml b/openapi/paths/storefront/account.yaml
@@ -2,7 +2,7 @@ get:
   x-products:
     - Storefront
   tags:
-    - Account
+    - Storefront account
   summary: Retrieve Account
   operationId: StorefrontGetAccount
   x-sdk-operation-name: get
@@ -26,7 +26,7 @@ patch:
   x-products:
     - Storefront
   tags:
-    - Account
+    - Storefront account
   summary: Update Account
   operationId: StorefrontPatchAccount
   x-sdk-operation-name: update
@@ -39,7 +39,6 @@ patch:
         schema:
           allOf:
             - $ref: ../../components/schemas/StorefrontAccount.yaml
-
   responses:
     200:
       description: Account updated.

diff --git a/openapi/paths/storefront/[email protected] b/openapi/paths/storefront/[email protected]
@@ -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

diff --git a/openapi/paths/storefront/[email protected] b/openapi/paths/storefront/[email protected]
@@ -2,7 +2,7 @@ patch:
   x-products:
     - Storefront
   tags:
-    - Account
+    - Storefront account
   summary: Change an account password
   operationId: StorefrontPatchAccountPassword
   x-sdk-operation-name: changePassword

diff --git a/openapi/paths/storefront/[email protected] b/openapi/paths/storefront/[email protected]
@@ -2,7 +2,7 @@ post:
   x-products:
     - Storefront
   tags:
-    - Email verification
+    - Storefront account
   summary: Resend email verification
   operationId: StorefrontPostAccountResendVerification
   x-sdk-operation-name: resendEmailVerification

diff --git a/openapi/paths/storefront/account@reset-password@{token}.yaml b/openapi/paths/storefront/account@reset-password@{token}.yaml
@@ -4,7 +4,7 @@ post:
   x-products:
     - Storefront
   tags:
-    - Password reset
+    - Storefront account
   summary: Finish password reset
   operationId: StorefrontPostResetPassword
   x-sdk-operation-name: confirmPasswordReset

diff --git a/openapi/paths/storefront/account@verification@{token}.yaml b/openapi/paths/storefront/account@verification@{token}.yaml
@@ -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

diff --git a/openapi/paths/storefront/billing-portals@{slug}.yaml b/openapi/paths/storefront/billing-portals@{slug}.yaml
@@ -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

diff --git a/openapi/paths/storefront/checkout-forms@{id}.yaml b/openapi/paths/storefront/checkout-forms@{id}.yaml
@@ -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

diff --git a/openapi/paths/storefront/custom-fields@{resource}.yaml b/openapi/paths/storefront/custom-fields@{resource}.yaml
@@ -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

diff --git a/openapi/paths/storefront/deposit-requests@{id}.yaml b/openapi/paths/storefront/deposit-requests@{id}.yaml
@@ -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

diff --git a/openapi/paths/storefront/deposit-strategies@{id}.yaml b/openapi/paths/storefront/deposit-strategies@{id}.yaml
@@ -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

diff --git a/openapi/paths/storefront/deposit.yaml b/openapi/paths/storefront/deposit.yaml
@@ -3,7 +3,7 @@ post:
     - Storefront
   x-badge: Experimental
   tags:
-    - Deposits
+    - Storefront deposits
   summary: Create a deposit
   operationId: StorefrontPostDeposit
   x-sdk-operation-name: create

diff --git a/openapi/paths/storefront/invoices.yaml b/openapi/paths/storefront/invoices.yaml
@@ -2,7 +2,7 @@ get:
   x-products:
     - Storefront
   tags:
-    - Invoices
+    - Storefront invoices
   summary: Retrieve invoices
   operationId: StorefrontGetInvoiceCollection
   x-sdk-operation-name: getAll

diff --git a/openapi/paths/storefront/invoices@{id}.yaml b/openapi/paths/storefront/invoices@{id}.yaml
@@ -4,7 +4,7 @@ get:
   x-products:
     - Storefront
   tags:
-    - Invoices
+    - Storefront invoices
   summary: Retrieve a Invoice
   operationId: StorefrontGetInvoice
   x-sdk-operation-name: get

diff --git a/openapi/paths/storefront/kyc-documents.yaml b/openapi/paths/storefront/kyc-documents.yaml
@@ -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
@@ -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