@delopay/sdk 0.162.0 → 0.163.0

package/dist/index.cjs

@@ -67,6 +67,7 @@ __export(index_exports, {
   DelopayAuthenticationError: () => DelopayAuthenticationError,
   DelopayError: () => DelopayError,
   Export: () => Export,
+  ExternalRecords: () => ExternalRecords,
   FeatureMatrix: () => FeatureMatrix,
   FeeProgramBuilder: () => FeeProgramBuilder,
   Files: () => Files,
@@ -91,6 +92,7 @@ __export(index_exports, {
   PAYPAL_LABEL_STYLES: () => PAYPAL_LABEL_STYLES,
   PaypalDisputes: () => PaypalDisputes,
   ProcessorCosts: () => ProcessorCosts,
+  Products: () => Products,
   RTL_CHECKOUT_LOCALES: () => RTL_CHECKOUT_LOCALES,
   Regions: () => Regions,
   Risk: () => Risk,
@@ -4669,6 +4671,142 @@ var CostRules = class {
   }
 };
 
+// src/resources/externalRecords.ts
+var ExternalRecords = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /**
+   * Record one out-of-band transition.
+   * `POST /external-records`
+   *
+   * Which kinds a deployment answers for depends on the payment's connector
+   * and on which arms are live: an arm that is not served answers `501`, which
+   * is a statement about this rail rather than about the request.
+   *
+   * @param params - What happened, and why it is being recorded.
+   */
+  async create(params) {
+    return this.request("POST", "/external-records", { body: params });
+  }
+};
+
+// src/resources/products.ts
+var Products = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /** The shop scope every route here takes, as the backend expects it. */
+  scoped(profileId, options) {
+    return { ...options, headers: { "X-Profile-Id": profileId, ...options?.headers } };
+  }
+  /**
+   * Create a product together with its prices.
+   * `POST /products`
+   *
+   * @param params - The product, with at least one price.
+   * @param profileId - The shop the product belongs to.
+   */
+  async create(params, profileId, options) {
+    return this.request("POST", "/products", {
+      body: params,
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * One page of the shop's catalogue.
+   * `GET /products/list`
+   *
+   * Archived products are returned too unless `status` narrows them away —
+   * they are what past charges refer to.
+   */
+  async list(params, profileId, options) {
+    return this.request("GET", "/products/list", {
+      query: params === void 0 ? void 0 : { ...params },
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Retrieve one product with its prices.
+   * `GET /products/{product_id}`
+   */
+  async retrieve(productId, profileId, options) {
+    return this.request("GET", `/products/${encodeURIComponent(productId)}`, {
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Change a product's name, description or metadata.
+   * `POST /products/{product_id}`
+   *
+   * Its kind and its prices are not editable here — see the class note.
+   */
+  async update(productId, params, profileId, options) {
+    return this.request("POST", `/products/${encodeURIComponent(productId)}`, {
+      body: params,
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Take a product off sale.
+   * `POST /products/{product_id}/archive`
+   *
+   * It stays readable and keeps its prices: a payment made against it has to
+   * remain explicable after it is withdrawn.
+   */
+  async archive(productId, profileId, options) {
+    return this.request("POST", `/products/${encodeURIComponent(productId)}/archive`, {
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Put an archived product back on sale.
+   * `POST /products/{product_id}/restore`
+   */
+  async restore(productId, profileId, options) {
+    return this.request("POST", `/products/${encodeURIComponent(productId)}/restore`, {
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Add a price to an existing product.
+   * `POST /products/{product_id}/prices`
+   *
+   * This is how a price changes: the new figure is added and the old price is
+   * archived, so both remain readable.
+   */
+  async addPrice(productId, params, profileId, options) {
+    return this.request("POST", `/products/${encodeURIComponent(productId)}/prices`, {
+      body: params,
+      ...this.scoped(profileId, options)
+    });
+  }
+  /**
+   * Change a price's label, its default flag or its metadata.
+   * `POST /products/{product_id}/prices/{price_id}`
+   *
+   * Not its amount, its currency or its interval: see the class note.
+   */
+  async updatePrice(productId, priceId, params, profileId, options) {
+    return this.request(
+      "POST",
+      `/products/${encodeURIComponent(productId)}/prices/${encodeURIComponent(priceId)}`,
+      { body: params, ...this.scoped(profileId, options) }
+    );
+  }
+  /**
+   * Take one price off sale, leaving the product on it.
+   * `POST /products/{product_id}/prices/{price_id}/archive`
+   */
+  async archivePrice(productId, priceId, profileId, options) {
+    return this.request(
+      "POST",
+      `/products/${encodeURIComponent(productId)}/prices/${encodeURIComponent(priceId)}/archive`,
+      { ...this.scoped(profileId, options) }
+    );
+  }
+};
+
 // src/resources/processorCosts.ts
 var ProcessorCosts = class {
   constructor(request) {
@@ -5690,6 +5828,8 @@ var Delopay = class {
     this.availabilityOverrides = new AvailabilityOverrides(request);
     this.sellToRestrictions = new SellToRestrictions(request);
     this.costRules = new CostRules(request);
+    this.externalRecords = new ExternalRecords(request);
+    this.products = new Products(request);
     this.processorCosts = new ProcessorCosts(request);
     this.checkoutMethods = new CheckoutMethods(request);
     this.analytics = new Analytics(request);
@@ -9323,6 +9463,7 @@ var encodeNativePanes = encodePanes;
   DelopayAuthenticationError,
   DelopayError,
   Export,
+  ExternalRecords,
   FeatureMatrix,
   FeeProgramBuilder,
   Files,
@@ -9347,6 +9488,7 @@ var encodeNativePanes = encodePanes;
   PAYPAL_LABEL_STYLES,
   PaypalDisputes,
   ProcessorCosts,
+  Products,
   RTL_CHECKOUT_LOCALES,
   Regions,
   Risk,