@delopay/sdk 0.192.0 → 0.193.0

package/dist/index.cjs

@@ -4113,6 +4113,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 +4135,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 +4252,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 +4282,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 +4293,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 +4347,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");