@camunda/ccma-api 3.1.0 → 5.0.0

package/dist/services/control/control.approvals.service.d.ts

@@ -100,6 +100,52 @@ export interface SendToExpiredTrialPayloadDto {
     orgId: string;
     orgName?: string;
 }
+export interface CreatePersonalOrganisationPayloadDto {
+    /** 3 to 100 characters, after the spaces at both ends are cut. */
+    name: string;
+}
+/**
+ * The create call of `create-personal-organisation`.
+ *
+ * It has no `requiredAcks`: the request needs no approval, and the route
+ * answers 400 to a body that names the field.
+ */
+export interface CreatePersonalOrganisationRequest extends RequestBaseParams {
+    params: {
+        payload: CreatePersonalOrganisationPayloadDto;
+        reason?: string;
+    };
+}
+export interface CreateCustomerHardwareSizingPayloadDto {
+    /** The organization that gets the plan. The requester must own it. */
+    orgId: string;
+    /** 3 to 100 characters, after the spaces at both ends are cut. */
+    name: string;
+    /** The cluster plan, in the same format as the plan route of the admin tool. */
+    plan: Record<string, unknown>;
+}
+/**
+ * `unlink` removes the plan from one organization that the requester owns.
+ * `delete` removes it from every organization of the requester, and deletes it.
+ */
+export type RemoveCustomerHardwareSizingPayloadDto = {
+    mode: 'unlink';
+    clusterPlanId: string;
+    orgId: string;
+} | {
+    mode: 'delete';
+    clusterPlanId: string;
+};
+/**
+ * The create call of a customer hardware sizing use case. Like
+ * `CreatePersonalOrganisationRequest`, it has no `requiredAcks`.
+ */
+export interface CustomerHardwareSizingRequest<TPayload> extends RequestBaseParams {
+    params: {
+        payload: TPayload;
+        reason?: string;
+    };
+}
 export interface ExtendTrialPayloadDto {
     orgId: string;
     orgName?: string;
@@ -121,6 +167,232 @@ export interface MoveClusterOrgPayloadDto {
     /** A copy, for the same reason as `clusterName`. */
     targetOrgName?: string;
 }
+export interface ChangePlatformRolesPayloadDto {
+    userId: string;
+    /** A copy, so a list shows a person and not an Auth0 id. Nothing reads it. */
+    userEmail?: string;
+    /**
+     * A CHANGE, and never the whole set. Accounts applies it over the roles that
+     * the user holds when the action RUNS, so a role change that somebody else
+     * made while the request waited stays.
+     */
+    rolesToAdd: string[];
+    rolesToRemove: string[];
+}
+export interface ChangeOrgLimitsPayloadDto {
+    orgId: string;
+    /** A copy, so a list shows a name that a person knows. Nothing reads it. */
+    orgName?: string;
+    /** One key of `allSalesPlanLimits()`. One limit for each request. */
+    limitKey: string;
+    /**
+     * The override that the person who asked READ. Absent for "not set".
+     *
+     * Accounts compares it with the override that it holds when the action
+     * runs, and writes nothing when the two differ. See `staleApprovalKeys`.
+     */
+    expected?: string | number | boolean;
+    /** The new override. `null` clears it, and the default of the plan applies. */
+    value: string | number | boolean | null;
+}
+export interface ChangeClusterPlanTypePayloadDto {
+    clusterId: string;
+    /** A copy, so a list shows a name that a person knows. Nothing reads it. */
+    clusterName?: string;
+    /** The organization that owns the cluster. Console refuses another one. */
+    orgId: string;
+    /** A copy, for the same reason as `clusterName`. */
+    orgName?: string;
+    toPlanTypeUuid: string;
+    /** A copy of the name of the new plan type, for the approver to read. */
+    toPlanTypeName?: string;
+    /**
+     * The hardware packages of the cluster after the change, 1 at least.
+     *
+     * Always sent, also for a plan type with no availability class, where it is
+     * 1. Console checks the reservations of the organization only when the
+     * packages are in the call, and the check is the point of this use case.
+     */
+    numberOfAllocatedHwPackages: number;
+    /**
+     * The plan type that the person who asked READ.
+     *
+     * Console compares it with the plan type of the cluster when the action
+     * runs, and changes nothing when the two differ.
+     */
+    expectedPlanTypeUuid: string;
+    /** A copy of the name of the current plan type, for the approver to read. */
+    expectedPlanTypeName?: string;
+    /**
+     * The hardware packages that the person who asked READ, 1 for a cluster
+     * that holds none. The same stale guard as `expectedPlanTypeUuid`.
+     */
+    expectedNumberOfAllocatedHwPackages: number;
+    /**
+     * The cluster plan that the person who asked READ. Console decides the
+     * plan move from it, so it is part of the stale guard too, and Console
+     * refuses a cluster that runs none, so a request needs one.
+     */
+    expectedClusterPlanUuid: string;
+    /** A copy of the name of that plan, for the approver to read. */
+    expectedClusterPlanName?: string;
+    /**
+     * The active modification config that the person who asked READ, absent
+     * when the cluster has none. The change removes it, and an approver must
+     * read which one goes.
+     */
+    expectedActiveModificationConfigUuid?: string;
+    /**
+     * The active plan of the NEW plan type that the person who asked READ. The
+     * cluster moves to it, so a plan that a Camundi changed on the type while
+     * the request waited fails the guard, and Console refuses a type that has
+     * none, so a request needs one.
+     */
+    expectedTargetPlanUuid: string;
+    /** A copy of the name of that plan, for the approver to read. */
+    expectedTargetPlanName?: string;
+    /**
+     * Whether the cluster plan moves to the active plan of the new type, as
+     * the dialog read it. The list of migratable plans can change while the
+     * request waits, and a verdict that moved changes whether the cluster
+     * restarts, so Console refuses a request whose verdict moved.
+     */
+    expectedClusterPlanUpdate: boolean;
+}
+export interface ChangeSalesPlanPayloadDto {
+    orgId: string;
+    /** A copy, so a list shows a name that a person knows. Nothing reads it. */
+    orgName?: string;
+    salesPlanId: string;
+    /** A copy of the name of the new plan, for the approver to read. */
+    salesPlanName?: string;
+    /**
+     * The plan that the person who asked READ. Absent for "no plan".
+     *
+     * Accounts compares it with the plan that it holds when the action runs,
+     * and switches nothing when the two differ.
+     */
+    expectedSalesPlanId?: string;
+    /** A copy of the name of the current plan, for the approver to read. */
+    expectedSalesPlanName?: string;
+    /** Skips the validation of the switch. The approver sees it. */
+    force: boolean;
+}
+/** Every value of a flag row that a person can change. */
+export interface FeatureFlagValuesDto {
+    description: string;
+    enabled: boolean;
+    orgIds: string[];
+    emailDomains: string[];
+    /** The team that owns the flag. A create needs it. An older row has none. */
+    owner?: string;
+    /** `YYYY-MM-DD`, the day after which the flag is late. */
+    expiresAt?: string;
+    /**
+     * The issue that tracks the flag. A create and an edit need it. An older
+     * row has none.
+     */
+    issueUrl?: string;
+}
+/**
+ * One change of the feature flag table: the action, and the whole row that it
+ * asks for.
+ *
+ * An edit and a delete carry the row that the person who asked READ, as
+ * `expected`. The action writes nothing when the row changed in the meantime.
+ * `key` of an edit and a delete is a copy for the approver, and the action
+ * compares it too.
+ */
+export type ChangeFeatureFlagPayloadDto = {
+    action: 'create';
+    key: string;
+    value: FeatureFlagValuesDto & {
+        owner: string;
+        issueUrl: string;
+    };
+} | {
+    action: 'update';
+    id: string;
+    key: string;
+    expected: FeatureFlagValuesDto;
+    value: FeatureFlagValuesDto & {
+        issueUrl: string;
+    };
+} | {
+    action: 'delete';
+    id: string;
+    key: string;
+    expected: FeatureFlagValuesDto;
+};
+export interface DeleteSsoConnectionPayloadDto {
+    strategy: 'waad' | 'samlp';
+    connectionId: string;
+    /** A copy, so a list shows a name that a person knows. Nothing reads it. */
+    connectionName?: string;
+    /**
+     * The organizations that the connection serves, as copies for the approver.
+     * The request is findable on the page of each one.
+     */
+    orgIds?: string[];
+}
+export interface DeleteOrganizationPayloadDto {
+    orgId: string;
+    /**
+     * The name that the approvers read. Accounts refuses the deletion when the
+     * organization has another name when the action runs.
+     */
+    orgName: string;
+}
+export interface DeleteUserPayloadDto {
+    userId: string;
+    /**
+     * The address that the approvers read. Accounts refuses the deletion when
+     * the user has another address when the action runs.
+     */
+    userEmail: string;
+}
+export interface ChangeUserEmailPayloadDto {
+    userId: string;
+    /**
+     * The address that the person who asked READ. Accounts compares it with
+     * the address that the user has when the action runs, and changes nothing
+     * when the two differ.
+     */
+    expectedEmail: string;
+    newEmail: string;
+}
+export interface PurgeUsersPayloadDto {
+    /**
+     * The users to delete, at most `PURGE_USERS_MAX_USERS`. The address is a
+     * copy for the approver, and accounts refuses a user whose address is not
+     * that copy. A list that came from a file of ids carries none.
+     */
+    users: {
+        userId: string;
+        email?: string;
+    }[];
+}
+export interface UpdateUserMetadataPayloadDto {
+    userId: string;
+    /** A copy, so a list shows a person and not an Auth0 id. Nothing reads it. */
+    userEmail?: string;
+    /** `app` writes `app_metadata`, `user` writes `user_metadata`. */
+    kind: 'app' | 'user';
+    /**
+     * The metadata that the person who asked READ. Absent for "not set".
+     * Accounts writes nothing when it holds another value when the action runs.
+     */
+    expected?: Record<string, unknown>;
+    metadata: Record<string, unknown>;
+}
+export interface DeleteInternalBackupPayloadDto {
+    clusterId: string;
+    /** A copy, so a list shows a name that a person knows. Nothing reads it. */
+    clusterName?: string;
+    backupName: string;
+    /** A copy of the Slack link of the incident, for the approver to read. */
+    incidentLink?: string;
+}
 export declare class ControlApprovalsService {
     /**
      * The registered privileged actions, with the rules that guard each one.
@@ -170,6 +442,140 @@ export declare class ControlApprovalsService {
         approval: ApprovalJobDto;
         created: boolean;
     }>;
+    /**
+     * Opens a change-platform-roles request.
+     *
+     * Opening one needs `accounts:admin:changeRole`, the same permission that
+     * approving needs, and the reason is necessary. A 200 means that a request
+     * for the same user is already open.
+     */
+    static createChangePlatformRoles(params: CreateApprovalRequest<ChangePlatformRolesPayloadDto>): Promise<{
+        approval: ApprovalJobDto;
+        created: boolean;
+    }>;
+    /**
+     * Opens a delete-internal-backup request.
+     *
+     * Opening one needs `console:clusters:canCreateInternalBackup`, the same
+     * permission that approving needs. A 200 means that a request for the same
+     * backup is already open.
+     */
+    static createDeleteInternalBackup(params: CreateApprovalRequest<DeleteInternalBackupPayloadDto>): Promise<{
+        approval: ApprovalJobDto;
+        created: boolean;
+    }>;
+    /**
+     * Opens a change-org-limits request.
+     *
+     * Opening one needs `accounts:admin:mayChangeOrgLimits`, the same
+     * permission that approving needs. A 200 means that a request for the same
+     * limit of the same organization is already open.
+     */
+    static createChangeOrgLimits(params: CreateApprovalRequest<ChangeOrgLimitsPayloadDto>): Promise<{
+        approval: ApprovalJobDto;
+        created: boolean;
+    }>;
+    /**
+     * Opens a delete-sso-connection request.
+     *
+     * Opening one needs `AccountsPermissions.ADMIN_AUTH0_CONNECTIONS_DELETE`, the same
+     * permission that approving needs. A 200 means that a request for the same
+     * connection is already open.
+     */
+    static createDeleteSsoConnection(params: CreateApprovalRequest<DeleteSsoConnectionPayloadDto>): Promise<{
+        approval: ApprovalJobDto;
+        created: boolean;
+    }>;
+    /**
+     * Opens a change-sales-plan request.
+     *
+     * Opening one needs `AccountsPermissions.SALES_PLAN_SWITCH`, the same
+     * permission that approving needs. A 200 means that a request for the same
+     * organization is already open.
+     */
+    static createChangeSalesPlan(params: CreateApprovalRequest<ChangeSalesPlanPayloadDto>): Promise<{
+        approval: ApprovalJobDto;
+        created: boolean;
+    }>;
+    /**
+     * Opens a change-cluster-plan-type request.
+     *
+     * Opening one needs `ConsolePermissions.CLUSTERS_CAN_UPDATE_CLUSTERPLANTYPE`,
+     * the same permission that approving needs. A 200 means that a request for
+     * the same cluster is already open. The route answers 404 while
+     * `control.changeClusterPlanType` is off.
+     */
+    static createChangeClusterPlanType(params: CreateApprovalRequest<ChangeClusterPlanTypePayloadDto>): Promise<{
+        approval: ApprovalJobDto;
+        created: boolean;
+    }>;
+    /**
+     * Opens a delete-organization request.
+     *
+     * Opening one needs `AccountsPermissions.DELETE_ORG`, the same permission
+     * that approving needs. A 200 means that a request for the same
+     * organization is already open.
+     */
+    static createDeleteOrganization(params: CreateApprovalRequest<DeleteOrganizationPayloadDto>): Promise<{
+        approval: ApprovalJobDto;
+        created: boolean;
+    }>;
+    /**
+     * Opens a delete-user request.
+     *
+     * Opening one needs `AccountsPermissions.DELETE_USER`, the same permission
+     * that approving needs. A 200 means that a request for the same user is
+     * already open.
+     */
+    static createDeleteUser(params: CreateApprovalRequest<DeleteUserPayloadDto>): Promise<{
+        approval: ApprovalJobDto;
+        created: boolean;
+    }>;
+    /**
+     * Opens a change-user-email request.
+     *
+     * Opening one needs `AccountsPermissions.ADMIN_CHANGE_EMAIL`, the same
+     * permission that approving needs. A 200 means that a request for the same
+     * user is already open.
+     */
+    static createChangeUserEmail(params: CreateApprovalRequest<ChangeUserEmailPayloadDto>): Promise<{
+        approval: ApprovalJobDto;
+        created: boolean;
+    }>;
+    /**
+     * Opens a purge-users request.
+     *
+     * Opening one needs `AccountsPermissions.GOD_PURGE_USERS` and
+     * `AccountsPermissions.DELETE_USER`, the same permissions that approving
+     * needs. A 200 means that a request for the same set of users is already
+     * open.
+     */
+    static createPurgeUsers(params: CreateApprovalRequest<PurgeUsersPayloadDto>): Promise<{
+        approval: ApprovalJobDto;
+        created: boolean;
+    }>;
+    /**
+     * Opens an update-user-metadata request.
+     *
+     * Opening one needs `AccountsPermissions.GOD_UPDATE_USER_METADATA`, the
+     * same permission that approving needs. A 200 means that a request for the
+     * same user and the same kind of metadata is already open.
+     */
+    static createUpdateUserMetadata(params: CreateApprovalRequest<UpdateUserMetadataPayloadDto>): Promise<{
+        approval: ApprovalJobDto;
+        created: boolean;
+    }>;
+    /**
+     * Opens a change-feature-flag request.
+     *
+     * Opening one needs `aafw`, the same permission that approving needs. A 200
+     * means that a request for the same flag is already open. On int this is
+     * the only way to change a flag.
+     */
+    static createChangeFeatureFlag(params: CreateApprovalRequest<ChangeFeatureFlagPayloadDto>): Promise<{
+        approval: ApprovalJobDto;
+        created: boolean;
+    }>;
     /** Adds the approval of the caller. The last one can run the action. */
     static acknowledge(params: ApprovalIdRequest): Promise<ApprovalJobDto>;
     /** Closes a request without running the action. The reason is necessary. */
@@ -199,6 +605,21 @@ export declare class ControlApprovalsService {
      * approving needs, and the reason is necessary.
      */
     static createExtendTrial(params: CreateApprovalRequest<ExtendTrialPayloadDto>): Promise<ApprovalJobDto>;
+    /**
+     * Opens a create-personal-organisation request. Any signed-in Camundi can.
+     *
+     * The request needs no approval, so the answer already holds the outcome,
+     * and the route answers 404 while `control.personalOrganisation` is off.
+     */
+    static createPersonalOrganisation(params: CreatePersonalOrganisationRequest): Promise<ApprovalJobDto>;
+    /**
+     * Opens a create-customer-hardware-sizing request. Any signed-in Camundi
+     * can. It runs on dev only, needs no approval, and the route answers 404
+     * while `control.customerHardwareSizing` is off.
+     */
+    static createCustomerHardwareSizing(params: CustomerHardwareSizingRequest<CreateCustomerHardwareSizingPayloadDto>): Promise<ApprovalJobDto>;
+    /** Opens a remove-customer-hardware-sizing request. See the one above. */
+    static removeCustomerHardwareSizing(params: CustomerHardwareSizingRequest<RemoveCustomerHardwareSizingPayloadDto>): Promise<ApprovalJobDto>;
     /**
      * The shared half of every call that answers one request.
      *

package/dist/services/control/control.approvals.service.js

@@ -158,6 +158,176 @@ class ControlApprovalsService {
       `api/approvals/${useCase}`
     );
   }
+  /**
+   * Opens a change-platform-roles request.
+   *
+   * Opening one needs `accounts:admin:changeRole`, the same permission that
+   * approving needs, and the reason is necessary. A 200 means that a request
+   * for the same user is already open.
+   */
+  static async createChangePlatformRoles(params) {
+    return ControlApprovalsService.create(
+      params,
+      "createChangePlatformRoles",
+      "api/approvals/change-platform-roles"
+    );
+  }
+  /**
+   * Opens a delete-internal-backup request.
+   *
+   * Opening one needs `console:clusters:canCreateInternalBackup`, the same
+   * permission that approving needs. A 200 means that a request for the same
+   * backup is already open.
+   */
+  static async createDeleteInternalBackup(params) {
+    return ControlApprovalsService.create(
+      params,
+      "createDeleteInternalBackup",
+      "api/approvals/delete-internal-backup"
+    );
+  }
+  /**
+   * Opens a change-org-limits request.
+   *
+   * Opening one needs `accounts:admin:mayChangeOrgLimits`, the same
+   * permission that approving needs. A 200 means that a request for the same
+   * limit of the same organization is already open.
+   */
+  static async createChangeOrgLimits(params) {
+    return ControlApprovalsService.create(
+      params,
+      "createChangeOrgLimits",
+      "api/approvals/change-org-limits"
+    );
+  }
+  /**
+   * Opens a delete-sso-connection request.
+   *
+   * Opening one needs `AccountsPermissions.ADMIN_AUTH0_CONNECTIONS_DELETE`, the same
+   * permission that approving needs. A 200 means that a request for the same
+   * connection is already open.
+   */
+  static async createDeleteSsoConnection(params) {
+    return ControlApprovalsService.create(
+      params,
+      "createDeleteSsoConnection",
+      "api/approvals/delete-sso-connection"
+    );
+  }
+  /**
+   * Opens a change-sales-plan request.
+   *
+   * Opening one needs `AccountsPermissions.SALES_PLAN_SWITCH`, the same
+   * permission that approving needs. A 200 means that a request for the same
+   * organization is already open.
+   */
+  static async createChangeSalesPlan(params) {
+    return ControlApprovalsService.create(
+      params,
+      "createChangeSalesPlan",
+      "api/approvals/change-sales-plan"
+    );
+  }
+  /**
+   * Opens a change-cluster-plan-type request.
+   *
+   * Opening one needs `ConsolePermissions.CLUSTERS_CAN_UPDATE_CLUSTERPLANTYPE`,
+   * the same permission that approving needs. A 200 means that a request for
+   * the same cluster is already open. The route answers 404 while
+   * `control.changeClusterPlanType` is off.
+   */
+  static async createChangeClusterPlanType(params) {
+    return ControlApprovalsService.create(
+      params,
+      "createChangeClusterPlanType",
+      "api/approvals/change-cluster-plan-type"
+    );
+  }
+  /**
+   * Opens a delete-organization request.
+   *
+   * Opening one needs `AccountsPermissions.DELETE_ORG`, the same permission
+   * that approving needs. A 200 means that a request for the same
+   * organization is already open.
+   */
+  static async createDeleteOrganization(params) {
+    return ControlApprovalsService.create(
+      params,
+      "createDeleteOrganization",
+      "api/approvals/delete-organization"
+    );
+  }
+  /**
+   * Opens a delete-user request.
+   *
+   * Opening one needs `AccountsPermissions.DELETE_USER`, the same permission
+   * that approving needs. A 200 means that a request for the same user is
+   * already open.
+   */
+  static async createDeleteUser(params) {
+    return ControlApprovalsService.create(
+      params,
+      "createDeleteUser",
+      "api/approvals/delete-user"
+    );
+  }
+  /**
+   * Opens a change-user-email request.
+   *
+   * Opening one needs `AccountsPermissions.ADMIN_CHANGE_EMAIL`, the same
+   * permission that approving needs. A 200 means that a request for the same
+   * user is already open.
+   */
+  static async createChangeUserEmail(params) {
+    return ControlApprovalsService.create(
+      params,
+      "createChangeUserEmail",
+      "api/approvals/change-user-email"
+    );
+  }
+  /**
+   * Opens a purge-users request.
+   *
+   * Opening one needs `AccountsPermissions.GOD_PURGE_USERS` and
+   * `AccountsPermissions.DELETE_USER`, the same permissions that approving
+   * needs. A 200 means that a request for the same set of users is already
+   * open.
+   */
+  static async createPurgeUsers(params) {
+    return ControlApprovalsService.create(
+      params,
+      "createPurgeUsers",
+      "api/approvals/purge-users"
+    );
+  }
+  /**
+   * Opens an update-user-metadata request.
+   *
+   * Opening one needs `AccountsPermissions.GOD_UPDATE_USER_METADATA`, the
+   * same permission that approving needs. A 200 means that a request for the
+   * same user and the same kind of metadata is already open.
+   */
+  static async createUpdateUserMetadata(params) {
+    return ControlApprovalsService.create(
+      params,
+      "createUpdateUserMetadata",
+      "api/approvals/update-user-metadata"
+    );
+  }
+  /**
+   * Opens a change-feature-flag request.
+   *
+   * Opening one needs `aafw`, the same permission that approving needs. A 200
+   * means that a request for the same flag is already open. On int this is
+   * the only way to change a flag.
+   */
+  static async createChangeFeatureFlag(params) {
+    return ControlApprovalsService.create(
+      params,
+      "createChangeFeatureFlag",
+      "api/approvals/change-feature-flag"
+    );
+  }
   /** Adds the approval of the caller. The last one can run the action. */
   static async acknowledge(params) {
     return ControlApprovalsService.readOne(
@@ -235,6 +405,43 @@ class ControlApprovalsService {
     );
     return approval;
   }
+  /**
+   * Opens a create-personal-organisation request. Any signed-in Camundi can.
+   *
+   * The request needs no approval, so the answer already holds the outcome,
+   * and the route answers 404 while `control.personalOrganisation` is off.
+   */
+  static async createPersonalOrganisation(params) {
+    const { approval } = await ControlApprovalsService.create(
+      params,
+      "createPersonalOrganisation",
+      "api/approvals/create-personal-organisation",
+      { retryRateLimit: false }
+    );
+    return approval;
+  }
+  /**
+   * Opens a create-customer-hardware-sizing request. Any signed-in Camundi
+   * can. It runs on dev only, needs no approval, and the route answers 404
+   * while `control.customerHardwareSizing` is off.
+   */
+  static async createCustomerHardwareSizing(params) {
+    const { approval } = await ControlApprovalsService.create(
+      params,
+      "createCustomerHardwareSizing",
+      "api/approvals/create-customer-hardware-sizing"
+    );
+    return approval;
+  }
+  /** Opens a remove-customer-hardware-sizing request. See the one above. */
+  static async removeCustomerHardwareSizing(params) {
+    const { approval } = await ControlApprovalsService.create(
+      params,
+      "removeCustomerHardwareSizing",
+      "api/approvals/remove-customer-hardware-sizing"
+    );
+    return approval;
+  }
   /**
    * The shared half of every call that answers one request.
    *
@@ -275,7 +482,7 @@ class ControlApprovalsService {
    * difference. `createSendToExpiredTrial` and `createExtendTrial` do not
    * need it, so they read `approval` alone off this result.
    */
-  static async create(params, name, url) {
+  static async create(params, name, url, options = {}) {
     const serviceContext = contextFor(
       name,
       url,
@@ -289,6 +496,7 @@ class ControlApprovalsService {
       url,
       method: "post",
       metricsDetails: serviceContext,
+      ...options.retryRateLimit === false ? { retry: { attempts: 1, remaining: 0 } } : {},
       body: {
         payload: params.params.payload,
         reason: params.params.reason,