@augstash/sdk 0.2.0

package/dist/generated/src/apis/OrderNotificationApi.d.ts

@@ -0,0 +1,185 @@
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { OrderNotificationDefaultResponse, OrderNotificationRuleResponse, PageResponseOrderNotificationLogResponse, Pageable, UpsertOrderNotificationRuleRequest } from '../models/index';
+export interface DeleteRuleCatalogRequest {
+    status: DeleteRuleCatalogStatusEnum;
+    xIdempotencyKey?: string;
+}
+export interface ListLogsRequest {
+    pageable: Pageable;
+    orderId?: string;
+}
+export interface UpsertRuleRequest {
+    status: UpsertRuleStatusEnum;
+    upsertOrderNotificationRuleRequest: UpsertOrderNotificationRuleRequest;
+    xIdempotencyKey?: string;
+}
+/**
+ * OrderNotificationApi - interface
+ *
+ * @export
+ * @interface OrderNotificationApiInterface
+ */
+export interface OrderNotificationApiInterface {
+    /**
+     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable status, each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
+     * @summary The shipped default notification set
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderNotificationApiInterface
+     */
+    defaultsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<OrderNotificationDefaultResponse>>>;
+    /**
+     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable status, each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
+     * The shipped default notification set
+     */
+    defaults(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<OrderNotificationDefaultResponse>>;
+    /**
+     * Writes < 300ms. Prefer enabled=false when the merchant may want the template back — this discards the choice. Requires API-key scope: catalog:write.
+     * @summary Delete the notification rule for an order status
+     * @param {'RECEIVED' | 'ACKNOWLEDGED' | 'SHOPIFY_SYNCED' | 'SHOPIFY_FAILED' | 'FULFILLED' | 'CANCELLED'} status
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderNotificationApiInterface
+     */
+    deleteRuleCatalogRaw(requestParameters: DeleteRuleCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Writes < 300ms. Prefer enabled=false when the merchant may want the template back — this discards the choice. Requires API-key scope: catalog:write.
+     * Delete the notification rule for an order status
+     */
+    deleteRuleCatalog(requestParameters: DeleteRuleCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Reads < 300ms. Default page size 20, max 100, newest first; optional orderId filter. Every decision is recorded, not only the sends: outcome SKIPPED with reason NO_RULE is the commonest row on a new tenant and is a configuration gap, not a failure. Localize on reason, never on detail. Requires API-key scope: catalog:read.
+     * @summary List order notification decisions
+     * @param {Pageable} pageable
+     * @param {string} [orderId]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderNotificationApiInterface
+     */
+    listLogsRaw(requestParameters: ListLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseOrderNotificationLogResponse>>;
+    /**
+     * Reads < 300ms. Default page size 20, max 100, newest first; optional orderId filter. Every decision is recorded, not only the sends: outcome SKIPPED with reason NO_RULE is the commonest row on a new tenant and is a configuration gap, not a failure. Localize on reason, never on detail. Requires API-key scope: catalog:read.
+     * List order notification decisions
+     */
+    listLogs(requestParameters: ListLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseOrderNotificationLogResponse>;
+    /**
+     * Reads < 300ms. Bounded by the OrderStatus enum, so not paginated. templateApproved reflects Meta\'s CURRENT verdict — a rule with it false is configured but will skip at send time, and must be surfaced as a warning rather than a healthy toggle. Requires API-key scope: catalog:read.
+     * @summary List the configured order lifecycle notification rules
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderNotificationApiInterface
+     */
+    listRulesCatalogRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<OrderNotificationRuleResponse>>>;
+    /**
+     * Reads < 300ms. Bounded by the OrderStatus enum, so not paginated. templateApproved reflects Meta\'s CURRENT verdict — a rule with it false is configured but will skip at send time, and must be surfaced as a warning rather than a healthy toggle. Requires API-key scope: catalog:read.
+     * List the configured order lifecycle notification rules
+     */
+    listRulesCatalog(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<OrderNotificationRuleResponse>>;
+    /**
+     * Writes < 300ms. The status in the path is the rule\'s identity, so this is an upsert. The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. Requires API-key scope: catalog:write.
+     * @summary Create or replace the notification rule for an order status
+     * @param {'RECEIVED' | 'ACKNOWLEDGED' | 'SHOPIFY_SYNCED' | 'SHOPIFY_FAILED' | 'FULFILLED' | 'CANCELLED'} status
+     * @param {UpsertOrderNotificationRuleRequest} upsertOrderNotificationRuleRequest
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderNotificationApiInterface
+     */
+    upsertRuleRaw(requestParameters: UpsertRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderNotificationRuleResponse>>;
+    /**
+     * Writes < 300ms. The status in the path is the rule\'s identity, so this is an upsert. The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. Requires API-key scope: catalog:write.
+     * Create or replace the notification rule for an order status
+     */
+    upsertRule(requestParameters: UpsertRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderNotificationRuleResponse>;
+}
+/**
+ *
+ */
+export declare class OrderNotificationApi extends runtime.BaseAPI implements OrderNotificationApiInterface {
+    /**
+     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable status, each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
+     * The shipped default notification set
+     */
+    defaultsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<OrderNotificationDefaultResponse>>>;
+    /**
+     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable status, each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
+     * The shipped default notification set
+     */
+    defaults(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<OrderNotificationDefaultResponse>>;
+    /**
+     * Writes < 300ms. Prefer enabled=false when the merchant may want the template back — this discards the choice. Requires API-key scope: catalog:write.
+     * Delete the notification rule for an order status
+     */
+    deleteRuleCatalogRaw(requestParameters: DeleteRuleCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Writes < 300ms. Prefer enabled=false when the merchant may want the template back — this discards the choice. Requires API-key scope: catalog:write.
+     * Delete the notification rule for an order status
+     */
+    deleteRuleCatalog(requestParameters: DeleteRuleCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Reads < 300ms. Default page size 20, max 100, newest first; optional orderId filter. Every decision is recorded, not only the sends: outcome SKIPPED with reason NO_RULE is the commonest row on a new tenant and is a configuration gap, not a failure. Localize on reason, never on detail. Requires API-key scope: catalog:read.
+     * List order notification decisions
+     */
+    listLogsRaw(requestParameters: ListLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseOrderNotificationLogResponse>>;
+    /**
+     * Reads < 300ms. Default page size 20, max 100, newest first; optional orderId filter. Every decision is recorded, not only the sends: outcome SKIPPED with reason NO_RULE is the commonest row on a new tenant and is a configuration gap, not a failure. Localize on reason, never on detail. Requires API-key scope: catalog:read.
+     * List order notification decisions
+     */
+    listLogs(requestParameters: ListLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseOrderNotificationLogResponse>;
+    /**
+     * Reads < 300ms. Bounded by the OrderStatus enum, so not paginated. templateApproved reflects Meta\'s CURRENT verdict — a rule with it false is configured but will skip at send time, and must be surfaced as a warning rather than a healthy toggle. Requires API-key scope: catalog:read.
+     * List the configured order lifecycle notification rules
+     */
+    listRulesCatalogRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<OrderNotificationRuleResponse>>>;
+    /**
+     * Reads < 300ms. Bounded by the OrderStatus enum, so not paginated. templateApproved reflects Meta\'s CURRENT verdict — a rule with it false is configured but will skip at send time, and must be surfaced as a warning rather than a healthy toggle. Requires API-key scope: catalog:read.
+     * List the configured order lifecycle notification rules
+     */
+    listRulesCatalog(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<OrderNotificationRuleResponse>>;
+    /**
+     * Writes < 300ms. The status in the path is the rule\'s identity, so this is an upsert. The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. Requires API-key scope: catalog:write.
+     * Create or replace the notification rule for an order status
+     */
+    upsertRuleRaw(requestParameters: UpsertRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderNotificationRuleResponse>>;
+    /**
+     * Writes < 300ms. The status in the path is the rule\'s identity, so this is an upsert. The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. Requires API-key scope: catalog:write.
+     * Create or replace the notification rule for an order status
+     */
+    upsertRule(requestParameters: UpsertRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderNotificationRuleResponse>;
+}
+/**
+ * @export
+ */
+export declare const DeleteRuleCatalogStatusEnum: {
+    readonly Received: "RECEIVED";
+    readonly Acknowledged: "ACKNOWLEDGED";
+    readonly ShopifySynced: "SHOPIFY_SYNCED";
+    readonly ShopifyFailed: "SHOPIFY_FAILED";
+    readonly Fulfilled: "FULFILLED";
+    readonly Cancelled: "CANCELLED";
+};
+export type DeleteRuleCatalogStatusEnum = typeof DeleteRuleCatalogStatusEnum[keyof typeof DeleteRuleCatalogStatusEnum];
+/**
+ * @export
+ */
+export declare const UpsertRuleStatusEnum: {
+    readonly Received: "RECEIVED";
+    readonly Acknowledged: "ACKNOWLEDGED";
+    readonly ShopifySynced: "SHOPIFY_SYNCED";
+    readonly ShopifyFailed: "SHOPIFY_FAILED";
+    readonly Fulfilled: "FULFILLED";
+    readonly Cancelled: "CANCELLED";
+};
+export type UpsertRuleStatusEnum = typeof UpsertRuleStatusEnum[keyof typeof UpsertRuleStatusEnum];

package/dist/generated/src/apis/OrderNotificationApi.js

@@ -0,0 +1,276 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpsertRuleStatusEnum = exports.DeleteRuleCatalogStatusEnum = exports.OrderNotificationApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class OrderNotificationApi extends runtime.BaseAPI {
+    /**
+     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable status, each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
+     * The shipped default notification set
+     */
+    async defaultsRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/catalog/notification-rules/defaults`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.OrderNotificationDefaultResponseFromJSON));
+    }
+    /**
+     * Reads < 300ms. The starting point the FE renders on an unconfigured tenant — one entry per notifiable status, each naming a system template group to clone. These are SUGGESTIONS: nothing sends until the tenant clones the blueprint, Meta approves it, and a rule is saved against the owned template. Not paginated. Requires API-key scope: catalog:read.
+     * The shipped default notification set
+     */
+    async defaults(initOverrides) {
+        const response = await this.defaultsRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Writes < 300ms. Prefer enabled=false when the merchant may want the template back — this discards the choice. Requires API-key scope: catalog:write.
+     * Delete the notification rule for an order status
+     */
+    async deleteRuleCatalogRaw(requestParameters, initOverrides) {
+        if (requestParameters['status'] == null) {
+            throw new runtime.RequiredError('status', 'Required parameter "status" was null or undefined when calling deleteRuleCatalog().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['xIdempotencyKey'] != null) {
+            headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/catalog/notification-rules/{status}`;
+        urlPath = urlPath.replace(`{${"status"}}`, encodeURIComponent(String(requestParameters['status'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Writes < 300ms. Prefer enabled=false when the merchant may want the template back — this discards the choice. Requires API-key scope: catalog:write.
+     * Delete the notification rule for an order status
+     */
+    async deleteRuleCatalog(requestParameters, initOverrides) {
+        await this.deleteRuleCatalogRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Reads < 300ms. Default page size 20, max 100, newest first; optional orderId filter. Every decision is recorded, not only the sends: outcome SKIPPED with reason NO_RULE is the commonest row on a new tenant and is a configuration gap, not a failure. Localize on reason, never on detail. Requires API-key scope: catalog:read.
+     * List order notification decisions
+     */
+    async listLogsRaw(requestParameters, initOverrides) {
+        if (requestParameters['pageable'] == null) {
+            throw new runtime.RequiredError('pageable', 'Required parameter "pageable" was null or undefined when calling listLogs().');
+        }
+        const queryParameters = {};
+        if (requestParameters['orderId'] != null) {
+            queryParameters['orderId'] = requestParameters['orderId'];
+        }
+        if (requestParameters['pageable'] != null) {
+            queryParameters['pageable'] = requestParameters['pageable'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/catalog/notification-logs`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PageResponseOrderNotificationLogResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Reads < 300ms. Default page size 20, max 100, newest first; optional orderId filter. Every decision is recorded, not only the sends: outcome SKIPPED with reason NO_RULE is the commonest row on a new tenant and is a configuration gap, not a failure. Localize on reason, never on detail. Requires API-key scope: catalog:read.
+     * List order notification decisions
+     */
+    async listLogs(requestParameters, initOverrides) {
+        const response = await this.listLogsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Reads < 300ms. Bounded by the OrderStatus enum, so not paginated. templateApproved reflects Meta\'s CURRENT verdict — a rule with it false is configured but will skip at send time, and must be surfaced as a warning rather than a healthy toggle. Requires API-key scope: catalog:read.
+     * List the configured order lifecycle notification rules
+     */
+    async listRulesCatalogRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/catalog/notification-rules`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.OrderNotificationRuleResponseFromJSON));
+    }
+    /**
+     * Reads < 300ms. Bounded by the OrderStatus enum, so not paginated. templateApproved reflects Meta\'s CURRENT verdict — a rule with it false is configured but will skip at send time, and must be surfaced as a warning rather than a healthy toggle. Requires API-key scope: catalog:read.
+     * List the configured order lifecycle notification rules
+     */
+    async listRulesCatalog(initOverrides) {
+        const response = await this.listRulesCatalogRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Writes < 300ms. The status in the path is the rule\'s identity, so this is an upsert. The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. Requires API-key scope: catalog:write.
+     * Create or replace the notification rule for an order status
+     */
+    async upsertRuleRaw(requestParameters, initOverrides) {
+        if (requestParameters['status'] == null) {
+            throw new runtime.RequiredError('status', 'Required parameter "status" was null or undefined when calling upsertRule().');
+        }
+        if (requestParameters['upsertOrderNotificationRuleRequest'] == null) {
+            throw new runtime.RequiredError('upsertOrderNotificationRuleRequest', 'Required parameter "upsertOrderNotificationRuleRequest" was null or undefined when calling upsertRule().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['xIdempotencyKey'] != null) {
+            headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/catalog/notification-rules/{status}`;
+        urlPath = urlPath.replace(`{${"status"}}`, encodeURIComponent(String(requestParameters['status'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.UpsertOrderNotificationRuleRequestToJSON)(requestParameters['upsertOrderNotificationRuleRequest']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.OrderNotificationRuleResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Writes < 300ms. The status in the path is the rule\'s identity, so this is an upsert. The template must exist and be APPROVED now — an unapproved one is refused here rather than skipped silently hours later. Requires API-key scope: catalog:write.
+     * Create or replace the notification rule for an order status
+     */
+    async upsertRule(requestParameters, initOverrides) {
+        const response = await this.upsertRuleRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+exports.OrderNotificationApi = OrderNotificationApi;
+/**
+ * @export
+ */
+exports.DeleteRuleCatalogStatusEnum = {
+    Received: 'RECEIVED',
+    Acknowledged: 'ACKNOWLEDGED',
+    ShopifySynced: 'SHOPIFY_SYNCED',
+    ShopifyFailed: 'SHOPIFY_FAILED',
+    Fulfilled: 'FULFILLED',
+    Cancelled: 'CANCELLED'
+};
+/**
+ * @export
+ */
+exports.UpsertRuleStatusEnum = {
+    Received: 'RECEIVED',
+    Acknowledged: 'ACKNOWLEDGED',
+    ShopifySynced: 'SHOPIFY_SYNCED',
+    ShopifyFailed: 'SHOPIFY_FAILED',
+    Fulfilled: 'FULFILLED',
+    Cancelled: 'CANCELLED'
+};

package/dist/generated/src/apis/OrderPaymentApi.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CreatePaymentLinkRequest, OrderPaymentResponse, RefundOrderPaymentRequest } from '../models/index';
+export interface CreatePaymentLinkOperationRequest {
+    orderId: string;
+    createPaymentLinkRequest: CreatePaymentLinkRequest;
+    xIdempotencyKey?: string;
+}
+export interface GetPaymentRequest {
+    orderId: string;
+}
+export interface RefundRequest {
+    orderId: string;
+    xIdempotencyKey?: string;
+    refundOrderPaymentRequest?: RefundOrderPaymentRequest;
+}
+/**
+ * OrderPaymentApi - interface
+ *
+ * @export
+ * @interface OrderPaymentApiInterface
+ */
+export interface OrderPaymentApiInterface {
+    /**
+     * Sends < 800ms — creates the link at the payment provider and, unless deliver=false, pushes it into the conversation the order came from. The amount and currency come from the ORDER, never from the request. Delivery is best-effort: a delivery failure is reported on deliveryError and never fails the link. Not paginated. Requires API-key scope: catalog:write.
+     * @summary Raise a hosted payment link for a customer order
+     * @param {string} orderId
+     * @param {CreatePaymentLinkRequest} createPaymentLinkRequest
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderPaymentApiInterface
+     */
+    createPaymentLinkRaw(requestParameters: CreatePaymentLinkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPaymentResponse>>;
+    /**
+     * Sends < 800ms — creates the link at the payment provider and, unless deliver=false, pushes it into the conversation the order came from. The amount and currency come from the ORDER, never from the request. Delivery is best-effort: a delivery failure is reported on deliveryError and never fails the link. Not paginated. Requires API-key scope: catalog:write.
+     * Raise a hosted payment link for a customer order
+     */
+    createPaymentLink(requestParameters: CreatePaymentLinkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPaymentResponse>;
+    /**
+     * Reads < 300ms. Returns the most recent payment raised for the order. status moves on the verified provider webhook, NOT on the customer\'s post-payment redirect — poll this rather than assuming success on return. Not paginated. Requires API-key scope: catalog:read.
+     * @summary Get the current payment for a customer order
+     * @param {string} orderId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderPaymentApiInterface
+     */
+    getPaymentRaw(requestParameters: GetPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPaymentResponse>>;
+    /**
+     * Reads < 300ms. Returns the most recent payment raised for the order. status moves on the verified provider webhook, NOT on the customer\'s post-payment redirect — poll this rather than assuming success on return. Not paginated. Requires API-key scope: catalog:read.
+     * Get the current payment for a customer order
+     */
+    getPayment(requestParameters: GetPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPaymentResponse>;
+    /**
+     * Sends < 800ms. Refunds the whole captured amount unless a smaller amount is given. Only a PAID payment can be refunded. Not paginated. Requires API-key scope: catalog:write.
+     * @summary Refund a captured order payment
+     * @param {string} orderId
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {RefundOrderPaymentRequest} [refundOrderPaymentRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderPaymentApiInterface
+     */
+    refundRaw(requestParameters: RefundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPaymentResponse>>;
+    /**
+     * Sends < 800ms. Refunds the whole captured amount unless a smaller amount is given. Only a PAID payment can be refunded. Not paginated. Requires API-key scope: catalog:write.
+     * Refund a captured order payment
+     */
+    refund(requestParameters: RefundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPaymentResponse>;
+}
+/**
+ *
+ */
+export declare class OrderPaymentApi extends runtime.BaseAPI implements OrderPaymentApiInterface {
+    /**
+     * Sends < 800ms — creates the link at the payment provider and, unless deliver=false, pushes it into the conversation the order came from. The amount and currency come from the ORDER, never from the request. Delivery is best-effort: a delivery failure is reported on deliveryError and never fails the link. Not paginated. Requires API-key scope: catalog:write.
+     * Raise a hosted payment link for a customer order
+     */
+    createPaymentLinkRaw(requestParameters: CreatePaymentLinkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPaymentResponse>>;
+    /**
+     * Sends < 800ms — creates the link at the payment provider and, unless deliver=false, pushes it into the conversation the order came from. The amount and currency come from the ORDER, never from the request. Delivery is best-effort: a delivery failure is reported on deliveryError and never fails the link. Not paginated. Requires API-key scope: catalog:write.
+     * Raise a hosted payment link for a customer order
+     */
+    createPaymentLink(requestParameters: CreatePaymentLinkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPaymentResponse>;
+    /**
+     * Reads < 300ms. Returns the most recent payment raised for the order. status moves on the verified provider webhook, NOT on the customer\'s post-payment redirect — poll this rather than assuming success on return. Not paginated. Requires API-key scope: catalog:read.
+     * Get the current payment for a customer order
+     */
+    getPaymentRaw(requestParameters: GetPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPaymentResponse>>;
+    /**
+     * Reads < 300ms. Returns the most recent payment raised for the order. status moves on the verified provider webhook, NOT on the customer\'s post-payment redirect — poll this rather than assuming success on return. Not paginated. Requires API-key scope: catalog:read.
+     * Get the current payment for a customer order
+     */
+    getPayment(requestParameters: GetPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPaymentResponse>;
+    /**
+     * Sends < 800ms. Refunds the whole captured amount unless a smaller amount is given. Only a PAID payment can be refunded. Not paginated. Requires API-key scope: catalog:write.
+     * Refund a captured order payment
+     */
+    refundRaw(requestParameters: RefundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPaymentResponse>>;
+    /**
+     * Sends < 800ms. Refunds the whole captured amount unless a smaller amount is given. Only a PAID payment can be refunded. Not paginated. Requires API-key scope: catalog:write.
+     * Refund a captured order payment
+     */
+    refund(requestParameters: RefundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPaymentResponse>;
+}