@delopay/sdk 0.192.0 → 0.198.0

package/dist/index.cjs

@@ -3900,6 +3900,31 @@ var Users = class {
   async signIn(params) {
     return this.request("POST", "/user/signin", { body: params });
   }
+  /** Providers currently configured for dashboard sign-in. */
+  async listOAuthProviders() {
+    return this.request("GET", "/user/oauth/providers");
+  }
+  /** Current account's links; disabled providers remain visible. */
+  async listLinkedOAuthProviders() {
+    return this.request("GET", "/user/oauth/linked");
+  }
+  async startOAuthSignIn(params) {
+    return this.request("POST", "/user/oauth/start", { body: params });
+  }
+  async startOAuthLink(params) {
+    return this.request("POST", "/user/oauth/link/start", { body: params });
+  }
+  async completeOAuthSignIn(params) {
+    return this.request("POST", "/user/oauth/complete", { body: params });
+  }
+  async completeOAuthLink(params) {
+    return this.request("POST", "/user/oauth/link/complete", { body: params });
+  }
+  async disconnectOAuthProvider(provider, params) {
+    return this.request("DELETE", `/user/oauth/linked/${encodeURIComponent(provider)}`, {
+      body: params
+    });
+  }
   async signOut() {
     return this.request("POST", "/user/signout");
   }
@@ -4113,6 +4138,15 @@ var Users = class {
   async listProfiles() {
     return this.request("GET", "/user/list/profile");
   }
+  /**
+   * Invite team members by email. `POST /user/employees/invite`
+   *
+   * `project_ids` grants a shop-level role on every shop of each project, once
+   * the invitation is accepted. A refusal of `project_ids` is a `UR_23` error whose `data.reason` is one of
+   * `project_not_in_merchant`, `role_not_grantable_on_project`,
+   * `shop_in_granted_project`, `project_already_granted` or
+   * `project_grant_requires_merchant_level`.
+   */
   async inviteUsers(params) {
     return this.request("POST", "/user/employees/invite", { body: params });
   }
@@ -4126,7 +4160,11 @@ var Users = class {
    * not echoed back. Either way the member must change it on first sign-in.
    *
    * Same role rules as invite: you cannot grant a role above your own, and a
-   * shop-scoped caller can only target their own shop.
+   * shop-scoped caller can only target their own shop. `project_ids` grants a
+   * shop-level role on every shop of each project. A refusal of `project_ids` is a `UR_23` error whose `data.reason` is one of
+   * `project_not_in_merchant`, `role_not_grantable_on_project`,
+   * `shop_in_granted_project`, `project_already_granted` or
+   * `project_grant_requires_merchant_level`.
    */
   async addUser(params) {
     return this.request("POST", "/user/employees/add", { body: params });
@@ -4239,6 +4277,12 @@ var Users = class {
       query: { groups: params.groups, entity_type: params.entity_type }
     });
   }
+  /**
+   * The roles a member holds, one entry per role. `POST /user/employees`
+   *
+   * A project-level role carries `project`: it applies to every shop of that
+   * project.
+   */
   async listUserRoles(params) {
     return this.request("POST", "/user/employees", { body: params });
   }
@@ -4263,7 +4307,9 @@ var Users = class {
    * Remove a team member. `DELETE /user/employees/delete`
    *
    * Pass `profile_id` to name the shop when managing a shop's team as a
-   * merchant-scoped admin — see {@link DeleteUserRoleRequest.profile_id}.
+   * merchant-scoped admin — see {@link DeleteUserRoleRequest.profile_id}. Pass
+   * `project_id` instead to remove a project-level role, which the member then
+   * loses on every shop of the project.
    */
   async deleteUserRole(params) {
     return this.request("DELETE", "/user/employees/delete", { body: params });
@@ -4272,12 +4318,17 @@ var Users = class {
    * Move a team member between a merchant-level role and shop-level roles.
    * `POST /user/employees/change-scope`
    *
-   * A merchant-level `role_id` takes no `profile_ids`; a shop-level one needs
-   * at least one. Every earlier merchant- and shop-level binding of the member
-   * in your merchant is replaced. When the change takes a scope away, the
+   * A merchant-level `role_id` takes no `profile_ids` or `project_ids`; a
+   * shop-level one needs at least one shop or project. A project grants the
+   * role on every shop of the project, including shops added later. Every
+   * earlier merchant-, project- and shop-level binding of the member in your
+   * merchant is replaced. When the change takes a scope away, the
    * member's sessions end (`sessions_revoked: true`). Needs a caller at
    * merchant level or above. A refusal is a `UR_23` error whose `data.reason`
-   * names the rule; an unknown `role_id` is `UR_22`.
+   * names the rule; an unknown `role_id` is `UR_22`. The project rules add the
+   * reasons `project_not_in_merchant`, `role_not_grantable_on_project`,
+   * `shop_in_granted_project`, `project_already_granted` and
+   * `project_grant_requires_merchant_level`.
    */
   async changeMemberScope(params) {
     return this.request("POST", "/user/employees/change-scope", { body: params });
@@ -4321,7 +4372,8 @@ var Users = class {
    * Invitations still waiting on the caller. `GET /user/list/invitation`
    *
    * Accepts an `accept_invite` step token as well as a session JWT, so it
-   * can feed `acceptInvitationsPreAuth` during sign-in.
+   * can feed `acceptInvitationsPreAuth` during sign-in. An invitation to a
+   * project carries `project_id`; pass it back unchanged when accepting.
    */
   async listInvitations() {
     return this.request("GET", "/user/list/invitation");
@@ -5951,7 +6003,13 @@ var Subscriptions = class {
       ...options
     });
   }
-  /** Update a subscription's plan/price. `PUT /subscriptions/{subscriptionId}/update` */
+  /**
+   * Update a subscription's plan/price. `PUT /subscriptions/{subscriptionId}/update`
+   *
+   * From the dashboard this counts against the caller's `subscription_change`
+   * operation limit; an over-limit call fails with `DE_01` and nothing reaches
+   * the processor. Calls made with an API key are not limited.
+   */
   async update(subscriptionId, params, options) {
     return this.request("PUT", `/subscriptions/${encodeURIComponent(subscriptionId)}/update`, {
       body: params,
@@ -6007,6 +6065,10 @@ var Subscriptions = class {
   /**
    * Pause a subscription. `POST /subscriptions/{subscriptionId}/pause`
    *
+   * From the dashboard this counts against the caller's `subscription_change`
+   * operation limit; an over-limit call fails with `DE_01` and nothing reaches
+   * the processor. Calls made with an API key are not limited.
+   *
    * The body defaults to `{}` so the request still carries
    * `Content-Type: application/json` even when no params are passed — the
    * backend rejects the POST otherwise ("Unsupported content type").
@@ -6017,7 +6079,13 @@ var Subscriptions = class {
       ...options
     });
   }
-  /** Resume a paused subscription. `POST /subscriptions/{subscriptionId}/resume` */
+  /**
+   * Resume a paused subscription. `POST /subscriptions/{subscriptionId}/resume`
+   *
+   * From the dashboard this counts against the caller's `subscription_change`
+   * operation limit; an over-limit call fails with `DE_01` and nothing reaches
+   * the processor. Calls made with an API key are not limited.
+   */
   async resume(subscriptionId, params, options) {
     return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/resume`, {
       body: params ?? {},
@@ -6029,6 +6097,10 @@ var Subscriptions = class {
    *
    * A subscription in a state it cannot be cancelled from is refused with
    * `DE_11`; `error.data.reason` then names why (`SubscriptionActionRefusal`).
+   *
+   * From the dashboard this counts against the caller's `subscription_change`
+   * operation limit; an over-limit call fails with `DE_01` and nothing reaches
+   * the processor. Calls made with an API key are not limited.
    */
   async cancel(subscriptionId, params, options) {
     return this.request("POST", `/subscriptions/${encodeURIComponent(subscriptionId)}/cancel`, {
@@ -6533,10 +6605,13 @@ var Settlement = class {
    * Add a manual adjustment to a statement. Positive `amount_usd` charges
    * the shop (reducing their payout); negative credits them.
    *
-   * Subject to the caller's `settlement_adjustment` operation limit (amount
-   * dimensions only): an over-limit call fails with `DE_01` and no adjustment
-   * is added. A settlement rule can only block — approval is refund-only, for
-   * the reason given on `updateStatementPayout()`.
+   * Subject to the caller's `settlement_adjustment` operation limit: an
+   * over-limit call fails with `DE_01` and no adjustment is added. Both
+   * windows count every add, and a credit counts at its magnitude. A
+   * settlement rule can only block — approval is refund-only, for the reason
+   * given on `updateStatementPayout()`. When another add by the same user
+   * changes the window while this one is being admitted, the call fails with
+   * HTTP 412 and nothing is written; retrying the same request is safe.
    *
    * `POST /settlement/statements/{statementId}/adjustments`
    */
@@ -6550,6 +6625,10 @@ var Settlement = class {
   /**
    * Remove a manual adjustment from a statement.
    *
+   * The adjustment still counts against the caller's `settlement_adjustment`
+   * limit window it was added in: removing it does not give back its count or
+   * amount.
+   *
    * `DELETE /settlement/statements/{statementId}/adjustments/{adjustmentId}`
    */
   async deleteStatementAdjustment(statementId, adjustmentId, options) {