@chrt-inc/typescript-sdk 1.887.0 → 1.888.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/orgs/resources/accounts/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/accounts/client/Client.js +5 -1
- package/dist/cjs/api/resources/orgs/resources/accounts/client/requests/AccountsListV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/orgs/resources/contacts/client/Client.d.ts +30 -0
- package/dist/cjs/api/resources/orgs/resources/contacts/client/Client.js +125 -0
- package/dist/cjs/api/resources/orgs/resources/contacts/client/requests/ContactAccountAddReq.d.ts +12 -0
- package/dist/cjs/api/resources/orgs/resources/contacts/client/requests/ContactAccountAddReq.js +5 -0
- package/dist/cjs/api/resources/orgs/resources/contacts/client/requests/ContactClientCreate1.d.ts +1 -1
- package/dist/cjs/api/resources/orgs/resources/contacts/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/Client.d.ts +53 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/Client.js +200 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/index.js +15 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/CargoAddToOrderReq.d.ts +18 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/CargoAddToOrderReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/CargoAssociateWithTaskReq.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/CargoAssociateWithTaskReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/CargoUnassociateWithTaskReq.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/CargoUnassociateWithTaskReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/index.js +1 -0
- package/dist/cjs/api/types/Contact1.d.ts +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/orgs/resources/accounts/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/accounts/client/Client.mjs +5 -1
- package/dist/esm/api/resources/orgs/resources/accounts/client/requests/AccountsListV1Request.d.mts +3 -0
- package/dist/esm/api/resources/orgs/resources/contacts/client/Client.d.mts +30 -0
- package/dist/esm/api/resources/orgs/resources/contacts/client/Client.mjs +125 -0
- package/dist/esm/api/resources/orgs/resources/contacts/client/requests/ContactAccountAddReq.d.mts +12 -0
- package/dist/esm/api/resources/orgs/resources/contacts/client/requests/ContactAccountAddReq.mjs +4 -0
- package/dist/esm/api/resources/orgs/resources/contacts/client/requests/ContactClientCreate1.d.mts +1 -1
- package/dist/esm/api/resources/orgs/resources/contacts/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/Client.d.mts +53 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/Client.mjs +200 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/CargoAddToOrderReq.d.mts +18 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/CargoAddToOrderReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/CargoAssociateWithTaskReq.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/CargoAssociateWithTaskReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/CargoUnassociateWithTaskReq.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/CargoUnassociateWithTaskReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/index.mjs +1 -0
- package/dist/esm/api/types/Contact1.d.mts +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +348 -0
package/dist/cjs/Client.js
CHANGED
|
@@ -57,8 +57,8 @@ class ChrtClient {
|
|
|
57
57
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
58
58
|
"X-Fern-Language": "JavaScript",
|
|
59
59
|
"X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
|
|
60
|
-
"X-Fern-SDK-Version": "1.
|
|
61
|
-
"User-Agent": "@chrt-inc/typescript-sdk/1.
|
|
60
|
+
"X-Fern-SDK-Version": "1.888.0",
|
|
61
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.888.0",
|
|
62
62
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
63
63
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
64
64
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -57,6 +57,7 @@ export declare class Accounts {
|
|
|
57
57
|
* @example
|
|
58
58
|
* await client.orgs.accounts.listV1({
|
|
59
59
|
* search: "search",
|
|
60
|
+
* filter_account_id: "filter_account_id",
|
|
60
61
|
* filter_org_id: "filter_org_id",
|
|
61
62
|
* filter_off_chrt_org_data_id: "filter_off_chrt_org_data_id",
|
|
62
63
|
* sort_by: "name",
|
|
@@ -131,6 +131,7 @@ class Accounts {
|
|
|
131
131
|
* @example
|
|
132
132
|
* await client.orgs.accounts.listV1({
|
|
133
133
|
* search: "search",
|
|
134
|
+
* filter_account_id: "filter_account_id",
|
|
134
135
|
* filter_org_id: "filter_org_id",
|
|
135
136
|
* filter_off_chrt_org_data_id: "filter_off_chrt_org_data_id",
|
|
136
137
|
* sort_by: "name",
|
|
@@ -145,11 +146,14 @@ class Accounts {
|
|
|
145
146
|
__listV1() {
|
|
146
147
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
147
148
|
var _a, _b, _c, _d, _e, _f;
|
|
148
|
-
const { search, filter_org_id: filterOrgId, filter_off_chrt_org_data_id: filterOffChrtOrgDataId, sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, } = request;
|
|
149
|
+
const { search, filter_account_id: filterAccountId, filter_org_id: filterOrgId, filter_off_chrt_org_data_id: filterOffChrtOrgDataId, sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, } = request;
|
|
149
150
|
const _queryParams = {};
|
|
150
151
|
if (search !== undefined) {
|
|
151
152
|
_queryParams["search"] = search;
|
|
152
153
|
}
|
|
154
|
+
if (filterAccountId !== undefined) {
|
|
155
|
+
_queryParams["filter_account_id"] = filterAccountId;
|
|
156
|
+
}
|
|
153
157
|
if (filterOrgId !== undefined) {
|
|
154
158
|
_queryParams["filter_org_id"] = filterOrgId;
|
|
155
159
|
}
|
package/dist/cjs/api/resources/orgs/resources/accounts/client/requests/AccountsListV1Request.d.ts
CHANGED
|
@@ -6,6 +6,7 @@ import * as Chrt from "../../../../../../index.js";
|
|
|
6
6
|
* @example
|
|
7
7
|
* {
|
|
8
8
|
* search: "search",
|
|
9
|
+
* filter_account_id: "filter_account_id",
|
|
9
10
|
* filter_org_id: "filter_org_id",
|
|
10
11
|
* filter_off_chrt_org_data_id: "filter_off_chrt_org_data_id",
|
|
11
12
|
* sort_by: "name",
|
|
@@ -17,6 +18,8 @@ import * as Chrt from "../../../../../../index.js";
|
|
|
17
18
|
export interface AccountsListV1Request {
|
|
18
19
|
/** Full-text account name search query */
|
|
19
20
|
search?: string | null;
|
|
21
|
+
/** Filter by account ID */
|
|
22
|
+
filter_account_id?: string | null;
|
|
20
23
|
/** Filter by associated on-CHRT shipper organization */
|
|
21
24
|
filter_org_id?: string | null;
|
|
22
25
|
/** Filter by associated off-CHRT shipper organization data */
|
|
@@ -30,6 +30,36 @@ export declare namespace Contacts {
|
|
|
30
30
|
export declare class Contacts {
|
|
31
31
|
protected readonly _options: Contacts.Options;
|
|
32
32
|
constructor(_options?: Contacts.Options);
|
|
33
|
+
/**
|
|
34
|
+
* Associates an account from the contact's organization. | authz: min_org_role=operator | (ContactAccountAddReq) -> (bool)
|
|
35
|
+
*
|
|
36
|
+
* @param {string} contactId
|
|
37
|
+
* @param {Chrt.orgs.ContactAccountAddReq} request
|
|
38
|
+
* @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* await client.orgs.contacts.accountAddV1("contact_id", {
|
|
44
|
+
* account_id: "account_id"
|
|
45
|
+
* })
|
|
46
|
+
*/
|
|
47
|
+
accountAddV1(contactId: string, request: Chrt.orgs.ContactAccountAddReq, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
48
|
+
private __accountAddV1;
|
|
49
|
+
/**
|
|
50
|
+
* Removes an account association from an organization-created contact. | authz: min_org_role=operator | () -> (bool)
|
|
51
|
+
*
|
|
52
|
+
* @param {string} contactId
|
|
53
|
+
* @param {string} accountId
|
|
54
|
+
* @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* await client.orgs.contacts.accountRemoveV1("contact_id", "account_id")
|
|
60
|
+
*/
|
|
61
|
+
accountRemoveV1(contactId: string, accountId: string, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
62
|
+
private __accountRemoveV1;
|
|
33
63
|
/**
|
|
34
64
|
* Creates an organization-created contact. | authz: min_org_role=operator | (ContactClientCreate1) -> (PydanticObjectId)
|
|
35
65
|
*
|
|
@@ -55,6 +55,131 @@ class Contacts {
|
|
|
55
55
|
constructor(_options = {}) {
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
|
+
/**
|
|
59
|
+
* Associates an account from the contact's organization. | authz: min_org_role=operator | (ContactAccountAddReq) -> (bool)
|
|
60
|
+
*
|
|
61
|
+
* @param {string} contactId
|
|
62
|
+
* @param {Chrt.orgs.ContactAccountAddReq} request
|
|
63
|
+
* @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* await client.orgs.contacts.accountAddV1("contact_id", {
|
|
69
|
+
* account_id: "account_id"
|
|
70
|
+
* })
|
|
71
|
+
*/
|
|
72
|
+
accountAddV1(contactId, request, requestOptions) {
|
|
73
|
+
return core.HttpResponsePromise.fromPromise(this.__accountAddV1(contactId, request, requestOptions));
|
|
74
|
+
}
|
|
75
|
+
__accountAddV1(contactId, request, requestOptions) {
|
|
76
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
77
|
+
var _a, _b, _c, _d;
|
|
78
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
79
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
80
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `orgs/contacts/accounts/add/v1/${encodeURIComponent(contactId)}`),
|
|
81
|
+
method: "POST",
|
|
82
|
+
headers: _headers,
|
|
83
|
+
contentType: "application/json",
|
|
84
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
85
|
+
requestType: "json",
|
|
86
|
+
body: request,
|
|
87
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
88
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
89
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
90
|
+
});
|
|
91
|
+
if (_response.ok) {
|
|
92
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
93
|
+
}
|
|
94
|
+
if (_response.error.reason === "status-code") {
|
|
95
|
+
switch (_response.error.statusCode) {
|
|
96
|
+
case 422:
|
|
97
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
98
|
+
default:
|
|
99
|
+
throw new errors.ChrtError({
|
|
100
|
+
statusCode: _response.error.statusCode,
|
|
101
|
+
body: _response.error.body,
|
|
102
|
+
rawResponse: _response.rawResponse,
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
switch (_response.error.reason) {
|
|
107
|
+
case "non-json":
|
|
108
|
+
throw new errors.ChrtError({
|
|
109
|
+
statusCode: _response.error.statusCode,
|
|
110
|
+
body: _response.error.rawBody,
|
|
111
|
+
rawResponse: _response.rawResponse,
|
|
112
|
+
});
|
|
113
|
+
case "timeout":
|
|
114
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /orgs/contacts/accounts/add/v1/{contact_id}.");
|
|
115
|
+
case "unknown":
|
|
116
|
+
throw new errors.ChrtError({
|
|
117
|
+
message: _response.error.errorMessage,
|
|
118
|
+
rawResponse: _response.rawResponse,
|
|
119
|
+
});
|
|
120
|
+
}
|
|
121
|
+
});
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* Removes an account association from an organization-created contact. | authz: min_org_role=operator | () -> (bool)
|
|
125
|
+
*
|
|
126
|
+
* @param {string} contactId
|
|
127
|
+
* @param {string} accountId
|
|
128
|
+
* @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
131
|
+
*
|
|
132
|
+
* @example
|
|
133
|
+
* await client.orgs.contacts.accountRemoveV1("contact_id", "account_id")
|
|
134
|
+
*/
|
|
135
|
+
accountRemoveV1(contactId, accountId, requestOptions) {
|
|
136
|
+
return core.HttpResponsePromise.fromPromise(this.__accountRemoveV1(contactId, accountId, requestOptions));
|
|
137
|
+
}
|
|
138
|
+
__accountRemoveV1(contactId, accountId, requestOptions) {
|
|
139
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
140
|
+
var _a, _b, _c, _d;
|
|
141
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
142
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
143
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `orgs/contacts/accounts/remove/v1/${encodeURIComponent(contactId)}/${encodeURIComponent(accountId)}`),
|
|
144
|
+
method: "DELETE",
|
|
145
|
+
headers: _headers,
|
|
146
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
147
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
148
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
149
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
150
|
+
});
|
|
151
|
+
if (_response.ok) {
|
|
152
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
153
|
+
}
|
|
154
|
+
if (_response.error.reason === "status-code") {
|
|
155
|
+
switch (_response.error.statusCode) {
|
|
156
|
+
case 422:
|
|
157
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
158
|
+
default:
|
|
159
|
+
throw new errors.ChrtError({
|
|
160
|
+
statusCode: _response.error.statusCode,
|
|
161
|
+
body: _response.error.body,
|
|
162
|
+
rawResponse: _response.rawResponse,
|
|
163
|
+
});
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
switch (_response.error.reason) {
|
|
167
|
+
case "non-json":
|
|
168
|
+
throw new errors.ChrtError({
|
|
169
|
+
statusCode: _response.error.statusCode,
|
|
170
|
+
body: _response.error.rawBody,
|
|
171
|
+
rawResponse: _response.rawResponse,
|
|
172
|
+
});
|
|
173
|
+
case "timeout":
|
|
174
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling DELETE /orgs/contacts/accounts/remove/v1/{contact_id}/{account_id}.");
|
|
175
|
+
case "unknown":
|
|
176
|
+
throw new errors.ChrtError({
|
|
177
|
+
message: _response.error.errorMessage,
|
|
178
|
+
rawResponse: _response.rawResponse,
|
|
179
|
+
});
|
|
180
|
+
}
|
|
181
|
+
});
|
|
182
|
+
}
|
|
58
183
|
/**
|
|
59
184
|
* Creates an organization-created contact. | authz: min_org_role=operator | (ContactClientCreate1) -> (PydanticObjectId)
|
|
60
185
|
*
|
package/dist/cjs/api/resources/orgs/resources/contacts/client/requests/ContactClientCreate1.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ import * as Chrt from "../../../../../../index.js";
|
|
|
10
10
|
* }
|
|
11
11
|
*/
|
|
12
12
|
export interface ContactClientCreate1 {
|
|
13
|
-
|
|
13
|
+
account_ids?: string[];
|
|
14
14
|
email_address?: string | null;
|
|
15
15
|
job_title?: string | null;
|
|
16
16
|
location?: Chrt.LocationFeature | null;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export { type ContactAccountAddReq } from "./ContactAccountAddReq.js";
|
|
1
2
|
export { type ContactClientCreate1 } from "./ContactClientCreate1.js";
|
|
2
3
|
export { type ContactsListV1Request } from "./ContactsListV1Request.js";
|
|
3
4
|
export { type ContactClientUpdate1 } from "./ContactClientUpdate1.js";
|
|
@@ -30,6 +30,59 @@ export declare namespace Cargos {
|
|
|
30
30
|
export declare class Cargos {
|
|
31
31
|
protected readonly _options: Cargos.Options;
|
|
32
32
|
constructor(_options?: Cargos.Options);
|
|
33
|
+
/**
|
|
34
|
+
* Adds cargo to a non-DRAFT order. Cargo added to a terminal order starts terminal; otherwise it starts STAGED. | authz_personas=[coordinator_org_operators] | (CargoAddToOrderReq) -> (PydanticObjectId)
|
|
35
|
+
*
|
|
36
|
+
* @param {Chrt.shipping.CargoAddToOrderReq} request
|
|
37
|
+
* @param {Cargos.RequestOptions} requestOptions - Request-specific configuration.
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* await client.shipping.cargos.addV1({
|
|
43
|
+
* cargo: {
|
|
44
|
+
* cargo_type: "spare_parts",
|
|
45
|
+
* schema_version: 1
|
|
46
|
+
* },
|
|
47
|
+
* order_id: "order_id"
|
|
48
|
+
* })
|
|
49
|
+
*/
|
|
50
|
+
addV1(request: Chrt.shipping.CargoAddToOrderReq, requestOptions?: Cargos.RequestOptions): core.HttpResponsePromise<string>;
|
|
51
|
+
private __addV1;
|
|
52
|
+
/**
|
|
53
|
+
* Associates cargo with a task on a non-DRAFT order, then derives cargo status from all associated tasks in the order's task sequence. | authz_personas=[coordinator_org_operators] | (CargoAssociateWithTaskReq) -> (bool)
|
|
54
|
+
*
|
|
55
|
+
* @param {Chrt.shipping.CargoAssociateWithTaskReq} request
|
|
56
|
+
* @param {Cargos.RequestOptions} requestOptions - Request-specific configuration.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* await client.shipping.cargos.associateWithTaskV1({
|
|
62
|
+
* cargo_id: "cargo_id",
|
|
63
|
+
* order_id: "order_id",
|
|
64
|
+
* task_id: "task_id"
|
|
65
|
+
* })
|
|
66
|
+
*/
|
|
67
|
+
associateWithTaskV1(request: Chrt.shipping.CargoAssociateWithTaskReq, requestOptions?: Cargos.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
68
|
+
private __associateWithTaskV1;
|
|
69
|
+
/**
|
|
70
|
+
* Removes a cargo association from a task on a non-DRAFT order, then derives cargo status from the remaining associated tasks in the order's task sequence. | authz_personas=[coordinator_org_operators] | (CargoUnassociateWithTaskReq) -> (bool)
|
|
71
|
+
*
|
|
72
|
+
* @param {Chrt.shipping.CargoUnassociateWithTaskReq} request
|
|
73
|
+
* @param {Cargos.RequestOptions} requestOptions - Request-specific configuration.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* await client.shipping.cargos.unassociateWithTaskV1({
|
|
79
|
+
* cargo_id: "cargo_id",
|
|
80
|
+
* order_id: "order_id",
|
|
81
|
+
* task_id: "task_id"
|
|
82
|
+
* })
|
|
83
|
+
*/
|
|
84
|
+
unassociateWithTaskV1(request: Chrt.shipping.CargoUnassociateWithTaskReq, requestOptions?: Cargos.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
85
|
+
private __unassociateWithTaskV1;
|
|
33
86
|
/**
|
|
34
87
|
* Updates cargo details and synchronizes its parent order's AWB list. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_owner_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
35
88
|
*
|
|
@@ -55,6 +55,206 @@ class Cargos {
|
|
|
55
55
|
constructor(_options = {}) {
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
|
+
/**
|
|
59
|
+
* Adds cargo to a non-DRAFT order. Cargo added to a terminal order starts terminal; otherwise it starts STAGED. | authz_personas=[coordinator_org_operators] | (CargoAddToOrderReq) -> (PydanticObjectId)
|
|
60
|
+
*
|
|
61
|
+
* @param {Chrt.shipping.CargoAddToOrderReq} request
|
|
62
|
+
* @param {Cargos.RequestOptions} requestOptions - Request-specific configuration.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* await client.shipping.cargos.addV1({
|
|
68
|
+
* cargo: {
|
|
69
|
+
* cargo_type: "spare_parts",
|
|
70
|
+
* schema_version: 1
|
|
71
|
+
* },
|
|
72
|
+
* order_id: "order_id"
|
|
73
|
+
* })
|
|
74
|
+
*/
|
|
75
|
+
addV1(request, requestOptions) {
|
|
76
|
+
return core.HttpResponsePromise.fromPromise(this.__addV1(request, requestOptions));
|
|
77
|
+
}
|
|
78
|
+
__addV1(request, requestOptions) {
|
|
79
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
80
|
+
var _a, _b, _c, _d;
|
|
81
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
82
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
83
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "shipping/cargos/add/v1"),
|
|
84
|
+
method: "POST",
|
|
85
|
+
headers: _headers,
|
|
86
|
+
contentType: "application/json",
|
|
87
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
88
|
+
requestType: "json",
|
|
89
|
+
body: request,
|
|
90
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
91
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
92
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
93
|
+
});
|
|
94
|
+
if (_response.ok) {
|
|
95
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
96
|
+
}
|
|
97
|
+
if (_response.error.reason === "status-code") {
|
|
98
|
+
switch (_response.error.statusCode) {
|
|
99
|
+
case 422:
|
|
100
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
101
|
+
default:
|
|
102
|
+
throw new errors.ChrtError({
|
|
103
|
+
statusCode: _response.error.statusCode,
|
|
104
|
+
body: _response.error.body,
|
|
105
|
+
rawResponse: _response.rawResponse,
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
switch (_response.error.reason) {
|
|
110
|
+
case "non-json":
|
|
111
|
+
throw new errors.ChrtError({
|
|
112
|
+
statusCode: _response.error.statusCode,
|
|
113
|
+
body: _response.error.rawBody,
|
|
114
|
+
rawResponse: _response.rawResponse,
|
|
115
|
+
});
|
|
116
|
+
case "timeout":
|
|
117
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/cargos/add/v1.");
|
|
118
|
+
case "unknown":
|
|
119
|
+
throw new errors.ChrtError({
|
|
120
|
+
message: _response.error.errorMessage,
|
|
121
|
+
rawResponse: _response.rawResponse,
|
|
122
|
+
});
|
|
123
|
+
}
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Associates cargo with a task on a non-DRAFT order, then derives cargo status from all associated tasks in the order's task sequence. | authz_personas=[coordinator_org_operators] | (CargoAssociateWithTaskReq) -> (bool)
|
|
128
|
+
*
|
|
129
|
+
* @param {Chrt.shipping.CargoAssociateWithTaskReq} request
|
|
130
|
+
* @param {Cargos.RequestOptions} requestOptions - Request-specific configuration.
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
133
|
+
*
|
|
134
|
+
* @example
|
|
135
|
+
* await client.shipping.cargos.associateWithTaskV1({
|
|
136
|
+
* cargo_id: "cargo_id",
|
|
137
|
+
* order_id: "order_id",
|
|
138
|
+
* task_id: "task_id"
|
|
139
|
+
* })
|
|
140
|
+
*/
|
|
141
|
+
associateWithTaskV1(request, requestOptions) {
|
|
142
|
+
return core.HttpResponsePromise.fromPromise(this.__associateWithTaskV1(request, requestOptions));
|
|
143
|
+
}
|
|
144
|
+
__associateWithTaskV1(request, requestOptions) {
|
|
145
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
146
|
+
var _a, _b, _c, _d;
|
|
147
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
148
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
149
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "shipping/cargos/associate_with_task/v1"),
|
|
150
|
+
method: "POST",
|
|
151
|
+
headers: _headers,
|
|
152
|
+
contentType: "application/json",
|
|
153
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
154
|
+
requestType: "json",
|
|
155
|
+
body: request,
|
|
156
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
157
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
158
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
159
|
+
});
|
|
160
|
+
if (_response.ok) {
|
|
161
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
162
|
+
}
|
|
163
|
+
if (_response.error.reason === "status-code") {
|
|
164
|
+
switch (_response.error.statusCode) {
|
|
165
|
+
case 422:
|
|
166
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
167
|
+
default:
|
|
168
|
+
throw new errors.ChrtError({
|
|
169
|
+
statusCode: _response.error.statusCode,
|
|
170
|
+
body: _response.error.body,
|
|
171
|
+
rawResponse: _response.rawResponse,
|
|
172
|
+
});
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
switch (_response.error.reason) {
|
|
176
|
+
case "non-json":
|
|
177
|
+
throw new errors.ChrtError({
|
|
178
|
+
statusCode: _response.error.statusCode,
|
|
179
|
+
body: _response.error.rawBody,
|
|
180
|
+
rawResponse: _response.rawResponse,
|
|
181
|
+
});
|
|
182
|
+
case "timeout":
|
|
183
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/cargos/associate_with_task/v1.");
|
|
184
|
+
case "unknown":
|
|
185
|
+
throw new errors.ChrtError({
|
|
186
|
+
message: _response.error.errorMessage,
|
|
187
|
+
rawResponse: _response.rawResponse,
|
|
188
|
+
});
|
|
189
|
+
}
|
|
190
|
+
});
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* Removes a cargo association from a task on a non-DRAFT order, then derives cargo status from the remaining associated tasks in the order's task sequence. | authz_personas=[coordinator_org_operators] | (CargoUnassociateWithTaskReq) -> (bool)
|
|
194
|
+
*
|
|
195
|
+
* @param {Chrt.shipping.CargoUnassociateWithTaskReq} request
|
|
196
|
+
* @param {Cargos.RequestOptions} requestOptions - Request-specific configuration.
|
|
197
|
+
*
|
|
198
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
199
|
+
*
|
|
200
|
+
* @example
|
|
201
|
+
* await client.shipping.cargos.unassociateWithTaskV1({
|
|
202
|
+
* cargo_id: "cargo_id",
|
|
203
|
+
* order_id: "order_id",
|
|
204
|
+
* task_id: "task_id"
|
|
205
|
+
* })
|
|
206
|
+
*/
|
|
207
|
+
unassociateWithTaskV1(request, requestOptions) {
|
|
208
|
+
return core.HttpResponsePromise.fromPromise(this.__unassociateWithTaskV1(request, requestOptions));
|
|
209
|
+
}
|
|
210
|
+
__unassociateWithTaskV1(request, requestOptions) {
|
|
211
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
212
|
+
var _a, _b, _c, _d;
|
|
213
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
214
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
215
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "shipping/cargos/unassociate_with_task/v1"),
|
|
216
|
+
method: "POST",
|
|
217
|
+
headers: _headers,
|
|
218
|
+
contentType: "application/json",
|
|
219
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
220
|
+
requestType: "json",
|
|
221
|
+
body: request,
|
|
222
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
223
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
224
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
225
|
+
});
|
|
226
|
+
if (_response.ok) {
|
|
227
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
228
|
+
}
|
|
229
|
+
if (_response.error.reason === "status-code") {
|
|
230
|
+
switch (_response.error.statusCode) {
|
|
231
|
+
case 422:
|
|
232
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
233
|
+
default:
|
|
234
|
+
throw new errors.ChrtError({
|
|
235
|
+
statusCode: _response.error.statusCode,
|
|
236
|
+
body: _response.error.body,
|
|
237
|
+
rawResponse: _response.rawResponse,
|
|
238
|
+
});
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
switch (_response.error.reason) {
|
|
242
|
+
case "non-json":
|
|
243
|
+
throw new errors.ChrtError({
|
|
244
|
+
statusCode: _response.error.statusCode,
|
|
245
|
+
body: _response.error.rawBody,
|
|
246
|
+
rawResponse: _response.rawResponse,
|
|
247
|
+
});
|
|
248
|
+
case "timeout":
|
|
249
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/cargos/unassociate_with_task/v1.");
|
|
250
|
+
case "unknown":
|
|
251
|
+
throw new errors.ChrtError({
|
|
252
|
+
message: _response.error.errorMessage,
|
|
253
|
+
rawResponse: _response.rawResponse,
|
|
254
|
+
});
|
|
255
|
+
}
|
|
256
|
+
});
|
|
257
|
+
}
|
|
58
258
|
/**
|
|
59
259
|
* Updates cargo details and synchronizes its parent order's AWB list. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_owner_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
60
260
|
*
|
|
@@ -1,2 +1,17 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
2
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./requests/index.js"), exports);
|
package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/CargoAddToOrderReq.d.ts
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../../../../../../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {
|
|
8
|
+
* cargo: {
|
|
9
|
+
* cargo_type: "spare_parts",
|
|
10
|
+
* schema_version: 1
|
|
11
|
+
* },
|
|
12
|
+
* order_id: "order_id"
|
|
13
|
+
* }
|
|
14
|
+
*/
|
|
15
|
+
export interface CargoAddToOrderReq {
|
|
16
|
+
cargo: Chrt.CargoClientCreate1;
|
|
17
|
+
order_id: string;
|
|
18
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* cargo_id: "cargo_id",
|
|
8
|
+
* order_id: "order_id",
|
|
9
|
+
* task_id: "task_id"
|
|
10
|
+
* }
|
|
11
|
+
*/
|
|
12
|
+
export interface CargoAssociateWithTaskReq {
|
|
13
|
+
cargo_id: string;
|
|
14
|
+
order_id: string;
|
|
15
|
+
task_id: string;
|
|
16
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* cargo_id: "cargo_id",
|
|
8
|
+
* order_id: "order_id",
|
|
9
|
+
* task_id: "task_id"
|
|
10
|
+
* }
|
|
11
|
+
*/
|
|
12
|
+
export interface CargoUnassociateWithTaskReq {
|
|
13
|
+
cargo_id: string;
|
|
14
|
+
order_id: string;
|
|
15
|
+
task_id: string;
|
|
16
|
+
}
|