@delopay/sdk 0.204.0 → 0.208.0

package/README.md

@@ -167,6 +167,22 @@ const payment = await delopay.payments.create({
 const sold = await delopay.payments.productLines(payment.payment_id);
 ```
 
+### Issue invoices
+
+```typescript
+// Invoices and credit notes in your name, from a paid payment or subscription
+// cycle. Amounts always come from the source.
+const invoice = await delopay.invoices.create(
+  { source: { payment_id: 'pay_abc123' }, finalize: true },
+  { headers: { 'Idempotency-Key': 'invoice-order-1001' } },
+);
+const pdf = await delopay.invoices.downloadPdf(invoice.id);
+
+// How they look and are taxed: the merchant default, or one shop's override.
+const current = await delopay.invoiceSettings.retrieveForShop('pro_abc123');
+await delopay.invoiceSettings.updateForShop('pro_abc123', { ...current, locale: 'de' });
+```
+
 ### Handle disputes
 
 ```typescript

package/dist/{chunk-KXLZ4RS7.js → chunk-B4ABMM47.js}

@@ -91,6 +91,29 @@ var ApiKeys = class {
       `/api-keys/${encodeURIComponent(merchantId)}/${encodeURIComponent(keyId)}`
     );
   }
+  /**
+   * Replace an API key's secret. The key keeps its id, name, scope, shop,
+   * origin rule, rate cap and expiry. The old secret stops working
+   * immediately, with no grace period, so deploy the new one as part of the
+   * same change. Refused with `IR_16` (HTTP 400) while the deployment runs
+   * partial authentication; create a new key and revoke the old one instead.
+   * `POST /api-keys/{merchantId}/{keyId}/rotate`
+   *
+   * @param merchantId - The merchant account ID.
+   * @param keyId - The API key ID to rotate.
+   * @returns The key with its new plaintext secret (shown once only).
+   *
+   * @example
+   * ```typescript
+   * const { api_key } = await delopay.apiKeys.rotate('merch_123', 'key_abc');
+   * ```
+   */
+  async rotate(merchantId, keyId) {
+    return this.request(
+      "POST",
+      `/api-keys/${encodeURIComponent(merchantId)}/${encodeURIComponent(keyId)}/rotate`
+    );
+  }
   /**
    * List all API keys for a merchant.
    *
@@ -185,6 +208,22 @@ var ApiKeys = class {
       `/account/${encodeURIComponent(merchantId)}/profile/api-keys/${encodeURIComponent(keyId)}`
     );
   }
+  /**
+   * Replace the secret of an API key pinned to the caller's shop. The key
+   * keeps its id, name, scope, origin rule, rate cap and expiry. The old
+   * secret stops working immediately, with no grace period.
+   * `POST /account/{merchantId}/profile/api-keys/{keyId}/rotate`
+   *
+   * @param merchantId - The merchant account ID.
+   * @param keyId - The API key ID to rotate.
+   * @returns The key with its new plaintext secret (shown once only).
+   */
+  async rotateByProfile(merchantId, keyId) {
+    return this.request(
+      "POST",
+      `/account/${encodeURIComponent(merchantId)}/profile/api-keys/${encodeURIComponent(keyId)}/rotate`
+    );
+  }
 };
 
 // src/resources/authentication.ts
@@ -4438,7 +4477,9 @@ var Analytics = class {
    * merchant, and to your single shop for profile-scoped users — so pass only
    * `project_id` / `shop_id` to drill and the window / `sections` fields.
    * Returns one drill level: the scope's daily series + previous window,
-   * processor mix and direct children. `GET /analytics/scope`
+   * processor mix and direct children. Accepts a dashboard session or an API
+   * key, including a `statistics_read` key; a shop-bound key reads only its
+   * shop. `GET /analytics/scope`
    */
   async scope(params) {
     return this.request("GET", "/analytics/scope", {
@@ -4451,8 +4492,8 @@ var Analytics = class {
    * channel mix, time-to-pay), pinned server-side to your own merchant and
    * drillable via `project_id` / `shop_id` exactly like `scope`. Gated on the
    * client-context optimisation-use switch: when it is off the server answers
-   * 200 with `enabled: false` and a caveat naming the switch.
-   * `GET /analytics/devices`
+   * 200 with `enabled: false` and a caveat naming the switch. Accepts an API
+   * key like `scope`. `GET /analytics/devices`
    */
   async devices(params) {
     return this.request("GET", "/analytics/devices", {
@@ -4464,7 +4505,7 @@ var Analytics = class {
    * country totals, city bubbles (IP mode), buyer languages, buyer-local
    * purchase hours and the IP-vs-billing mismatch share. `mode` selects the
    * location claim (`ip` default, `billing`); the two are never coalesced.
-   * Same drill, window and gating contract as `devices`.
+   * Same drill, window, gating and API-key contract as `devices`.
    * `GET /analytics/geo`
    */
   async geo(params) {
@@ -4531,7 +4572,8 @@ var Analytics = class {
    * Half the figures are **stocks** — a snapshot at the window's end rather
    * than a sum over it — so `est_monthly_volume_usd` and `active` can match
    * across a 7-day and a 30-day window while `billed_volume_usd` does not.
-   * Day granularity only. `GET /analytics/subscriptions`
+   * Day granularity only. Accepts an API key like `scope`.
+   * `GET /analytics/subscriptions`
    */
   async subscriptions(params) {
     return this.request("GET", "/analytics/subscriptions", {
@@ -5569,6 +5611,343 @@ var Products = class {
   }
 };
 
+// src/resources/invoices.ts
+var Invoices = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /**
+   * Create a draft from a paid payment or subscription cycle, and with
+   * `finalize: true` issue it in the same call.
+   * `POST /invoices`
+   *
+   * Send an `Idempotency-Key` header in `options.headers` to make this safe to
+   * retry: the same key and body return the document it created, in its
+   * current state, even after a lost response, and a different body under the
+   * same key answers 409. A retry of a `finalize: true` request whose draft
+   * was committed but not finalised finalises that draft.
+   */
+  async create(params, options) {
+    return this.request("POST", "/invoices", { body: params, ...options });
+  }
+  /**
+   * One page of documents, newest first. List rows carry no `lines` unless
+   * `include_lines` is set, and never a `refund` summary.
+   * `GET /invoices`
+   */
+  async list(params, options) {
+    return this.request("GET", "/invoices", {
+      query: params === void 0 ? void 0 : { ...params },
+      ...options
+    });
+  }
+  /**
+   * One page of a payment's invoice and its credit notes, lines included. The
+   * page also says whether a merchant of record sold the payment
+   * (`merchant_of_record`, which `create` then refuses) and what was refunded
+   * (`refunded_amount`, and `refund` on each invoice). Needs the payment read
+   * grant as well.
+   * `GET /payments/{payment_id}/invoices`
+   */
+  async listForPayment(paymentId, params, options) {
+    return this.request("GET", `/payments/${encodeURIComponent(paymentId)}/invoices`, {
+      query: params === void 0 ? void 0 : { ...params },
+      ...options
+    });
+  }
+  /**
+   * The documents with a line of one product; a bundle's components count,
+   * flagged `included`. Takes the list filters; the product is the path's.
+   * `GET /products/{product_id}/invoices`
+   */
+  async listForProduct(productId, params, options) {
+    return this.request("GET", `/products/${encodeURIComponent(productId)}/invoices`, {
+      query: params === void 0 ? void 0 : { ...params },
+      ...options
+    });
+  }
+  /**
+   * The documents of one period as CSV (`text/csv; charset=utf-8`), with the
+   * list's filters. Amounts are decimal in each document's currency; drafts
+   * have an empty number.
+   * `GET /invoices/export`
+   */
+  async export(params, options) {
+    return this.request("GET", "/invoices/export", {
+      query: { ...params },
+      responseType: "blob",
+      ...options
+    });
+  }
+  /**
+   * One document, lines included.
+   * `GET /invoices/{invoice_id}`
+   */
+  async retrieve(invoiceId, options) {
+    return this.request("GET", `/invoices/${encodeURIComponent(invoiceId)}`, { ...options });
+  }
+  /**
+   * Edit a draft: its words, buyer, dates and tax treatment, never what was
+   * paid. Absent fields stay; `null` clears a clearable one. A document that
+   * is not a draft is refused (`not_a_draft`).
+   * `PATCH /invoices/{invoice_id}`
+   */
+  async update(invoiceId, params, options) {
+    return this.request("PATCH", `/invoices/${encodeURIComponent(invoiceId)}`, {
+      body: params,
+      ...options
+    });
+  }
+  /**
+   * Delete a draft. A draft has no number, so nothing leaves a gap; an issued
+   * document is refused (`not_a_draft`) — void or credit it instead.
+   * `DELETE /invoices/{invoice_id}`
+   */
+  async delete(invoiceId, options) {
+    return this.request("DELETE", `/invoices/${encodeURIComponent(invoiceId)}`, { ...options });
+  }
+  /**
+   * Issue a draft: allocate its number, freeze it and store its PDF. It is
+   * immutable afterwards. A document that would be legally incomplete is
+   * refused with `IR_06` and a reason (`seller_tax_id_missing`,
+   * `line_tax_unexplained`, …) that says what to fix and where.
+   * `POST /invoices/{invoice_id}/finalize`
+   */
+  async finalize(invoiceId, options) {
+    return this.request("POST", `/invoices/${encodeURIComponent(invoiceId)}/finalize`, {
+      ...options
+    });
+  }
+  /**
+   * Withdraw an issued document with a reason; its number stays used. For a
+   * document that never reached the buyer — one they hold is corrected with
+   * `createCreditNote`. An invoice with live credit notes is refused
+   * (`has_credit_notes`).
+   * `POST /invoices/{invoice_id}/void`
+   */
+  async void(invoiceId, params, options) {
+    return this.request("POST", `/invoices/${encodeURIComponent(invoiceId)}/void`, {
+      body: params,
+      ...options
+    });
+  }
+  /**
+   * Correct an issued invoice with a credit note: all of what it has left, or
+   * the named lines. Returns the **credit note**, not the invoice.
+   * `POST /invoices/{invoice_id}/credit-note`
+   */
+  async createCreditNote(invoiceId, params, options) {
+    return this.request("POST", `/invoices/${encodeURIComponent(invoiceId)}/credit-note`, {
+      body: params,
+      ...options
+    });
+  }
+  /**
+   * The document as a PDF. An issued document is its stored copy; a draft
+   * renders live under a DRAFT banner, and a voided one under a VOIDED banner.
+   * `GET /invoices/{invoice_id}/pdf`
+   */
+  async downloadPdf(invoiceId, options) {
+    return this.request("GET", `/invoices/${encodeURIComponent(invoiceId)}/pdf`, {
+      responseType: "blob",
+      ...options
+    });
+  }
+  /**
+   * A public link to an issued document's stored PDF, valid for 7 days.
+   * **Anyone holding the link can open the document**, without logging in. A
+   * document that is not issued is refused (`not_issued`).
+   * `POST /invoices/{invoice_id}/share-link`
+   */
+  async createShareLink(invoiceId, options) {
+    return this.request("POST", `/invoices/${encodeURIComponent(invoiceId)}/share-link`, {
+      ...options
+    });
+  }
+};
+
+// src/resources/invoiceSettings.ts
+var InvoiceSettingsResource = class {
+  constructor(request) {
+    this.request = request;
+  }
+  // --- Settings -------------------------------------------------------------
+  /**
+   * The merchant default.
+   * `GET /invoice-settings`
+   */
+  async retrieve(options) {
+    return this.request("GET", "/invoice-settings", { ...options });
+  }
+  /**
+   * Replace the merchant default (every field but the logo).
+   * `PUT /invoice-settings`
+   */
+  async update(settings, options) {
+    return this.request("PUT", "/invoice-settings", { body: settings, ...options });
+  }
+  /**
+   * One shop's override. A `null` field inherits the merchant default.
+   * `GET /invoice-settings/profiles/{profile_id}`
+   */
+  async retrieveForShop(profileId, options) {
+    return this.request("GET", `/invoice-settings/profiles/${encodeURIComponent(profileId)}`, {
+      ...options
+    });
+  }
+  /**
+   * Replace one shop's override (every field but the logo).
+   * `PUT /invoice-settings/profiles/{profile_id}`
+   */
+  async updateForShop(profileId, settings, options) {
+    return this.request("PUT", `/invoice-settings/profiles/${encodeURIComponent(profileId)}`, {
+      body: settings,
+      ...options
+    });
+  }
+  /**
+   * The settings a shop's next document is finalised with, and where each
+   * value came from (`shop`, `merchant` or `default`).
+   * `GET /invoice-settings/profiles/{profile_id}/effective`
+   */
+  async retrieveEffective(profileId, options) {
+    return this.request(
+      "GET",
+      `/invoice-settings/profiles/${encodeURIComponent(profileId)}/effective`,
+      { ...options }
+    );
+  }
+  /**
+   * A sample invoice PDF rendered from the effective settings with unsaved
+   * values laid over them, so a form can show what saving would produce.
+   * Writes nothing.
+   * `POST /invoice-settings/preview`
+   */
+  async preview(params, options) {
+    return this.request("POST", "/invoice-settings/preview", {
+      body: params,
+      responseType: "blob",
+      ...options
+    });
+  }
+  // --- Logo -----------------------------------------------------------------
+  /**
+   * The merchant default's logo image.
+   * `GET /invoice-settings/logo`
+   */
+  async retrieveLogo(options) {
+    return this.request("GET", "/invoice-settings/logo", { responseType: "blob", ...options });
+  }
+  /**
+   * Set the merchant default's logo: PNG or JPEG, at most 1 MB, as base64.
+   * `PUT /invoice-settings/logo`
+   */
+  async updateLogo(params, options) {
+    return this.request("PUT", "/invoice-settings/logo", { body: params, ...options });
+  }
+  /**
+   * Remove the merchant default's logo.
+   * `DELETE /invoice-settings/logo`
+   */
+  async deleteLogo(options) {
+    return this.request("DELETE", "/invoice-settings/logo", { ...options });
+  }
+  /**
+   * One shop's own logo image.
+   * `GET /invoice-settings/profiles/{profile_id}/logo`
+   */
+  async retrieveLogoForShop(profileId, options) {
+    return this.request("GET", `/invoice-settings/profiles/${encodeURIComponent(profileId)}/logo`, {
+      responseType: "blob",
+      ...options
+    });
+  }
+  /**
+   * Set one shop's own logo: PNG or JPEG, at most 1 MB, as base64.
+   * `PUT /invoice-settings/profiles/{profile_id}/logo`
+   */
+  async updateLogoForShop(profileId, params, options) {
+    return this.request("PUT", `/invoice-settings/profiles/${encodeURIComponent(profileId)}/logo`, {
+      body: params,
+      ...options
+    });
+  }
+  /**
+   * Remove one shop's own logo; the shop then inherits the merchant default's.
+   * `DELETE /invoice-settings/profiles/{profile_id}/logo`
+   */
+  async deleteLogoForShop(profileId, options) {
+    return this.request(
+      "DELETE",
+      `/invoice-settings/profiles/${encodeURIComponent(profileId)}/logo`,
+      { ...options }
+    );
+  }
+  // --- Tax rules ------------------------------------------------------------
+  /**
+   * The merchant's tax rules, which every shop without a list of its own uses.
+   * `GET /invoice-settings/tax-rules`
+   */
+  async retrieveTaxRules(options) {
+    return this.request("GET", "/invoice-settings/tax-rules", { ...options });
+  }
+  /**
+   * Replace the merchant's whole rule list; the order is the priority.
+   * `PUT /invoice-settings/tax-rules`
+   */
+  async updateTaxRules(params, options) {
+    return this.request("PUT", "/invoice-settings/tax-rules", { body: params, ...options });
+  }
+  /**
+   * The rules one shop uses: its own list, or the merchant's it inherits, as
+   * `own_rules` says.
+   * `GET /invoice-settings/profiles/{profile_id}/tax-rules`
+   */
+  async retrieveTaxRulesForShop(profileId, options) {
+    return this.request(
+      "GET",
+      `/invoice-settings/profiles/${encodeURIComponent(profileId)}/tax-rules`,
+      { ...options }
+    );
+  }
+  /**
+   * Give one shop a list of its own, replacing the merchant's for that shop —
+   * even when empty, which leaves every line of the shop to the settings'
+   * default rate.
+   * `PUT /invoice-settings/profiles/{profile_id}/tax-rules`
+   */
+  async updateTaxRulesForShop(profileId, params, options) {
+    return this.request(
+      "PUT",
+      `/invoice-settings/profiles/${encodeURIComponent(profileId)}/tax-rules`,
+      { body: params, ...options }
+    );
+  }
+  /**
+   * Drop one shop's own list, so it inherits the merchant's again. Returns
+   * the list the shop now uses.
+   * `DELETE /invoice-settings/profiles/{profile_id}/tax-rules`
+   */
+  async deleteTaxRulesForShop(profileId, options) {
+    return this.request(
+      "DELETE",
+      `/invoice-settings/profiles/${encodeURIComponent(profileId)}/tax-rules`,
+      { ...options }
+    );
+  }
+  /**
+   * Which saved rule a buyer and a product tax category would meet, and what
+   * the line would be taxed at. Writes nothing.
+   * `POST /invoice-settings/tax-rules/evaluate`
+   */
+  async evaluateTaxRules(params, options) {
+    return this.request("POST", "/invoice-settings/tax-rules/evaluate", {
+      body: params,
+      ...options
+    });
+  }
+};
+
 // src/resources/processorCosts.ts
 var ProcessorCosts = class {
   constructor(request) {
@@ -6841,6 +7220,54 @@ var ReplayRetention = class {
   }
 };
 
+// src/resources/settings.ts
+function projectQuery(query) {
+  return query.project_id ? { project_id: query.project_id } : {};
+}
+var Settings = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /**
+   * The merchant's settings, or one project's.
+   *
+   * `GET /settings/merchant`
+   */
+  async retrieveMerchant(query = {}) {
+    return this.request("GET", "/settings/merchant", { query: projectQuery(query) });
+  }
+  /**
+   * Change the merchant's own settings, or one project's. All changes are
+   * applied or none is.
+   *
+   * `PATCH /settings/merchant`
+   */
+  async updateMerchant(params, query = {}) {
+    return this.request("PATCH", "/settings/merchant", {
+      body: params,
+      query: projectQuery(query)
+    });
+  }
+  /**
+   * One shop's settings.
+   *
+   * `GET /settings/shops/{profileId}`
+   */
+  async retrieveShop(profileId) {
+    return this.request("GET", `/settings/shops/${encodeURIComponent(profileId)}`);
+  }
+  /**
+   * Change one shop's own settings.
+   *
+   * `PATCH /settings/shops/{profileId}`
+   */
+  async updateShop(profileId, params) {
+    return this.request("PATCH", `/settings/shops/${encodeURIComponent(profileId)}`, {
+      body: params
+    });
+  }
+};
+
 // src/resources/risk.ts
 var Risk = class {
   constructor(request) {
@@ -7103,6 +7530,7 @@ var Delopay = class {
     this.settlement = new Settlement(request);
     this.operationLimits = new OperationLimits(request);
     this.replayRetention = new ReplayRetention(request);
+    this.settings = new Settings(request);
     this.risk = new Risk(request);
     this.subscriptions = new Subscriptions(request);
     this.buyerPortal = new BuyerPortal(request);
@@ -7115,6 +7543,8 @@ var Delopay = class {
     this.costRules = new CostRules(request);
     this.externalRecords = new ExternalRecords(request);
     this.products = new Products(request);
+    this.invoices = new Invoices(request);
+    this.invoiceSettings = new InvoiceSettingsResource(request);
     this.processorCosts = new ProcessorCosts(request);
     this.checkoutBrowserInfo = new CheckoutBrowserInfo(request);
     this.checkoutMethods = new CheckoutMethods(request);
@@ -11115,6 +11545,8 @@ export {
   CostRules,
   ExternalRecords,
   Products,
+  Invoices,
+  InvoiceSettingsResource,
   ProcessorCosts,
   CheckoutMethods,
   Subscriptions,
@@ -11122,6 +11554,7 @@ export {
   Settlement,
   OperationLimits,
   ReplayRetention,
+  Settings,
   Risk,
   Delopay,
   leaf,
@@ -11313,4 +11746,4 @@ export {
   decodeNativePanes,
   encodeNativePanes
 };
-//# sourceMappingURL=chunk-KXLZ4RS7.js.map
+//# sourceMappingURL=chunk-B4ABMM47.js.map