Package com.chrt.api.resources.shippercontactinfo

Class AsyncShipperContactInfoClient

  • public class AsyncShipperContactInfoClient
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.concurrent.CompletableFuture<java.lang.String> createOffPlatformV1​(ShipperContactClientCreate1 request)
      Creates contact information for an off-platform shipper using connection info.
      java.util.concurrent.CompletableFuture<java.lang.String> createOffPlatformV1​(ShipperContactClientCreate1 request, RequestOptions requestOptions)
      Creates contact information for an off-platform shipper using connection info.
      java.util.concurrent.CompletableFuture<java.lang.String> createOnPlatformV1​(ShipperContactClientCreate1 request)
      Creates contact information for an on-platform shipper organization or user.
      java.util.concurrent.CompletableFuture<java.lang.String> createOnPlatformV1​(ShipperContactClientCreate1 request, RequestOptions requestOptions)
      Creates contact information for an on-platform shipper organization or user.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1​(java.lang.String id)
      Deletes shipper contact information owned by the caller's organization.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1​(java.lang.String id, RequestOptions requestOptions)
      Deletes shipper contact information owned by the caller's organization.
      java.util.concurrent.CompletableFuture<ShipperContact1> getCallerV1()
      Retrieves the shipper contact information associated with the caller's ID.
      java.util.concurrent.CompletableFuture<ShipperContact1> getCallerV1​(RequestOptions requestOptions)
      Retrieves the shipper contact information associated with the caller's ID.
      java.util.concurrent.CompletableFuture<ShipperContact1> getV1​(java.lang.String id)
      Retrieves a specific shipper contact by ID if authorized to access it.
      java.util.concurrent.CompletableFuture<ShipperContact1> getV1​(java.lang.String id, RequestOptions requestOptions)
      Retrieves a specific shipper contact by ID if authorized to access it.
      java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listCourierContactsV1​(java.lang.String shipperOrgId)
      Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.
      java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listCourierContactsV1​(java.lang.String shipperOrgId, RequestOptions requestOptions)
      Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.
      java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listForwarderContactsV1​(java.lang.String shipperOrgId)
      Lists all shipper contacts accessible to the forwarder organization for a specific on-platform shipper.
      java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listForwarderContactsV1​(java.lang.String shipperOrgId, RequestOptions requestOptions)
      Lists all shipper contacts accessible to the forwarder organization for a specific on-platform shipper.
      java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listOffPlatformContactsV1​(java.lang.String offChrtShipperOrgId)
      Lists all shipper contacts for a specific off-platform shipper.
      java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listOffPlatformContactsV1​(java.lang.String offChrtShipperOrgId, RequestOptions requestOptions)
      Lists all shipper contacts for a specific off-platform shipper.
      java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listV1()
      Lists all shipper contacts for the caller's organization.
      java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listV1​(RequestOptions requestOptions)
      Lists all shipper contacts for the caller's organization.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String shipperContactInfoId)
      Updates existing shipper contact information owned by the caller's organization.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String shipperContactInfoId, ShipperContactClientUpdate1 request)
      Updates existing shipper contact information owned by the caller's organization.
      java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String shipperContactInfoId, ShipperContactClientUpdate1 request, RequestOptions requestOptions)
      Updates existing shipper contact information owned by the caller's organization.
      AsyncRawShipperContactInfoClient withRawResponse()
      Get responses with HTTP metadata like headers

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AsyncShipperContactInfoClient

        public AsyncShipperContactInfoClient​(ClientOptions clientOptions)

    • Method Detail

      • getCallerV1

        public java.util.concurrent.CompletableFuture<ShipperContact1> getCallerV1()
        Retrieves the shipper contact information associated with the caller's ID. | () -> (ShipperContact1)

      • getCallerV1

        public java.util.concurrent.CompletableFuture<ShipperContact1> getCallerV1​(RequestOptions requestOptions)
        Retrieves the shipper contact information associated with the caller's ID. | () -> (ShipperContact1)

      • listV1

        public java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listV1()
        Lists all shipper contacts for the caller's organization. | () -> (list[ShipperContact1])

      • listV1

        public java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listV1​(RequestOptions requestOptions)
        Lists all shipper contacts for the caller's organization. | () -> (list[ShipperContact1])

      • listCourierContactsV1

        public java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listCourierContactsV1​(java.lang.String shipperOrgId)
        Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper. | () -> (list[ShipperContact1])

      • listCourierContactsV1

        public java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listCourierContactsV1​(java.lang.String shipperOrgId,
                                                                                                     RequestOptions requestOptions)
        Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper. | () -> (list[ShipperContact1])

      • listForwarderContactsV1

        public java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listForwarderContactsV1​(java.lang.String shipperOrgId)
        Lists all shipper contacts accessible to the forwarder organization for a specific on-platform shipper. | () -> (list[ShipperContact1])

      • listForwarderContactsV1

        public java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listForwarderContactsV1​(java.lang.String shipperOrgId,
                                                                                                       RequestOptions requestOptions)
        Lists all shipper contacts accessible to the forwarder organization for a specific on-platform shipper. | () -> (list[ShipperContact1])

      • listOffPlatformContactsV1

        public java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listOffPlatformContactsV1​(java.lang.String offChrtShipperOrgId)
        Lists all shipper contacts for a specific off-platform shipper. | () -> (list[ShipperContact1])

      • listOffPlatformContactsV1

        public java.util.concurrent.CompletableFuture<java.util.List<ShipperContact1>> listOffPlatformContactsV1​(java.lang.String offChrtShipperOrgId,
                                                                                                         RequestOptions requestOptions)
        Lists all shipper contacts for a specific off-platform shipper. | () -> (list[ShipperContact1])

      • getV1

        public java.util.concurrent.CompletableFuture<ShipperContact1> getV1​(java.lang.String id)
        Retrieves a specific shipper contact by ID if authorized to access it. | () -> (ShipperContact1)

      • getV1

        public java.util.concurrent.CompletableFuture<ShipperContact1> getV1​(java.lang.String id,
                                                                     RequestOptions requestOptions)
        Retrieves a specific shipper contact by ID if authorized to access it. | () -> (ShipperContact1)

      • createOnPlatformV1

        public java.util.concurrent.CompletableFuture<java.lang.String> createOnPlatformV1​(ShipperContactClientCreate1 request)
        Creates contact information for an on-platform shipper organization or user. | (ShipperContactClientCreate1) -> (PydanticObjectId)

      • createOnPlatformV1

        public java.util.concurrent.CompletableFuture<java.lang.String> createOnPlatformV1​(ShipperContactClientCreate1 request,
                                                                                   RequestOptions requestOptions)
        Creates contact information for an on-platform shipper organization or user. | (ShipperContactClientCreate1) -> (PydanticObjectId)

      • createOffPlatformV1

        public java.util.concurrent.CompletableFuture<java.lang.String> createOffPlatformV1​(ShipperContactClientCreate1 request)
        Creates contact information for an off-platform shipper using connection info. | (ShipperContactClientCreate1) -> (PydanticObjectId)

      • createOffPlatformV1

        public java.util.concurrent.CompletableFuture<java.lang.String> createOffPlatformV1​(ShipperContactClientCreate1 request,
                                                                                    RequestOptions requestOptions)
        Creates contact information for an off-platform shipper using connection info. | (ShipperContactClientCreate1) -> (PydanticObjectId)

      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String shipperContactInfoId)
        Updates existing shipper contact information owned by the caller's organization. | (ShipperContactClientUpdate1) -> (bool)

      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String shipperContactInfoId,
                                                                          ShipperContactClientUpdate1 request)
        Updates existing shipper contact information owned by the caller's organization. | (ShipperContactClientUpdate1) -> (bool)

      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String shipperContactInfoId,
                                                                          ShipperContactClientUpdate1 request,
                                                                          RequestOptions requestOptions)
        Updates existing shipper contact information owned by the caller's organization. | (ShipperContactClientUpdate1) -> (bool)

      • deleteV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1​(java.lang.String id)
        Deletes shipper contact information owned by the caller's organization. | () -> (bool)

      • deleteV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1​(java.lang.String id,
                                                                          RequestOptions requestOptions)
        Deletes shipper contact information owned by the caller's organization. | () -> (bool)