@chrt-inc/typescript-sdk 0.0.174 → 0.0.183

package/dist/esm/api/resources/root/client/Client.mjs

@@ -19,21 +19,21 @@ export class Root {
         this._options = _options;
     }
     /**
-     * Returns a greeting message
+     * Test endpoint for authenticated requests that requires valid authentication tokens.
      *
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.pingUnauthd()
+     *     await client.root.pingAuthd()
      */
-    pingUnauthd(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__pingUnauthd(requestOptions));
+    pingAuthd(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pingAuthd(requestOptions));
     }
-    __pingUnauthd(requestOptions) {
+    __pingAuthd(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: (_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local,
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "authd"),
                 method: "GET",
                 headers: mergeHeaders((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -58,7 +58,7 @@ export class Root {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /authd.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -68,19 +68,21 @@ export class Root {
         });
     }
     /**
+     * Test endpoint for optionally authenticated requests that works with or without authentication.
+     *
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.pingAuthd()
+     *     await client.root.pingOptionallyAuthd()
      */
-    pingAuthd(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__pingAuthd(requestOptions));
+    pingOptionallyAuthd(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pingOptionallyAuthd(requestOptions));
     }
-    __pingAuthd(requestOptions) {
+    __pingOptionallyAuthd(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "authd"),
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "optionally_authd"),
                 method: "GET",
                 headers: mergeHeaders((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -105,7 +107,7 @@ export class Root {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /authd.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /optionally_authd.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -115,19 +117,21 @@ export class Root {
         });
     }
     /**
+     * Returns a greeting message
+     *
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.failure()
+     *     await client.root.pingUnauthd()
      */
-    failure(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__failure(requestOptions));
+    pingUnauthd(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pingUnauthd(requestOptions));
     }
-    __failure(requestOptions) {
+    __pingUnauthd(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "failure"),
+                url: (_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local,
                 method: "GET",
                 headers: mergeHeaders((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -152,7 +156,7 @@ export class Root {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /failure.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -211,19 +215,21 @@ export class Root {
         });
     }
     /**
+     * Test endpoint that intentionally fails for error handling validation and monitoring purposes.
+     *
      * @param {Root.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.root.pingOptionallyAuthd()
+     *     await client.root.failure()
      */
-    pingOptionallyAuthd(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__pingOptionallyAuthd(requestOptions));
+    failure(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__failure(requestOptions));
     }
-    __pingOptionallyAuthd(requestOptions) {
+    __failure(requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "optionally_authd"),
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "failure"),
                 method: "GET",
                 headers: mergeHeaders((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -248,7 +254,7 @@ export class Root {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /optionally_authd.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /failure.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,

package/dist/esm/api/resources/shipperContactInfo/client/Client.d.mts

@@ -29,7 +29,7 @@ export declare class ShipperContactInfo {
     protected readonly _options: ShipperContactInfo.Options;
     constructor(_options?: ShipperContactInfo.Options);
     /**
-     * Get my own shipper contact info (for authenticated shippers users)
+     * Retrieves the authenticated user's own shipper contact information.
      *
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -39,87 +39,87 @@ export declare class ShipperContactInfo {
     getByJwtUserId(requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1>;
     private __getByJwtUserId;
     /**
-     * Get all contacts accessible to courier org for a specific on-platform shipper.
-     * Returns:
-     * 1. Contacts created by the courier org that are linked to the shipper org
-     * 2. Contacts created by the shipper org themselves (if courier and shipper are connected)
+     * Lists all shipper contacts created by the authenticated organization.
      *
-     * @param {string} shipperOrgId
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
      * @example
-     *     await client.shipperContactInfo.listCourierContactsByShipperOrgId("shipper_org_id")
+     *     await client.shipperContactInfo.listByJwtOrgId()
      */
-    listCourierContactsByShipperOrgId(shipperOrgId: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
-    private __listCourierContactsByShipperOrgId;
+    listByJwtOrgId(requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
+    private __listByJwtOrgId;
     /**
-     * Create shipper contact info for off-platform shipper (scenario 3)
+     * Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.
      *
-     * @param {Chrt.ShipperContactInfoClientCreate1} request
+     * @param {string} shipperOrgId
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipperContactInfo.createOffPlatform({
-     *         schema_version: 1
-     *     })
+     *     await client.shipperContactInfo.listCourierContactsByShipperOrgId("shipper_org_id")
      */
-    createOffPlatform(request: Chrt.ShipperContactInfoClientCreate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
-    private __createOffPlatform;
+    listCourierContactsByShipperOrgId(shipperOrgId: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
+    private __listCourierContactsByShipperOrgId;
     /**
-     * Create shipper contact info for on-platform shipper (scenarios 1 & 2)
+     * Lists all shipper contacts for a specific off-platform shipper connection.
      *
-     * @param {Chrt.ShipperContactInfoClientCreate1} request
+     * @param {string} offChrtShipperOrgConnectionInfoId
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipperContactInfo.createOnPlatform({
-     *         schema_version: 1
-     *     })
+     *     await client.shipperContactInfo.listByOffChrtShipperOrgConnectionInfoId("off_chrt_shipper_org_connection_info_id")
      */
-    createOnPlatform(request: Chrt.ShipperContactInfoClientCreate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
-    private __createOnPlatform;
+    listByOffChrtShipperOrgConnectionInfoId(offChrtShipperOrgConnectionInfoId: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
+    private __listByOffChrtShipperOrgConnectionInfoId;
     /**
+     * Retrieves a specific shipper contact by ID if authorized to access it.
+     *
      * @param {string} id
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipperContactInfo.deleteById("id")
+     *     await client.shipperContactInfo.getById("id")
      */
-    deleteById(id: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __deleteById;
+    getById(id: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1>;
+    private __getById;
     /**
-     * Get all contacts for my organization which were created by the shipper org (for authenticated shipper orgs)
+     * Creates contact information for an on-platform shipper organization or user.
      *
+     * @param {Chrt.ShipperContactInfoClientCreate1} request
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
      * @example
-     *     await client.shipperContactInfo.listByJwtOrgId()
+     *     await client.shipperContactInfo.createOnPlatform({
+     *         schema_version: 1
+     *     })
      */
-    listByJwtOrgId(requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
-    private __listByJwtOrgId;
+    createOnPlatform(request: Chrt.ShipperContactInfoClientCreate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
+    private __createOnPlatform;
     /**
-     * Get all contacts accessible to courier org for a specific off-platform shipper.
-     * Returns only contacts created by the courier org since off-platform shippers cannot create their own contacts.
+     * Creates contact information for an off-platform shipper using connection info.
      *
-     * @param {string} offChrtShipperOrgConnectionInfoId
+     * @param {Chrt.ShipperContactInfoClientCreate1} request
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipperContactInfo.listByOffChrtShipperOrgConnectionInfoId("off_chrt_shipper_org_connection_info_id")
+     *     await client.shipperContactInfo.createOffPlatform({
+     *         schema_version: 1
+     *     })
      */
-    listByOffChrtShipperOrgConnectionInfoId(offChrtShipperOrgConnectionInfoId: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
-    private __listByOffChrtShipperOrgConnectionInfoId;
+    createOffPlatform(request: Chrt.ShipperContactInfoClientCreate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
+    private __createOffPlatform;
     /**
+     * Updates existing shipper contact information owned by the authenticated organization.
+     *
      * @param {string} shipperContactInfoId
      * @param {Chrt.ShipperContactInfoClientUpdate1} request
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -132,7 +132,7 @@ export declare class ShipperContactInfo {
     update(shipperContactInfoId: string, request?: Chrt.ShipperContactInfoClientUpdate1, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<boolean>;
     private __update;
     /**
-     * Get a specific shipper contact info by ID
+     * Deletes shipper contact information owned by the authenticated organization.
      *
      * @param {string} id
      * @param {ShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
@@ -140,9 +140,9 @@ export declare class ShipperContactInfo {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.shipperContactInfo.getById("id")
+     *     await client.shipperContactInfo.deleteById("id")
      */
-    getById(id: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1>;
-    private __getById;
+    deleteById(id: string, requestOptions?: ShipperContactInfo.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __deleteById;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }