@omni-commerce/sdk 0.1.1 → 0.3.0

package/dist/index.cjs

@@ -26,7 +26,7 @@ function normalizeClientOptions(options = {}) {
 }
 
 // src/version.ts
-var SDK_VERSION = "0.1.1";
+var SDK_VERSION = "0.3.0";
 var SDK_USER_AGENT = `omnicommerce-js/${SDK_VERSION}`;
 
 // src/environments.ts
@@ -509,6 +509,116 @@ async function waitForJob(http, request, options) {
 }
 
 // src/generated/resources.ts
+var AgentsGeneralClient = class {
+  constructor(_http) {
+    this._http = _http;
+  }
+  _http;
+  /**
+     * Invoke the Omni agent
+     *
+     * Run the general Omni agent and wait until it completes, pauses for approval, or fails. Requires `agents:invoke`.
+  
+  A waiting call can take several minutes; raise the client timeout. Send `decisions` with the same `thread_id` to approve or reject a paused run. Omit `config.enabled_tools` to use the organization's agent tools. Attach images on the latest user message as `{ type: "image", url }` HTTP(S) URLs.
+     *
+     * `POST /api/v1/agents/general/invoke`
+     */
+  invoke(request, requestOptions) {
+    const { ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: "/api/v1/agents/general/invoke",
+      query: void 0,
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+   * Start an Omni agent run
+   *
+   * Queue the general Omni agent and return immediately with the run in `queued` state. Poll the URL in the `Location` header (`GET /api/v1/agents/general/runs/{runId}`), honoring `Retry-After`. Requires `agents:invoke`. The request body matches invoke.
+   *
+   * `POST /api/v1/agents/general/runs`
+   */
+  start(request, requestOptions) {
+    const { ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: "/api/v1/agents/general/runs",
+      query: void 0,
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+   * Get an Omni agent run
+   *
+   * Read a queued, running, completed, paused, or failed Omni agent run. Requires `agents:invoke`.
+   *
+   * `GET /api/v1/agents/general/runs/{runId}`
+   */
+  getRun(request, requestOptions) {
+    const { runId, organizationId } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: `/api/v1/agents/general/runs/${encodePathParam("runId", runId)}`,
+      query: { organizationId },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+};
+var AgentsClient = class {
+  constructor(_http) {
+    this._http = _http;
+    this.general = new AgentsGeneralClient(this._http);
+  }
+  _http;
+  general;
+};
+var AnalyticsClient = class {
+  constructor(_http) {
+    this._http = _http;
+  }
+  _http;
+  /**
+     * Get Sales Analytics
+     *
+     * Sales KPIs for a date range with the change against the previous period of equal length, a daily trend, sales by order status and by marketplace, and the top products by net sales. Matches the Orders analysis page. Requires `analytics:read`.
+  
+  Amounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.
+     *
+     * `GET /api/v1/analytics/sales`
+     */
+  getSales(request = {}, requestOptions) {
+    const {
+      organizationId,
+      from,
+      to,
+      marketplace,
+      country,
+      store,
+      currency,
+      timeZone
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/analytics/sales",
+      query: {
+        organizationId,
+        from,
+        to,
+        marketplace,
+        country,
+        store,
+        currency,
+        timeZone
+      },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+};
 var AopClient = class {
   constructor(_http) {
     this._http = _http;
@@ -638,6 +748,148 @@ var ApiClient = class {
     });
   }
 };
+var CampaignsClient = class {
+  constructor(_http) {
+    this._http = _http;
+  }
+  _http;
+  /**
+   * List Campaigns
+   *
+   * List campaigns for the authenticated organization. `stage=all` is the workspace working set: draft and running. Requires `promotions:read`.
+   *
+   * `GET /api/v1/campaigns`
+   */
+  list(request = {}, requestOptions) {
+    const { organizationId, q, stage, offset, limit } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/campaigns",
+      query: { organizationId, q, stage, offset, limit },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+   * Create Campaign
+   *
+   * Create a draft campaign. `ownerId` and `approverId` must be members of the organization, and every store must already be connected. Requires `promotions:write`.
+   *
+   * `POST /api/v1/campaigns`
+   */
+  create(request, requestOptions) {
+    const { ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: "/api/v1/campaigns",
+      query: void 0,
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+   * Get Campaign
+   *
+   * Read one campaign, including its plan, executions, audit, schedule, and progress. Requires `promotions:read`.
+   *
+   * `GET /api/v1/campaigns/{campaignId}`
+   */
+  get(request, requestOptions) {
+    const { campaignId, organizationId } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: `/api/v1/campaigns/${encodePathParam("campaignId", campaignId)}`,
+      query: { organizationId },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+   * Update Campaign
+   *
+   * Replace a draft or approved plan, or propose one change to a running plan. Send `expectedRevision` from the last read. Requires `promotions:write`.
+   *
+   * `PUT /api/v1/campaigns/{campaignId}`
+   */
+  replace(request, requestOptions) {
+    const { campaignId, ...body } = request ?? {};
+    return this._http.request({
+      method: "PUT",
+      path: `/api/v1/campaigns/${encodePathParam("campaignId", campaignId)}`,
+      query: void 0,
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+   * Act on Campaign
+   *
+   * Approve, start, end, resume, retry, or decide a proposed live change. Approve, run, resume, and approving a change must be called by the named approver. Requires `promotions:write`.
+   *
+   * `POST /api/v1/campaigns/{campaignId}/actions`
+   */
+  actions(request, requestOptions) {
+    const { campaignId, ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: `/api/v1/campaigns/${encodePathParam("campaignId", campaignId)}/actions`,
+      query: void 0,
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+   * Archive Campaigns
+   *
+   * Archive campaigns, or restore archived campaigns by id or by the current archived list filters. Requires `promotions:write`.
+   *
+   * `POST /api/v1/campaigns/archive`
+   */
+  archive(request, requestOptions) {
+    const { ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: "/api/v1/campaigns/archive",
+      query: void 0,
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+   * Delete Campaigns
+   *
+   * Permanently delete archived campaigns by explicit id or by archived list filters. Requires `promotions:write`.
+   *
+   * `POST /api/v1/campaigns/delete`
+   */
+  delete(request, requestOptions) {
+    const { ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: "/api/v1/campaigns/delete",
+      query: void 0,
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+   * Get Campaign Options
+   *
+   * List the organization members and connected stores a campaign plan can name. Use a member `id` for `ownerId` and `approverId`. Requires `promotions:write`.
+   *
+   * `GET /api/v1/campaigns/options`
+   */
+  getOptions(request = {}, requestOptions) {
+    const { organizationId } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/campaigns/options",
+      query: { organizationId },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+};
 var CatalogClient = class {
   constructor(_http) {
     this._http = _http;
@@ -1327,6 +1579,63 @@ var OrdersClient = class {
       ...mergeRequestOptions(requestOptions)
     });
   }
+  /**
+     * Get Order Action Options
+     *
+     * Ask the marketplace which choices an action needs, such as pickup or drop-off for `ship`. Requires `orders:write`.
+  
+  Send the chosen choice's `payload` with `POST /api/v1/orders/{orderId}/actions`.
+     *
+     * `GET /api/v1/orders/{orderId}/action-options`
+     */
+  getActionOptions(request, requestOptions) {
+    const { orderId, organizationId, action } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: `/api/v1/orders/${encodePathParam("orderId", orderId)}/action-options`,
+      query: { organizationId, action },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * List Order Actions
+     *
+     * The order's 20 most recent action jobs, newest first, plus its latest successful label job. Requires `orders:read`.
+  
+  Poll this after queueing an action. A succeeded `labels` job lists its label files in `labels`.
+     *
+     * `GET /api/v1/orders/{orderId}/actions`
+     */
+  listActions(request, requestOptions) {
+    const { orderId, organizationId } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: `/api/v1/orders/${encodePathParam("orderId", orderId)}/actions`,
+      query: { organizationId },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Queue Order Action
+     *
+     * Ship, cancel, generate shipping labels for, or update tracking on a marketplace order. Requires `orders:write`.
+  
+  The marketplace call runs in the background: the response is `202` with `jobId`; poll `GET /api/v1/orders/{orderId}/actions`. A repeated `idempotencyKey` returns `200` with the original job.
+     *
+     * `POST /api/v1/orders/{orderId}/actions`
+     */
+  queueAction(request, requestOptions) {
+    const { orderId, ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: `/api/v1/orders/${encodePathParam("orderId", orderId)}/actions`,
+      query: void 0,
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
 };
 var OrganizationsClient = class {
   constructor(_http) {
@@ -1494,7 +1803,9 @@ var ProductsClient = class {
      *
      * List products for the authenticated organization with optional filters and pagination. Authenticate with an API key or OAuth bearer token. The organization is taken from that credential; do not send `organizationId`.
   
-  Rows are in `items`. Read catalog stock from `items[].stockQuantity`: parent rows already aggregate their non-deleted variants, and virtual bundles use component availability with any manual cap. Null means unknown, not zero. List rows do not contain `inventoryQuantity`, `inventory.quantity`, or an embedded `variants` array.
+  ### Stock and variants
+  
+  Rows are in `items`. Read catalog stock from `items[].stockQuantity`: parent rows already aggregate their non-deleted variants, and virtual bundles use component availability with any manual cap. Null means unknown, not zero. A row with `variantCount` above 0 has variants; fetch them from `GET /api/v1/products/{productId}`. List rows do not contain `inventoryQuantity`, `inventory.quantity`, or an embedded `variants` array.
      *
      * `GET /api/v1/products`
      */
@@ -1588,6 +1899,8 @@ var ProductsClient = class {
   - Localization content and cultural notes
   - Intent queries and signals
   - Sources and claims
+  
+  A parent product returns its variants in `variants`, with each variant's option values, price, stock, image, and marketplace listings.
      *
      * `GET /api/v1/products/{productId}`
      */
@@ -1681,6 +1994,25 @@ var ProductsClient = class {
       ...mergeRequestOptions(requestOptions)
     });
   }
+  /**
+     * Get Product Listings
+     *
+     * Where a product is listed: each marketplace's store, live or delisted state, item id, buyer-facing URL, and the latest publish attempt with any rejection details. Requires `catalog:read`.
+  
+  Poll after `POST /api/v1/products/{productId}/publish`.
+     *
+     * `GET /api/v1/products/{productId}/listings`
+     */
+  getListings(request, requestOptions) {
+    const { productId, organizationId } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: `/api/v1/products/${encodePathParam("productId", productId)}/listings`,
+      query: { organizationId },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
   /**
      * Update Product Price
      *
@@ -2039,6 +2371,108 @@ var ReturnsClient = class {
     });
   }
 };
+var ReviewsClient = class {
+  constructor(_http) {
+    this._http = _http;
+  }
+  _http;
+  /**
+     * List Reviews
+     *
+     * List marketplace product reviews, newest first unless `sortBy` says otherwise. Requires `reviews:read`.
+  
+  Use `priority=unreplied` for a reply queue. `replyRestriction` is null when a reply will be accepted.
+     *
+     * `GET /api/v1/reviews`
+     */
+  list(request = {}, requestOptions) {
+    const {
+      organizationId,
+      q,
+      marketplace,
+      status,
+      priority,
+      store,
+      productId,
+      sortBy,
+      limit,
+      offset
+    } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: "/api/v1/reviews",
+      query: {
+        organizationId,
+        q,
+        marketplace,
+        status,
+        priority,
+        store,
+        productId,
+        sortBy,
+        limit,
+        offset
+      },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+   * Get Review
+   *
+   * Read one review by its OmniCommerce UUID. Requires `reviews:read`.
+   *
+   * `GET /api/v1/reviews/{reviewId}`
+   */
+  get(request, requestOptions) {
+    const { reviewId, organizationId } = request ?? {};
+    return this._http.request({
+      method: "GET",
+      path: `/api/v1/reviews/${encodePathParam("reviewId", reviewId)}`,
+      query: { organizationId },
+      body: void 0,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Draft Review Reply
+     *
+     * Draft a reply with AI from the review, the product, recent replies, and the brand kit. Uses AI credits. Requires `reviews:write`.
+  
+  Nothing is posted; send the text with `POST /api/v1/reviews/actions`.
+     *
+     * `POST /api/v1/reviews/{reviewId}/draft-reply`
+     */
+  draftReply(request, requestOptions) {
+    const { reviewId, organizationId, ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: `/api/v1/reviews/${encodePathParam("reviewId", reviewId)}/draft-reply`,
+      query: { organizationId },
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+  /**
+     * Act on Reviews
+     *
+     * Reply to up to 50 reviews, or send Amazon review requests for solicitation rows. Requires `reviews:write`.
+  
+  Each target succeeds or fails on its own; read `data.results`. `ok` is true only when every target succeeds.
+     *
+     * `POST /api/v1/reviews/actions`
+     */
+  actions(request, requestOptions) {
+    const { ...body } = request ?? {};
+    return this._http.request({
+      method: "POST",
+      path: "/api/v1/reviews/actions",
+      query: void 0,
+      body,
+      ...mergeRequestOptions(requestOptions)
+    });
+  }
+};
 var SearchClient = class {
   constructor(_http) {
     this._http = _http;
@@ -2537,8 +2971,11 @@ var ZaloraClient = class {
 var OmniGeneratedClient = class {
   constructor(_http) {
     this._http = _http;
+    this.agents = new AgentsClient(this._http);
+    this.analytics = new AnalyticsClient(this._http);
     this.aop = new AopClient(this._http);
     this.api = new ApiClient(this._http);
+    this.campaigns = new CampaignsClient(this._http);
     this.catalog = new CatalogClient(this._http);
     this.checkoutSessions = new CheckoutSessionsClient(this._http);
     this.compare = new CompareClient(this._http);
@@ -2559,6 +2996,7 @@ var OmniGeneratedClient = class {
     this.products = new ProductsClient(this._http);
     this.promotions = new PromotionsClient(this._http);
     this.returns = new ReturnsClient(this._http);
+    this.reviews = new ReviewsClient(this._http);
     this.search = new SearchClient(this._http);
     this.settlements = new SettlementsClient(this._http);
     this.sync = new SyncClient(this._http);
@@ -2569,8 +3007,11 @@ var OmniGeneratedClient = class {
     this.zalora = new ZaloraClient(this._http);
   }
   _http;
+  agents;
+  analytics;
   aop;
   api;
+  campaigns;
   catalog;
   checkoutSessions;
   compare;
@@ -2591,6 +3032,7 @@ var OmniGeneratedClient = class {
   products;
   promotions;
   returns;
+  reviews;
   search;
   settlements;
   sync;