@redotech/redo-api-schema 2.2.238 → 2.2.245

package/lib/openapi.d.ts

@@ -12,21 +12,21 @@ type OneOf<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A
 export interface paths {
   "/invoices/{invoiceId}/items.csv": {
     /**
-     * Get invoice
+     * Invoice (CSV)
      * @description Get an invoice as a CSV.
      */
     get: operations["Invoice csv get"];
   };
   "/invoices/pending/items.csv": {
     /**
-     * Get pending invoice
+     * Pending Invoice (CSV)
      * @description Get an invoice as a CSV.
      */
     get: operations["Invoice pending csv get"];
   };
   "/returns/{returnId}": {
     /**
-     * Get return
+     * Return
      * @description Get return.
      */
     get: operations["Return get"];
@@ -38,12 +38,12 @@ export interface paths {
   };
   "/returns/{returnId}/comments": {
     /**
-     * List return comments
+     * List Return Comments
      * @description List return comments.
      */
     get: operations["Return comments get"];
     /**
-     * Create return comment
+     * Create Return Comment
      * @description Create return comment.
      */
     post: operations["Return comment create"];
@@ -55,7 +55,7 @@ export interface paths {
   };
   "/returns/{returnId}/process": {
     /**
-     * Process return
+     * Process Return
      * @description **BETA**: This endpoint is in beta and subject to change.
      *
      * Trigger processing of a return with specified products.
@@ -69,68 +69,68 @@ export interface paths {
   };
   "/returns/{returnId}/status": {
     /**
-     * Get return status
+     * Return Status
      * @description Get return status.
      */
     get: operations["Return status get"];
     /**
-     * Update return status
+     * Update Return Status
      * @description Update return status.
      */
     put: operations["Return status update"];
   };
   "/stores/{storeId}/admin": {
     /**
-     * Navigate to merchant admin
+     * Navigate to Merchant Admin
      * @description Navigate to the merchant admin page.
      */
     get: operations["Merchant admin navigate"];
   };
   "/stores/{storeId}/checkout-buttons-ui": {
     /**
-     * Retrieve some rendered HTML and CSS for checkout buttons options for enabling and disabling coverage
-     * @description Generate HTML and CSS for checkout buttons
+     * Checkout Buttons UI
+     * @description Generate rendered HTML and CSS for checkout buttons.
      */
     get: operations["Checkout buttons UI"];
   };
   "/stores/{storeId}/coverage-info": {
     /**
-     * Navigate to coverage info
+     * Navigate to Coverage Info
      * @description Navigate to the coverage info page.
      */
     get: operations["Coverage info navigate"];
   };
   "/stores/{storeId}/coverage-products": {
     /**
-     * Get coverage products
+     * Coverage Products
      * @description Get available coverage products.
      */
     post: operations["Coverage products"];
   };
   "/stores/{storeId}/customer-portal": {
     /**
-     * Navigate to customer portal
+     * Navigate to Customer Portal
      * @description Navigate to the customer portal.
      */
     get: operations["Customer portal navigate"];
   };
   "/stores/{storeId}/customer-subscriptions": {
     /**
-     * Update customer subscriptions
+     * Update Customer Subscriptions
      * @description Update customer subscription status for SMS and email marketing and transactional messages. If the customer with that phone number or email does not exist, it will be created.
      */
     post: operations["Customer subscriptions update"];
   };
   "/stores/{storeId}/invoices": {
     /**
-     * Get invoice
+     * List Invoices
      * @description Get a list of invoices.
      */
     get: operations["Invoice list"];
   };
   "/stores/{storeId}/returns": {
     /**
-     * List returns
+     * List Returns
      * @description List returns, sorted by most recent to least recent.
      */
     get: operations["Returns list"];
@@ -142,7 +142,7 @@ export interface paths {
   };
   "/stores/{storeId}/shipments/{shipmentId}/documents/{documentType}": {
     /**
-     * Download shipment document
+     * Download Shipment Document
      * @description Get a shipment document (label, commercial invoice, etc).
      */
     get: operations["Shipment document download"];
@@ -154,7 +154,7 @@ export interface paths {
   };
   "/stores/{storeId}/shipments/buy": {
     /**
-     * Purchase shipping label
+     * Purchase Shipping Label
      * @description Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
      */
     post: operations["Shipment buy"];
@@ -166,7 +166,7 @@ export interface paths {
   };
   "/stores/{storeId}/shipments/rates": {
     /**
-     * Get shipping rates
+     * Shipping Rates
      * @description Get available shipping rates based on origin, destination, and parcel information.
      */
     post: operations["Shipment rates"];
@@ -178,19 +178,19 @@ export interface paths {
   };
   "/stores/{storeId}/storefront/events": {
     /**
-     * Receive storefront events
+     * Receive Storefront Events
      * @description Processes events from storefronts using Shopify pixel event schema
      */
     post: operations["Storefront Event"];
   };
   "/stores/{storeId}/webhooks": {
     /**
-     * List webhooks
+     * List Webhooks
      * @description List webhooks for store.
      */
     get: operations["Webhooks list"];
     /**
-     * Create or update webhook
+     * Create or Update Webhook
      * @description Create webhook for store. Or if webhook already exists with `externalId`, update it.
      */
     post: operations["Webhook create"];
@@ -202,24 +202,24 @@ export interface paths {
   };
   "/webhooks/{webhookId}": {
     /**
-     * Get webhook
+     * Webhook
      * @description Get a webhook.
      */
     get: operations["Webhook get"];
     /**
-     * Update webhook
+     * Update Webhook
      * @description Update a webhook.
      */
     put: operations["Webhook update"];
     /**
-     * Delete webhook
+     * Delete Webhook
      * @description Delete a webhook.
      */
     delete: operations["Webhook delete"];
   };
   "/webhooks/{webhookId}/replay": {
     /**
-     * Replay webhook
+     * Replay Webhook
      * @description Replay a webhook.
      */
     post: operations["Webhook replay"];
@@ -1395,7 +1395,7 @@ export type external = Record<string, never>;
 export interface operations {
 
   /**
-   * Get invoice
+   * Invoice (CSV)
    * @description Get an invoice as a CSV.
    */
   "Invoice csv get": {
@@ -1420,7 +1420,7 @@ export interface operations {
     };
   };
   /**
-   * Get pending invoice
+   * Pending Invoice (CSV)
    * @description Get an invoice as a CSV.
    */
   "Invoice pending csv get": {
@@ -1440,7 +1440,7 @@ export interface operations {
     };
   };
   /**
-   * Get return
+   * Return
    * @description Get return.
    */
   "Return get": {
@@ -1468,7 +1468,7 @@ export interface operations {
     };
   };
   /**
-   * List return comments
+   * List Return Comments
    * @description List return comments.
    */
   "Return comments get": {
@@ -1493,7 +1493,7 @@ export interface operations {
     };
   };
   /**
-   * Create return comment
+   * Create Return Comment
    * @description Create return comment.
    */
   "Return comment create": {
@@ -1527,7 +1527,7 @@ export interface operations {
     };
   };
   /**
-   * Process return
+   * Process Return
    * @description **BETA**: This endpoint is in beta and subject to change.
    *
    * Trigger processing of a return with specified products.
@@ -1591,7 +1591,7 @@ export interface operations {
     };
   };
   /**
-   * Get return status
+   * Return Status
    * @description Get return status.
    */
   "Return status get": {
@@ -1618,7 +1618,7 @@ export interface operations {
     };
   };
   /**
-   * Update return status
+   * Update Return Status
    * @description Update return status.
    */
   "Return status update": {
@@ -1648,7 +1648,7 @@ export interface operations {
     };
   };
   /**
-   * Navigate to merchant admin
+   * Navigate to Merchant Admin
    * @description Navigate to the merchant admin page.
    */
   "Merchant admin navigate": {
@@ -1665,8 +1665,8 @@ export interface operations {
     };
   };
   /**
-   * Retrieve some rendered HTML and CSS for checkout buttons options for enabling and disabling coverage
-   * @description Generate HTML and CSS for checkout buttons
+   * Checkout Buttons UI
+   * @description Generate rendered HTML and CSS for checkout buttons.
    */
   "Checkout buttons UI": {
     parameters: {
@@ -1695,7 +1695,7 @@ export interface operations {
     };
   };
   /**
-   * Navigate to coverage info
+   * Navigate to Coverage Info
    * @description Navigate to the coverage info page.
    */
   "Coverage info navigate": {
@@ -1712,7 +1712,7 @@ export interface operations {
     };
   };
   /**
-   * Get coverage products
+   * Coverage Products
    * @description Get available coverage products.
    */
   "Coverage products": {
@@ -1795,7 +1795,7 @@ export interface operations {
     };
   };
   /**
-   * Navigate to customer portal
+   * Navigate to Customer Portal
    * @description Navigate to the customer portal.
    */
   "Customer portal navigate": {
@@ -1818,7 +1818,7 @@ export interface operations {
     };
   };
   /**
-   * Update customer subscriptions
+   * Update Customer Subscriptions
    * @description Update customer subscription status for SMS and email marketing and transactional messages. If the customer with that phone number or email does not exist, it will be created.
    */
   "Customer subscriptions update": {
@@ -1863,7 +1863,7 @@ export interface operations {
     };
   };
   /**
-   * Get invoice
+   * List Invoices
    * @description Get a list of invoices.
    */
   "Invoice list": {
@@ -1890,7 +1890,7 @@ export interface operations {
     };
   };
   /**
-   * List returns
+   * List Returns
    * @description List returns, sorted by most recent to least recent.
    */
   "Returns list": {
@@ -1931,7 +1931,7 @@ export interface operations {
     };
   };
   /**
-   * Download shipment document
+   * Download Shipment Document
    * @description Get a shipment document (label, commercial invoice, etc).
    */
   "Shipment document download": {
@@ -1959,7 +1959,7 @@ export interface operations {
     };
   };
   /**
-   * Purchase shipping label
+   * Purchase Shipping Label
    * @description Purchase a shipping label based on origin, destination, carrier, service, and parcel information.
    */
   "Shipment buy": {
@@ -2006,7 +2006,7 @@ export interface operations {
     };
   };
   /**
-   * Get shipping rates
+   * Shipping Rates
    * @description Get available shipping rates based on origin, destination, and parcel information.
    */
   "Shipment rates": {
@@ -2047,7 +2047,7 @@ export interface operations {
     };
   };
   /**
-   * Receive storefront events
+   * Receive Storefront Events
    * @description Processes events from storefronts using Shopify pixel event schema
    */
   "Storefront Event": {
@@ -2081,7 +2081,7 @@ export interface operations {
     };
   };
   /**
-   * List webhooks
+   * List Webhooks
    * @description List webhooks for store.
    */
   "Webhooks list": {
@@ -2108,7 +2108,7 @@ export interface operations {
     };
   };
   /**
-   * Create or update webhook
+   * Create or Update Webhook
    * @description Create webhook for store. Or if webhook already exists with `externalId`, update it.
    */
   "Webhook create": {
@@ -2150,7 +2150,7 @@ export interface operations {
     };
   };
   /**
-   * Get webhook
+   * Webhook
    * @description Get a webhook.
    */
   "Webhook get": {
@@ -2171,7 +2171,7 @@ export interface operations {
     };
   };
   /**
-   * Update webhook
+   * Update Webhook
    * @description Update a webhook.
    */
   "Webhook update": {
@@ -2201,7 +2201,7 @@ export interface operations {
     };
   };
   /**
-   * Delete webhook
+   * Delete Webhook
    * @description Delete a webhook.
    */
   "Webhook delete": {
@@ -2218,7 +2218,7 @@ export interface operations {
     };
   };
   /**
-   * Replay webhook
+   * Replay Webhook
    * @description Replay a webhook.
    */
   "Webhook replay": {

package/lib/openapi.yaml

@@ -1599,9 +1599,9 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Get pending invoice
+      summary: Pending Invoice (CSV)
       tags:
-        - Invoice
+        - Invoices
     summary: Pending invoice
   /invoices/{invoiceId}/items.csv:
     description: Return invoice CSV file.
@@ -1626,9 +1626,9 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Get invoice
+      summary: Invoice (CSV)
       tags:
-        - Invoice
+        - Invoices
     summary: Invoice
   /returns/{returnId}:
     description: Return.
@@ -1658,7 +1658,7 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Get return
+      summary: Return
       tags:
         - Returns
     parameters:
@@ -1685,7 +1685,7 @@ paths:
                   - comments
                 type: object
           description: Success
-      summary: List return comments
+      summary: List Return Comments
       tags:
         - Returns
     parameters:
@@ -1724,7 +1724,7 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Create return comment
+      summary: Create Return Comment
       tags:
         - Returns
     summary: Return comment
@@ -1806,7 +1806,7 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Process return
+      summary: Process Return
       tags:
         - Returns
     summary: Process return
@@ -1837,7 +1837,7 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Get return status
+      summary: Return Status
       tags:
         - Returns
     put:
@@ -1867,7 +1867,7 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Update return status
+      summary: Update Return Status
       tags:
         - Returns
     summary: Return status
@@ -1881,14 +1881,14 @@ paths:
       responses:
         '302':
           description: Redirect
-      summary: Navigate to merchant admin
+      summary: Navigate to Merchant Admin
       tags:
-        - Merchant admin
+        - Merchant Admin
     summary: Merchant admin
   /stores/{storeId}/checkout-buttons-ui:
-    description: Generate HTML and CSS for checkout buttons
+    description: Generate HTML and CSS for checkout buttons to enable or disable returns coverage.
     get:
-      description: Generate HTML and CSS for checkout buttons
+      description: Generate rendered HTML and CSS for checkout buttons.
       operationId: Checkout buttons UI
       parameters:
         - $ref: '#/components/parameters/store-id.param'
@@ -1907,10 +1907,9 @@ paths:
                     title: Checkout buttons HTML
                     type: string
           description: Success
-      summary: Retrieve some rendered HTML and CSS for checkout buttons options for enabling and disabling coverage
+      summary: Checkout Buttons UI
       tags:
-        - Checkout buttons
-        - UI
+        - Checkout Buttons
     summary: Checkout buttons UI
   /stores/{storeId}/coverage-info:
     description: Navigate to the coverage info page.
@@ -1922,9 +1921,9 @@ paths:
       responses:
         '302':
           description: Redirect
-      summary: Navigate to coverage info
+      summary: Navigate to Coverage Info
       tags:
-        - Coverage info
+        - Coverage Info
     summary: Coverage info
   /stores/{storeId}/coverage-products:
     description: Available coverage products.
@@ -2011,9 +2010,9 @@ paths:
               schema:
                 $ref: '#/components/schemas/error.schema'
           description: Error
-      summary: Get coverage products
+      summary: Coverage Products
       tags:
-        - Coverage products
+        - Coverage Products
     summary: Coverage products
   /stores/{storeId}/customer-portal:
     description: Navigate to the customer portal.
@@ -2035,9 +2034,9 @@ paths:
       responses:
         '302':
           description: Redirect
-      summary: Navigate to customer portal
+      summary: Navigate to Customer Portal
       tags:
-        - Customer portal
+        - Customer Portal
     summary: Customer portal
   /stores/{storeId}/customer-subscriptions:
     description: Update customer subscription preferences for marketing and transactional messages.
@@ -2084,9 +2083,9 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Update customer subscriptions
+      summary: Update Customer Subscriptions
       tags:
-        - Customer subscriptions
+        - Customer Subscriptions
     summary: Customer subscriptions
   /stores/{storeId}/invoices:
     description: Return a list of invoices.
@@ -2117,9 +2116,9 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Get invoice
+      summary: List Invoices
       tags:
-        - Invoice
+        - Invoices
     summary: Invoice
   /stores/{storeId}/returns:
     description: List of returns for store.
@@ -2163,7 +2162,7 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: List returns
+      summary: List Returns
       tags:
         - Returns
     parameters:
@@ -2235,7 +2234,7 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Purchase shipping label
+      summary: Purchase Shipping Label
       tags:
         - Shipping
     summary: Shipment Buy
@@ -2296,7 +2295,7 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Get shipping rates
+      summary: Shipping Rates
       tags:
         - Shipping
     summary: Shipment Rates
@@ -2328,7 +2327,7 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Download shipment document
+      summary: Download Shipment Document
       tags:
         - Shipping
     parameters:
@@ -2363,7 +2362,7 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Receive storefront events
+      summary: Receive Storefront Events
       tags:
         - Storefront
   /stores/{storeId}/webhooks:
@@ -2391,7 +2390,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/error.schema'
           description: Error
-      summary: List webhooks
+      summary: List Webhooks
       tags:
         - Webhooks
     parameters:
@@ -2435,7 +2434,7 @@ paths:
           description: Error
       security:
         - Bearer: []
-      summary: Create or update webhook
+      summary: Create or Update Webhook
       tags:
         - Webhooks
     summary: Webhooks
@@ -2450,7 +2449,7 @@ paths:
           description: Deleted
       security:
         - Bearer: []
-      summary: Delete webhook
+      summary: Delete Webhook
       tags:
         - Webhooks
     description: Webhook.
@@ -2471,7 +2470,7 @@ paths:
                   - webhook
                 type: object
           description: Success
-      summary: Get webhook
+      summary: Webhook
       tags:
         - Webhooks
     put:
@@ -2499,7 +2498,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/error.schema'
           description: Error
-      summary: Update webhook
+      summary: Update Webhook
       tags:
         - Webhooks
     summary: Webhook
@@ -2531,7 +2530,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/error.schema'
           description: Error
-      summary: Replay webhook
+      summary: Replay Webhook
       tags:
         - Webhooks
     summary: Webhook replay

package/package.json

@@ -31,5 +31,5 @@
       ]
     }
   },
-  "version": "2.2.238"
+  "version": "2.2.245"
 }