Package com.chrt.api.resources.listing.listings

Class RawListingsClient

  • public class RawListingsClient
extends java.lang.Object

    • Constructor Detail

      • RawListingsClient

        public RawListingsClient​(ClientOptions clientOptions)

    • Method Detail

      • byIdV1

        public ChrtApiHttpResponse<ListingForBidder1> byIdV1​(java.lang.String listingId)
        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)

      • byIdV1

        public ChrtApiHttpResponse<ListingForBidder1> byIdV1​(java.lang.String listingId,
                                                     RequestOptions requestOptions)
        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)

      • byIdForListerV1

        public ChrtApiHttpResponse<Listing1> byIdForListerV1​(java.lang.String listingId)
        Fetches the full listing record (including internal_notes). Restricted to the lister org — bidders use by_id/v1. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (Listing1)

      • byIdForListerV1

        public ChrtApiHttpResponse<Listing1> byIdForListerV1​(java.lang.String listingId,
                                                     RequestOptions requestOptions)
        Fetches the full listing record (including internal_notes). Restricted to the lister org — bidders use by_id/v1. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (Listing1)

      • byTaskGroupV1

        public ChrtApiHttpResponse<java.util.List<Listing1>> byTaskGroupV1​(java.lang.String taskGroupId)
        Fetches all listings for a single task group. Typically returns one or two (dual-audience siblings) OPEN listings during active bidding plus any terminal history. Visible only to the task group's coordinator. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[Listing1])

      • byTaskGroupV1

        public ChrtApiHttpResponse<java.util.List<Listing1>> byTaskGroupV1​(java.lang.String taskGroupId,
                                                                   RequestOptions requestOptions)
        Fetches all listings for a single task group. Typically returns one or two (dual-audience siblings) OPEN listings during active bidding plus any terminal history. Visible only to the task group's coordinator. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[Listing1])

      • listByOrgV1

        public ChrtApiHttpResponse<ListingListRes> listByOrgV1()
        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)

      • listByOrgV1

        public ChrtApiHttpResponse<ListingListRes> listByOrgV1​(ListingsListByOrgV1Request request)
        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)

      • listForProviderBidderV1

        public ChrtApiHttpResponse<ListingForBidderListRes> listForProviderBidderV1()
        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)

      • listForProviderBidderV1

        public ChrtApiHttpResponse<ListingForBidderListRes> listForProviderBidderV1​(ListingsListForProviderBidderV1Request request)
        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)

      • listForProviderBidderV1

        public ChrtApiHttpResponse<ListingForBidderListRes> listForProviderBidderV1​(ListingsListForProviderBidderV1Request request,
                                                                            RequestOptions requestOptions)
        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)

      • listForDriverBidderV1

        public ChrtApiHttpResponse<ListingForBidderListRes> 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)

      • listForDriverBidderV1

        public ChrtApiHttpResponse<ListingForBidderListRes> listForDriverBidderV1​(ListingsListForDriverBidderV1Request request)
        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)

      • listForDriverBidderV1

        public ChrtApiHttpResponse<ListingForBidderListRes> listForDriverBidderV1​(ListingsListForDriverBidderV1Request request,
                                                                          RequestOptions requestOptions)
        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)

      • createV1

        public ChrtApiHttpResponse<java.lang.String> createV1​(ListingClientCreate1 request)
        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)

      • createV1

        public ChrtApiHttpResponse<java.lang.String> createV1​(ListingClientCreate1 request,
                                                      RequestOptions requestOptions)
        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)

      • updateV1

        public ChrtApiHttpResponse<java.lang.Boolean> updateV1​(java.lang.String listingId)
        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)

      • updateV1

        public ChrtApiHttpResponse<java.lang.Boolean> updateV1​(java.lang.String listingId,
                                                       ListingClientUpdate1 request)
        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)

      • updateV1

        public ChrtApiHttpResponse<java.lang.Boolean> updateV1​(java.lang.String listingId,
                                                       ListingClientUpdate1 request,
                                                       RequestOptions requestOptions)
        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)

      • addProviderParticipantsV1

        public ChrtApiHttpResponse<java.lang.Boolean> addProviderParticipantsV1​(java.lang.String listingId)
        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)

      • addProviderParticipantsV1

        public ChrtApiHttpResponse<java.lang.Boolean> addProviderParticipantsV1​(java.lang.String listingId,
                                                                        ListingAddProviderParticipantsReq request)
        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)

      • addProviderParticipantsV1

        public ChrtApiHttpResponse<java.lang.Boolean> addProviderParticipantsV1​(java.lang.String listingId,
                                                                        ListingAddProviderParticipantsReq request,
                                                                        RequestOptions requestOptions)
        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)

      • addDriverParticipantsV1

        public ChrtApiHttpResponse<java.lang.Boolean> addDriverParticipantsV1​(java.lang.String listingId)
        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)

      • addDriverParticipantsV1

        public ChrtApiHttpResponse<java.lang.Boolean> addDriverParticipantsV1​(java.lang.String listingId,
                                                                      ListingAddDriverParticipantsReq request)
        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)

      • addDriverParticipantsV1

        public ChrtApiHttpResponse<java.lang.Boolean> addDriverParticipantsV1​(java.lang.String listingId,
                                                                      ListingAddDriverParticipantsReq request,
                                                                      RequestOptions requestOptions)
        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)

      • removeProviderParticipantsV1

        public ChrtApiHttpResponse<java.lang.Boolean> removeProviderParticipantsV1​(java.lang.String listingId)
        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)

      • removeProviderParticipantsV1

        public ChrtApiHttpResponse<java.lang.Boolean> removeProviderParticipantsV1​(java.lang.String listingId,
                                                                           ListingRemoveProviderParticipantsReq request)
        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)

      • removeProviderParticipantsV1

        public ChrtApiHttpResponse<java.lang.Boolean> removeProviderParticipantsV1​(java.lang.String listingId,
                                                                           ListingRemoveProviderParticipantsReq request,
                                                                           RequestOptions requestOptions)
        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)

      • removeDriverParticipantsV1

        public ChrtApiHttpResponse<java.lang.Boolean> removeDriverParticipantsV1​(java.lang.String listingId)
        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)

      • removeDriverParticipantsV1

        public ChrtApiHttpResponse<java.lang.Boolean> removeDriverParticipantsV1​(java.lang.String listingId,
                                                                         ListingRemoveDriverParticipantsReq request)
        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)

      • removeDriverParticipantsV1

        public ChrtApiHttpResponse<java.lang.Boolean> removeDriverParticipantsV1​(java.lang.String listingId,
                                                                         ListingRemoveDriverParticipantsReq request,
                                                                         RequestOptions requestOptions)
        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)

      • cancelV1

        public ChrtApiHttpResponse<java.lang.Boolean> cancelV1​(java.lang.String listingId)
        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)

      • cancelV1

        public ChrtApiHttpResponse<java.lang.Boolean> cancelV1​(java.lang.String listingId,
                                                       RequestOptions requestOptions)
        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)