@delopay/sdk 0.190.0 → 0.193.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3073,6 +3073,12 @@ var Routing = class {
3073
3073
  * Every account named must belong to this shop; one that does not is refused.
3074
3074
  * So is an amount cap without a `currency`, and a payment cap with one.
3075
3075
  *
3076
+ * An account may appear twice — a payment count and a budget — and never
3077
+ * twice in one `unit`. Re-send a range with its `limit_max`, or it is stored
3078
+ * as its bottom. Never re-send `current_limit` as `set_current_limit`: the
3079
+ * value read belongs to the window it was read in, and pinning it into a
3080
+ * window that has since reset is a limit nobody chose.
3081
+ *
3076
3082
  * `PUT /routing/connector-caps/{profileId}`
3077
3083
  */
3078
3084
  async setConnectorCaps(profileId, params) {
@@ -3865,6 +3871,15 @@ var Users = class {
3865
3871
  async listProfiles() {
3866
3872
  return this.request("GET", "/user/list/profile");
3867
3873
  }
3874
+ /**
3875
+ * Invite team members by email. `POST /user/employees/invite`
3876
+ *
3877
+ * `project_ids` grants a shop-level role on every shop of each project, once
3878
+ * the invitation is accepted. A refusal of `project_ids` is a `UR_23` error whose `data.reason` is one of
3879
+ * `project_not_in_merchant`, `role_not_grantable_on_project`,
3880
+ * `shop_in_granted_project`, `project_already_granted` or
3881
+ * `project_grant_requires_merchant_level`.
3882
+ */
3868
3883
  async inviteUsers(params) {
3869
3884
  return this.request("POST", "/user/employees/invite", { body: params });
3870
3885
  }
@@ -3878,7 +3893,11 @@ var Users = class {
3878
3893
  * not echoed back. Either way the member must change it on first sign-in.
3879
3894
  *
3880
3895
  * Same role rules as invite: you cannot grant a role above your own, and a
3881
- * shop-scoped caller can only target their own shop.
3896
+ * shop-scoped caller can only target their own shop. `project_ids` grants a
3897
+ * 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
3898
+ * `project_not_in_merchant`, `role_not_grantable_on_project`,
3899
+ * `shop_in_granted_project`, `project_already_granted` or
3900
+ * `project_grant_requires_merchant_level`.
3882
3901
  */
3883
3902
  async addUser(params) {
3884
3903
  return this.request("POST", "/user/employees/add", { body: params });
@@ -3991,6 +4010,12 @@ var Users = class {
3991
4010
  query: { groups: params.groups, entity_type: params.entity_type }
3992
4011
  });
3993
4012
  }
4013
+ /**
4014
+ * The roles a member holds, one entry per role. `POST /user/employees`
4015
+ *
4016
+ * A project-level role carries `project`: it applies to every shop of that
4017
+ * project.
4018
+ */
3994
4019
  async listUserRoles(params) {
3995
4020
  return this.request("POST", "/user/employees", { body: params });
3996
4021
  }
@@ -4015,7 +4040,9 @@ var Users = class {
4015
4040
  * Remove a team member. `DELETE /user/employees/delete`
4016
4041
  *
4017
4042
  * Pass `profile_id` to name the shop when managing a shop's team as a
4018
- * merchant-scoped admin — see {@link DeleteUserRoleRequest.profile_id}.
4043
+ * merchant-scoped admin — see {@link DeleteUserRoleRequest.profile_id}. Pass
4044
+ * `project_id` instead to remove a project-level role, which the member then
4045
+ * loses on every shop of the project.
4019
4046
  */
4020
4047
  async deleteUserRole(params) {
4021
4048
  return this.request("DELETE", "/user/employees/delete", { body: params });
@@ -4024,16 +4051,48 @@ var Users = class {
4024
4051
  * Move a team member between a merchant-level role and shop-level roles.
4025
4052
  * `POST /user/employees/change-scope`
4026
4053
  *
4027
- * A merchant-level `role_id` takes no `profile_ids`; a shop-level one needs
4028
- * at least one. Every earlier merchant- and shop-level binding of the member
4029
- * in your merchant is replaced. When the change takes a scope away, the
4054
+ * A merchant-level `role_id` takes no `profile_ids` or `project_ids`; a
4055
+ * shop-level one needs at least one shop or project. A project grants the
4056
+ * role on every shop of the project, including shops added later. Every
4057
+ * earlier merchant-, project- and shop-level binding of the member in your
4058
+ * merchant is replaced. When the change takes a scope away, the
4030
4059
  * member's sessions end (`sessions_revoked: true`). Needs a caller at
4031
4060
  * merchant level or above. A refusal is a `UR_23` error whose `data.reason`
4032
- * names the rule; an unknown `role_id` is `UR_22`.
4061
+ * names the rule; an unknown `role_id` is `UR_22`. The project rules add the
4062
+ * reasons `project_not_in_merchant`, `role_not_grantable_on_project`,
4063
+ * `shop_in_granted_project`, `project_already_granted` and
4064
+ * `project_grant_requires_merchant_level`.
4033
4065
  */
4034
4066
  async changeMemberScope(params) {
4035
4067
  return this.request("POST", "/user/employees/change-scope", { body: params });
4036
4068
  }
4069
+ /**
4070
+ * One member of your merchant, with the person fields the member list
4071
+ * omits. `GET /user/employees/{user_id}/details`
4072
+ *
4073
+ * Answers only for a member `listUsersInLineage` shows you. Any other id,
4074
+ * unknown or not yours, is a 404 `UR_68` with `data.reason:
4075
+ * 'member_not_found'`.
4076
+ */
4077
+ async getTeamMemberDetails(userId) {
4078
+ return this.request("GET", `/user/employees/${encodeURIComponent(userId)}/details`);
4079
+ }
4080
+ /**
4081
+ * Replace a team member's password with a temporary one, returned once.
4082
+ * `POST /user/employees/{user_id}/reset-password`
4083
+ *
4084
+ * Needs the *Users* write permission and the *Impersonation* permission,
4085
+ * and the member must be one you could sign in as with
4086
+ * `impersonateEmployee`. The member's sessions end, and their next sign-in
4087
+ * asks them to choose a new password. Two-factor authentication is left as
4088
+ * it is. `TeamMemberDetails.can_reset_password` answers the same rule. A
4089
+ * refusal is a `UR_68` error whose `data` is a {@link TeamMemberRefusal}.
4090
+ */
4091
+ async resetTeamMemberPassword(userId, params) {
4092
+ return this.request("POST", `/user/employees/${encodeURIComponent(userId)}/reset-password`, {
4093
+ body: params
4094
+ });
4095
+ }
4037
4096
  /** Sign in via OIDC. `POST /user/oidc` */
4038
4097
  async signInOidc(params) {
4039
4098
  return this.request("POST", "/user/oidc", { body: params });
@@ -4046,7 +4105,8 @@ var Users = class {
4046
4105
  * Invitations still waiting on the caller. `GET /user/list/invitation`
4047
4106
  *
4048
4107
  * Accepts an `accept_invite` step token as well as a session JWT, so it
4049
- * can feed `acceptInvitationsPreAuth` during sign-in.
4108
+ * can feed `acceptInvitationsPreAuth` during sign-in. An invitation to a
4109
+ * project carries `project_id`; pass it back unchanged when accepting.
4050
4110
  */
4051
4111
  async listInvitations() {
4052
4112
  return this.request("GET", "/user/list/invitation");
@@ -11065,4 +11125,4 @@ export {
11065
11125
  decodeNativePanes,
11066
11126
  encodeNativePanes
11067
11127
  };
11068
- //# sourceMappingURL=chunk-YNJUCISZ.js.map
11128
+ //# sourceMappingURL=chunk-72DLUJCI.js.map