@chrt-inc/typescript-sdk 1.875.0 → 1.880.0

package/dist/cjs/api/resources/orgs/resources/connections/client/Client.d.ts

@@ -4,6 +4,9 @@
 import * as environments from "../../../../../../environments.js";
 import * as core from "../../../../../../core/index.js";
 import * as Chrt from "../../../../../index.js";
+import { Coordinators } from "../resources/coordinators/client/Client.js";
+import { Executors } from "../resources/executors/client/Client.js";
+import { Shippers } from "../resources/shippers/client/Client.js";
 export declare namespace Connections {
     interface Options {
         environment?: core.Supplier<environments.ChrtEnvironment | string>;
@@ -29,9 +32,15 @@ export declare namespace Connections {
 }
 export declare class Connections {
     protected readonly _options: Connections.Options;
+    protected _coordinators: Coordinators | undefined;
+    protected _executors: Executors | undefined;
+    protected _shippers: Shippers | undefined;
     constructor(_options?: Connections.Options);
+    get coordinators(): Coordinators;
+    get executors(): Executors;
+    get shippers(): Shippers;
     /**
-     * Gets the connection between caller's org and the org with the specified handle. | () -> (ShipperProviderConnection1 | ProviderProviderConnection1 | None)
+     * Gets the connection between caller's org and the org with the specified handle. | () -> (ShipperCoordinatorConnection1 | CoordinatorExecutorConnection1 | None)
      *
      * @param {string} handle
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -44,7 +53,44 @@ export declare class Connections {
     getByHandleV1(handle: string, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<(Chrt.orgs.ConnectionsGetByHandleV1Response | null) | undefined>;
     private __getByHandleV1;
     /**
-     * Creates a new connection to a provider organization. Shippers create a shipper-provider connection. Providers create a provider-provider connection where the initiator is the coordinator (payer) and the target is the executor (payee). | (CreateConnectionReq) -> (PydanticObjectId)
+     * Lists the caller's coordinator connections with filtering, pagination, and identity search. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (CoordinatorExecutorConnectionsForExecutorListRes)
+     *
+     * @param {Chrt.orgs.ConnectionsListCoordinatorsForExecutorV1Request} request
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.orgs.connections.listCoordinatorsForExecutorV1({
+     *         search: "search",
+     *         page: 1,
+     *         page_size: 1,
+     *         filter_auto_assign_enabled: true,
+     *         filter_connected: true
+     *     })
+     */
+    listCoordinatorsForExecutorV1(request?: Chrt.orgs.ConnectionsListCoordinatorsForExecutorV1Request, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.CoordinatorExecutorConnectionsForExecutorListRes>;
+    private __listCoordinatorsForExecutorV1;
+    /**
+     * Lists the caller's coordinator connections with filtering, pagination, and identity search. | authz: allowed_org_types=[shipper] | () -> (ShipperCoordinatorConnectionsForShipperListRes)
+     *
+     * @param {Chrt.orgs.ConnectionsListCoordinatorsForShipperV1Request} request
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.orgs.connections.listCoordinatorsForShipperV1({
+     *         search: "search",
+     *         page: 1,
+     *         page_size: 1,
+     *         filter_connected: true
+     *     })
+     */
+    listCoordinatorsForShipperV1(request?: Chrt.orgs.ConnectionsListCoordinatorsForShipperV1Request, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.ShipperCoordinatorConnectionsForShipperListRes>;
+    private __listCoordinatorsForShipperV1;
+    /**
+     * Creates a shipper-coordinator or coordinator-executor connection to an on-CHRT provider. | (CreateConnectionReq) -> (PydanticObjectId)
      *
      * @param {Chrt.CreateConnectionReq} request
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -59,7 +105,7 @@ export declare class Connections {
     createConnectionToProviderV1(request: Chrt.CreateConnectionReq, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<string>;
     private __createConnectionToProviderV1;
     /**
-     * Creates a new connection to a shipper organization. Only providers can initiate connections to shippers. | (CreateConnectionReq) -> (PydanticObjectId)
+     * Creates a shipper-coordinator connection to an on-CHRT shipper. | authz: allowed_org_types=[provider] | (CreateConnectionReq) -> (PydanticObjectId)
      *
      * @param {Chrt.CreateConnectionReq} request
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
@@ -74,74 +120,91 @@ export declare class Connections {
     createConnectionToShipperV1(request: Chrt.CreateConnectionReq, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<string>;
     private __createConnectionToShipperV1;
     /**
-     * Lists provider-provider connections with the caller's coordinator or executor role. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (ProviderProviderConnectionListRes)
+     * Lists the caller's executor connections nearest to a location, with filtering and pagination. Executors without registered addresses follow geocoded results. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (CoordinatorExecutorConnectionsForCoordinatorGeoSearchListRes)
      *
-     * @param {Chrt.orgs.ConnectionsListProviderProviderV1Request} request
+     * @param {Chrt.orgs.ConnectionsListExecutorsGeoSearchForCoordinatorV1Request} request
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.orgs.connections.listProviderProviderV1({
-     *         search: "search",
+     *     await client.orgs.connections.listExecutorsGeoSearchForCoordinatorV1({
+     *         near_latitude: 1.1,
+     *         near_longitude: 1.1,
      *         page: 1,
      *         page_size: 1,
-     *         filter_caller_connection_role: "coordinator",
-     *         filter_connected: true,
-     *         filter_auto_assign_enabled: true
+     *         filter_auto_assign_enabled: true,
+     *         filter_connected: true
      *     })
      */
-    listProviderProviderV1(request?: Chrt.orgs.ConnectionsListProviderProviderV1Request, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.ProviderProviderConnectionListRes>;
-    private __listProviderProviderV1;
+    listExecutorsGeoSearchForCoordinatorV1(request: Chrt.orgs.ConnectionsListExecutorsGeoSearchForCoordinatorV1Request, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.CoordinatorExecutorConnectionsForCoordinatorGeoSearchListRes>;
+    private __listExecutorsGeoSearchForCoordinatorV1;
     /**
-     * Lists provider organizations connected to the calling shipper. | () -> (ProviderConnectionListRes)
+     * Lists the caller's executor connections with filtering, pagination, and identity search. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (CoordinatorExecutorConnectionsForCoordinatorListRes)
      *
-     * @param {Chrt.orgs.ConnectionsListProvidersV1Request} request
+     * @param {Chrt.orgs.ConnectionsListExecutorsForCoordinatorV1Request} request
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.orgs.connections.listProvidersV1({
+     *     await client.orgs.connections.listExecutorsForCoordinatorV1({
      *         search: "search",
      *         page: 1,
-     *         page_size: 1
+     *         page_size: 1,
+     *         filter_auto_assign_enabled: true,
+     *         filter_connected: true
      *     })
      */
-    listProvidersV1(request?: Chrt.orgs.ConnectionsListProvidersV1Request, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.ProviderConnectionListRes>;
-    private __listProvidersV1;
+    listExecutorsForCoordinatorV1(request?: Chrt.orgs.ConnectionsListExecutorsForCoordinatorV1Request, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.CoordinatorExecutorConnectionsForCoordinatorListRes>;
+    private __listExecutorsForCoordinatorV1;
     /**
-     * Toggles `auto_assign_enabled` on a provider-provider connection — the executor org's opt-in for receiving direct (non-bidding) task-group assignments. Executor org only, min role: administrator. | (ProviderProviderUpdateAutoAssignReq) -> (bool)
+     * Sets an executor's consent to direct task-group assignment. | authz: allowed_org_types=[provider], min_org_role=administrator | (CoordinatorExecutorUpdateAutoAssignReq) -> (bool)
      *
      * @param {string} connectionId
-     * @param {Chrt.orgs.ProviderProviderUpdateAutoAssignReq} request
+     * @param {Chrt.orgs.CoordinatorExecutorUpdateAutoAssignReq} request
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.orgs.connections.setProviderProviderAutoAssignV1("connection_id", {
+     *     await client.orgs.connections.setCoordinatorExecutorAutoAssignV1("connection_id", {
      *         auto_assign_enabled: true
      *     })
      */
-    setProviderProviderAutoAssignV1(connectionId: string, request: Chrt.orgs.ProviderProviderUpdateAutoAssignReq, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __setProviderProviderAutoAssignV1;
+    setCoordinatorExecutorAutoAssignV1(connectionId: string, request: Chrt.orgs.CoordinatorExecutorUpdateAutoAssignReq, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setCoordinatorExecutorAutoAssignV1;
+    /**
+     * Sets or clears the coordinator's default department for a shipper-coordinator connection. | authz: allowed_org_types=[provider], min_org_role=operator | (ShipperCoordinatorConnectionClientUpdate1) -> (bool)
+     *
+     * @param {string} connectionId
+     * @param {Chrt.orgs.ShipperCoordinatorConnectionClientUpdate1} request
+     * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.orgs.connections.setShipperCoordinatorDefaultDepartmentV1("connection_id")
+     */
+    setShipperCoordinatorDefaultDepartmentV1(connectionId: string, request?: Chrt.orgs.ShipperCoordinatorConnectionClientUpdate1, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __setShipperCoordinatorDefaultDepartmentV1;
     /**
-     * Lists shipper organizations connected to the caller (caller must be a provider) with optional search by company name or handle. | () -> (ShipperConnectionListRes)
+     * Lists the caller's shipper connections with filtering, pagination, and identity search. | authz: allowed_org_types=[provider] | () -> (ShipperCoordinatorConnectionsForCoordinatorListRes)
      *
-     * @param {Chrt.orgs.ConnectionsListShippersV1Request} request
+     * @param {Chrt.orgs.ConnectionsListShippersForCoordinatorV1Request} request
      * @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.orgs.connections.listShippersV1({
+     *     await client.orgs.connections.listShippersForCoordinatorV1({
      *         search: "search",
      *         page: 1,
-     *         page_size: 1
+     *         page_size: 1,
+     *         filter_connected: true
      *     })
      */
-    listShippersV1(request?: Chrt.orgs.ConnectionsListShippersV1Request, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.ShipperConnectionListRes>;
-    private __listShippersV1;
+    listShippersForCoordinatorV1(request?: Chrt.orgs.ConnectionsListShippersForCoordinatorV1Request, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.ShipperCoordinatorConnectionsForCoordinatorListRes>;
+    private __listShippersForCoordinatorV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }