@chrt-inc/typescript-sdk 1.810.0 → 1.841.0

package/dist/cjs/api/resources/listing/resources/listings/client/Client.d.ts

@@ -30,6 +30,34 @@ export declare namespace Listings {
 export declare class Listings {
     protected readonly _options: Listings.Options;
     constructor(_options?: Listings.Options);
+    /**
+     * Expands the audience of an OPEN DRIVERS listing. Ad-hoc driver picks are unioned with expanded driver bidding groups, then `$addToSet` onto the listing. Rejected for PROVIDERS listings. | authz: allowed_org_types=[provider], min_org_role=operator | (ListingAddDriverParticipantsReq) -> (bool)
+     *
+     * @param {string} listingId
+     * @param {Chrt.listing.ListingAddDriverParticipantsReq} request
+     * @param {Listings.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.listing.listings.addDriverParticipantsV1("listing_id")
+     */
+    addDriverParticipantsV1(listingId: string, request?: Chrt.listing.ListingAddDriverParticipantsReq, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __addDriverParticipantsV1;
+    /**
+     * Expands the audience of an OPEN PROVIDERS listing. Ad-hoc provider picks are unioned with expanded org bidding groups, then `$addToSet` onto the listing. Rejected for DRIVERS listings. | authz: allowed_org_types=[provider], min_org_role=operator | (ListingAddProviderParticipantsReq) -> (bool)
+     *
+     * @param {string} listingId
+     * @param {Chrt.listing.ListingAddProviderParticipantsReq} request
+     * @param {Listings.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.listing.listings.addProviderParticipantsV1("listing_id")
+     */
+    addProviderParticipantsV1(listingId: string, request?: Chrt.listing.ListingAddProviderParticipantsReq, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __addProviderParticipantsV1;
     /**
      * Fetches a listing by id in the bidder-facing shape with tasks and mileage. Visible to the lister and to snapshot participants (as bidder — provider org or driver). Listers wanting the full record call `by_id_for_lister/v1`. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (ListingForBidder1)
      *
@@ -69,6 +97,37 @@ export declare class Listings {
      */
     byTaskGroupV1(taskGroupId: string, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<Chrt.Listing1[]>;
     private __byTaskGroupV1;
+    /**
+     * Cancels an OPEN listing. All OPEN BidThreads on this listing are system-rejected. No shipping or billing side-effects. Idempotent: no-op on an already-terminal listing. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (bool)
+     *
+     * @param {string} listingId
+     * @param {Listings.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.listing.listings.cancelV1("listing_id")
+     */
+    cancelV1(listingId: string, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __cancelV1;
+    /**
+     * Creates a Listing for a TaskGroup that the caller's org coordinates. Snapshots participants by unioning ad-hoc picks with expanded bidding groups. When `auto_open_priced_bid_threads` is True, also auto-opens one BidThread per resolved participant with a lister-side seed Bid carrying default-rate-sheet-derived pricing (falling back to the listing's `pro_forma_line_items` when no rate sheet is configured for a participant) — listing insert and thread inserts are atomic. | authz: allowed_org_types=[provider], min_org_role=operator | (ListingClientCreate1) -> (PydanticObjectId)
+     *
+     * @param {Chrt.listing.ListingClientCreate1} request
+     * @param {Listings.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.listing.listings.createV1({
+     *         audience: "providers",
+     *         listing_description: "listing_description",
+     *         task_group_id: "task_group_id",
+     *         task_group_summary_for_bidders: "task_group_summary_for_bidders"
+     *     })
+     */
+    createV1(request: Chrt.listing.ListingClientCreate1, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<string>;
+    private __createV1;
     /**
      * Lists listings owned (created) by the caller's org with filtering, sorting, and pagination. Lister view. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (ListingListRes)
      *
@@ -97,15 +156,15 @@ export declare class Listings {
     listByOrgV1(request?: Chrt.listing.ListingsListByOrgV1Request, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<Chrt.ListingListRes>;
     private __listByOrgV1;
     /**
-     * Lists PROVIDERS-audience listings where the caller's org is a snapshot participant. Provider-side bidder view with filtering, sorting, and pagination. Returns the bidder shape with tasks and mileage (no `internal_notes`). | authz: allowed_org_types=[provider], min_org_role=operator | () -> (ListingForBidderListRes)
+     * Lists DRIVERS-audience listings where the caller (resolved to a Driver of their org) is a snapshot participant. Driver-side bidder view with filtering, sorting, and pagination. Returns the bidder shape with tasks and mileage (no `internal_notes`). | authz: allowed_org_types=[provider], min_org_role=driver | () -> (ListingForBidderListRes)
      *
-     * @param {Chrt.listing.ListingsListForProviderBidderV1Request} request
+     * @param {Chrt.listing.ListingsListForDriverBidderV1Request} request
      * @param {Listings.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.listing.listings.listForProviderBidderV1({
+     *     await client.listing.listings.listForDriverBidderV1({
      *         sort_by: "created_at_timestamp",
      *         sort_order: "asc",
      *         page: 1,
@@ -120,18 +179,18 @@ export declare class Listings {
      *         filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z"
      *     })
      */
-    listForProviderBidderV1(request?: Chrt.listing.ListingsListForProviderBidderV1Request, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<Chrt.ListingForBidderListRes>;
-    private __listForProviderBidderV1;
+    listForDriverBidderV1(request?: Chrt.listing.ListingsListForDriverBidderV1Request, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<Chrt.ListingForBidderListRes>;
+    private __listForDriverBidderV1;
     /**
-     * Lists DRIVERS-audience listings where the caller (resolved to a Driver of their org) is a snapshot participant. Driver-side bidder view with filtering, sorting, and pagination. Returns the bidder shape with tasks and mileage (no `internal_notes`). | authz: allowed_org_types=[provider], min_org_role=driver | () -> (ListingForBidderListRes)
+     * Lists PROVIDERS-audience listings where the caller's org is a snapshot participant. Provider-side bidder view with filtering, sorting, and pagination. Returns the bidder shape with tasks and mileage (no `internal_notes`). | authz: allowed_org_types=[provider], min_org_role=operator | () -> (ListingForBidderListRes)
      *
-     * @param {Chrt.listing.ListingsListForDriverBidderV1Request} request
+     * @param {Chrt.listing.ListingsListForProviderBidderV1Request} request
      * @param {Listings.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.listing.listings.listForDriverBidderV1({
+     *     await client.listing.listings.listForProviderBidderV1({
      *         sort_by: "created_at_timestamp",
      *         sort_order: "asc",
      *         page: 1,
@@ -146,68 +205,22 @@ export declare class Listings {
      *         filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z"
      *     })
      */
-    listForDriverBidderV1(request?: Chrt.listing.ListingsListForDriverBidderV1Request, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<Chrt.ListingForBidderListRes>;
-    private __listForDriverBidderV1;
-    /**
-     * Creates a Listing for a TaskGroup that the caller's org coordinates. Snapshots participants by unioning ad-hoc picks with expanded bidding groups. When `auto_open_priced_bid_threads` is True, also auto-opens one BidThread per resolved participant with a lister-side seed Bid carrying default-rate-sheet-derived pricing (falling back to the listing's `pro_forma_line_items` when no rate sheet is configured for a participant) — listing insert and thread inserts are atomic. | authz: allowed_org_types=[provider], min_org_role=operator | (ListingClientCreate1) -> (PydanticObjectId)
-     *
-     * @param {Chrt.listing.ListingClientCreate1} request
-     * @param {Listings.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.listing.listings.createV1({
-     *         listing_description: "listing_description",
-     *         task_group_id: "task_group_id",
-     *         task_group_summary_for_bidders: "task_group_summary_for_bidders",
-     *         audience: "providers"
-     *     })
-     */
-    createV1(request: Chrt.listing.ListingClientCreate1, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<string>;
-    private __createV1;
-    /**
-     * Partial update of a Listing. Allowed only while `status == OPEN`. Audience participant lists are NOT editable here — use add_participants / remove_participants. | authz: allowed_org_types=[provider], min_org_role=operator | (ListingClientUpdate1) -> (bool)
-     *
-     * @param {string} listingId
-     * @param {Chrt.listing.ListingClientUpdate1} request
-     * @param {Listings.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.listing.listings.updateV1("listing_id")
-     */
-    updateV1(listingId: string, request?: Chrt.listing.ListingClientUpdate1, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __updateV1;
-    /**
-     * Expands the audience of an OPEN PROVIDERS listing. Ad-hoc provider picks are unioned with expanded org bidding groups, then `$addToSet` onto the listing. Rejected for DRIVERS listings. | authz: allowed_org_types=[provider], min_org_role=operator | (ListingAddProviderParticipantsReq) -> (bool)
-     *
-     * @param {string} listingId
-     * @param {Chrt.listing.ListingAddProviderParticipantsReq} request
-     * @param {Listings.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.listing.listings.addProviderParticipantsV1("listing_id")
-     */
-    addProviderParticipantsV1(listingId: string, request?: Chrt.listing.ListingAddProviderParticipantsReq, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __addProviderParticipantsV1;
+    listForProviderBidderV1(request?: Chrt.listing.ListingsListForProviderBidderV1Request, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<Chrt.ListingForBidderListRes>;
+    private __listForProviderBidderV1;
     /**
-     * Expands the audience of an OPEN DRIVERS listing. Ad-hoc driver picks are unioned with expanded driver bidding groups, then `$addToSet` onto the listing. Rejected for PROVIDERS listings. | authz: allowed_org_types=[provider], min_org_role=operator | (ListingAddDriverParticipantsReq) -> (bool)
+     * Narrows the audience of an OPEN DRIVERS listing. Rejected for any driver with a live (OPEN) BidThread. Rejected for PROVIDERS listings. | authz: allowed_org_types=[provider], min_org_role=operator | (ListingRemoveDriverParticipantsReq) -> (bool)
      *
      * @param {string} listingId
-     * @param {Chrt.listing.ListingAddDriverParticipantsReq} request
+     * @param {Chrt.listing.ListingRemoveDriverParticipantsReq} request
      * @param {Listings.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.listing.listings.addDriverParticipantsV1("listing_id")
+     *     await client.listing.listings.removeDriverParticipantsV1("listing_id")
      */
-    addDriverParticipantsV1(listingId: string, request?: Chrt.listing.ListingAddDriverParticipantsReq, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __addDriverParticipantsV1;
+    removeDriverParticipantsV1(listingId: string, request?: Chrt.listing.ListingRemoveDriverParticipantsReq, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __removeDriverParticipantsV1;
     /**
      * Narrows the audience of an OPEN PROVIDERS listing. Rejected for any participant with a live (OPEN) BidThread. Rejected for DRIVERS listings. | authz: allowed_org_types=[provider], min_org_role=operator | (ListingRemoveProviderParticipantsReq) -> (bool)
      *
@@ -223,31 +236,18 @@ export declare class Listings {
     removeProviderParticipantsV1(listingId: string, request?: Chrt.listing.ListingRemoveProviderParticipantsReq, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<boolean>;
     private __removeProviderParticipantsV1;
     /**
-     * Narrows the audience of an OPEN DRIVERS listing. Rejected for any driver with a live (OPEN) BidThread. Rejected for PROVIDERS listings. | authz: allowed_org_types=[provider], min_org_role=operator | (ListingRemoveDriverParticipantsReq) -> (bool)
-     *
-     * @param {string} listingId
-     * @param {Chrt.listing.ListingRemoveDriverParticipantsReq} request
-     * @param {Listings.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.listing.listings.removeDriverParticipantsV1("listing_id")
-     */
-    removeDriverParticipantsV1(listingId: string, request?: Chrt.listing.ListingRemoveDriverParticipantsReq, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __removeDriverParticipantsV1;
-    /**
-     * Cancels an OPEN listing. All OPEN BidThreads on this listing are system-rejected. No shipping or billing side-effects. Idempotent: no-op on an already-terminal listing. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (bool)
+     * Partial update of a Listing. Allowed only while `status == OPEN`. Audience participant lists are NOT editable here — use add_participants / remove_participants. | authz: allowed_org_types=[provider], min_org_role=operator | (ListingClientUpdate1) -> (bool)
      *
      * @param {string} listingId
+     * @param {Chrt.listing.ListingClientUpdate1} request
      * @param {Listings.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.listing.listings.cancelV1("listing_id")
+     *     await client.listing.listings.updateV1("listing_id")
      */
-    cancelV1(listingId: string, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __cancelV1;
+    updateV1(listingId: string, request?: Chrt.listing.ListingClientUpdate1, requestOptions?: Listings.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }