@chrt-inc/typescript-sdk 1.658.0 → 1.661.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/billing/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/billing/client/Client.js +5 -0
- package/dist/cjs/api/resources/billing/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/index.js +2 -1
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.d.ts +13 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.js +59 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/client/Client.d.ts +23 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/client/Client.js +17 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/client/index.js +2 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/index.d.ts +2 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/index.js +18 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/resources/index.js +41 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/resources/s3Objects/client/Client.d.ts +83 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/resources/s3Objects/client/Client.js +308 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/resources/s3Objects/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/resources/s3Objects/client/index.js +17 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/resources/s3Objects/client/requests/BodyLineItemsS3ObjectPostAddV1BillingLineItemsS3ObjectsAddV1LineItemIdPost.d.ts +13 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/resources/s3Objects/client/requests/BodyLineItemsS3ObjectPostAddV1BillingLineItemsS3ObjectsAddV1LineItemIdPost.js +5 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/resources/s3Objects/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/resources/s3Objects/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/resources/s3Objects/index.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/lineItems/resources/s3Objects/index.js +17 -0
- package/dist/cjs/api/types/LineItemGroupLineItemsRes.d.ts +11 -0
- package/dist/cjs/api/types/LineItemGroupLineItemsRes.js +5 -0
- package/dist/cjs/api/types/LineItemS3ObjectMetadata1.d.ts +19 -0
- package/dist/cjs/api/types/LineItemS3ObjectMetadata1.js +5 -0
- package/dist/cjs/api/types/index.d.ts +2 -0
- package/dist/cjs/api/types/index.js +2 -0
- 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/billing/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/billing/client/Client.mjs +5 -0
- package/dist/esm/api/resources/billing/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/index.mjs +1 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.d.mts +13 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.mjs +59 -0
- package/dist/esm/api/resources/billing/resources/lineItems/client/Client.d.mts +23 -0
- package/dist/esm/api/resources/billing/resources/lineItems/client/Client.mjs +13 -0
- package/dist/esm/api/resources/billing/resources/lineItems/client/index.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/lineItems/client/index.mjs +1 -0
- package/dist/esm/api/resources/billing/resources/lineItems/index.d.mts +2 -0
- package/dist/esm/api/resources/billing/resources/lineItems/index.mjs +2 -0
- package/dist/esm/api/resources/billing/resources/lineItems/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/billing/resources/lineItems/resources/index.mjs +2 -0
- package/dist/esm/api/resources/billing/resources/lineItems/resources/s3Objects/client/Client.d.mts +83 -0
- package/dist/esm/api/resources/billing/resources/lineItems/resources/s3Objects/client/Client.mjs +271 -0
- package/dist/esm/api/resources/billing/resources/lineItems/resources/s3Objects/client/index.d.mts +2 -0
- package/dist/esm/api/resources/billing/resources/lineItems/resources/s3Objects/client/index.mjs +1 -0
- package/dist/esm/api/resources/billing/resources/lineItems/resources/s3Objects/client/requests/BodyLineItemsS3ObjectPostAddV1BillingLineItemsS3ObjectsAddV1LineItemIdPost.d.mts +13 -0
- package/dist/esm/api/resources/billing/resources/lineItems/resources/s3Objects/client/requests/BodyLineItemsS3ObjectPostAddV1BillingLineItemsS3ObjectsAddV1LineItemIdPost.mjs +4 -0
- package/dist/esm/api/resources/billing/resources/lineItems/resources/s3Objects/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/lineItems/resources/s3Objects/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/billing/resources/lineItems/resources/s3Objects/index.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/lineItems/resources/s3Objects/index.mjs +1 -0
- package/dist/esm/api/types/LineItemGroupLineItemsRes.d.mts +11 -0
- package/dist/esm/api/types/LineItemGroupLineItemsRes.mjs +4 -0
- package/dist/esm/api/types/LineItemS3ObjectMetadata1.d.mts +19 -0
- package/dist/esm/api/types/LineItemS3ObjectMetadata1.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +2 -0
- package/dist/esm/api/types/index.mjs +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +327 -0
package/reference.md
CHANGED
|
@@ -1129,6 +1129,69 @@ await client.billing.lineItemGroups.getByIdV1("id");
|
|
|
1129
1129
|
</dl>
|
|
1130
1130
|
</details>
|
|
1131
1131
|
|
|
1132
|
+
<details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">getLineItemsV1</a>(lineItemGroupId) -> Chrt.LineItemGroupLineItemsRes</code></summary>
|
|
1133
|
+
<dl>
|
|
1134
|
+
<dd>
|
|
1135
|
+
|
|
1136
|
+
#### 📝 Description
|
|
1137
|
+
|
|
1138
|
+
<dl>
|
|
1139
|
+
<dd>
|
|
1140
|
+
|
|
1141
|
+
<dl>
|
|
1142
|
+
<dd>
|
|
1143
|
+
|
|
1144
|
+
Retrieves all LineItems referenced by a LineItemGroup the caller can access. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroupLineItemsRes)
|
|
1145
|
+
|
|
1146
|
+
</dd>
|
|
1147
|
+
</dl>
|
|
1148
|
+
</dd>
|
|
1149
|
+
</dl>
|
|
1150
|
+
|
|
1151
|
+
#### 🔌 Usage
|
|
1152
|
+
|
|
1153
|
+
<dl>
|
|
1154
|
+
<dd>
|
|
1155
|
+
|
|
1156
|
+
<dl>
|
|
1157
|
+
<dd>
|
|
1158
|
+
|
|
1159
|
+
```typescript
|
|
1160
|
+
await client.billing.lineItemGroups.getLineItemsV1("line_item_group_id");
|
|
1161
|
+
```
|
|
1162
|
+
|
|
1163
|
+
</dd>
|
|
1164
|
+
</dl>
|
|
1165
|
+
</dd>
|
|
1166
|
+
</dl>
|
|
1167
|
+
|
|
1168
|
+
#### ⚙️ Parameters
|
|
1169
|
+
|
|
1170
|
+
<dl>
|
|
1171
|
+
<dd>
|
|
1172
|
+
|
|
1173
|
+
<dl>
|
|
1174
|
+
<dd>
|
|
1175
|
+
|
|
1176
|
+
**lineItemGroupId:** `string`
|
|
1177
|
+
|
|
1178
|
+
</dd>
|
|
1179
|
+
</dl>
|
|
1180
|
+
|
|
1181
|
+
<dl>
|
|
1182
|
+
<dd>
|
|
1183
|
+
|
|
1184
|
+
**requestOptions:** `LineItemGroups.RequestOptions`
|
|
1185
|
+
|
|
1186
|
+
</dd>
|
|
1187
|
+
</dl>
|
|
1188
|
+
</dd>
|
|
1189
|
+
</dl>
|
|
1190
|
+
|
|
1191
|
+
</dd>
|
|
1192
|
+
</dl>
|
|
1193
|
+
</details>
|
|
1194
|
+
|
|
1132
1195
|
<details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">listV1</a>({ ...params }) -> Chrt.LineItemGroupListRes</code></summary>
|
|
1133
1196
|
<dl>
|
|
1134
1197
|
<dd>
|
|
@@ -5768,6 +5831,270 @@ await client.billing.lineItemGroups.s3Objects.deleteV1("line_item_group_s3_objec
|
|
|
5768
5831
|
</dl>
|
|
5769
5832
|
</details>
|
|
5770
5833
|
|
|
5834
|
+
## Billing LineItems S3Objects
|
|
5835
|
+
|
|
5836
|
+
<details><summary><code>client.billing.lineItems.s3Objects.<a href="/src/api/resources/billing/resources/lineItems/resources/s3Objects/client/Client.ts">getS3ObjectMetadataV1</a>(lineItemS3ObjectMetadataId) -> Chrt.LineItemS3ObjectMetadata1</code></summary>
|
|
5837
|
+
<dl>
|
|
5838
|
+
<dd>
|
|
5839
|
+
|
|
5840
|
+
#### 📝 Description
|
|
5841
|
+
|
|
5842
|
+
<dl>
|
|
5843
|
+
<dd>
|
|
5844
|
+
|
|
5845
|
+
<dl>
|
|
5846
|
+
<dd>
|
|
5847
|
+
|
|
5848
|
+
Retrieves metadata for a line item S3 object. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemS3ObjectMetadata1)
|
|
5849
|
+
|
|
5850
|
+
</dd>
|
|
5851
|
+
</dl>
|
|
5852
|
+
</dd>
|
|
5853
|
+
</dl>
|
|
5854
|
+
|
|
5855
|
+
#### 🔌 Usage
|
|
5856
|
+
|
|
5857
|
+
<dl>
|
|
5858
|
+
<dd>
|
|
5859
|
+
|
|
5860
|
+
<dl>
|
|
5861
|
+
<dd>
|
|
5862
|
+
|
|
5863
|
+
```typescript
|
|
5864
|
+
await client.billing.lineItems.s3Objects.getS3ObjectMetadataV1("line_item_s3_object_metadata_id");
|
|
5865
|
+
```
|
|
5866
|
+
|
|
5867
|
+
</dd>
|
|
5868
|
+
</dl>
|
|
5869
|
+
</dd>
|
|
5870
|
+
</dl>
|
|
5871
|
+
|
|
5872
|
+
#### ⚙️ Parameters
|
|
5873
|
+
|
|
5874
|
+
<dl>
|
|
5875
|
+
<dd>
|
|
5876
|
+
|
|
5877
|
+
<dl>
|
|
5878
|
+
<dd>
|
|
5879
|
+
|
|
5880
|
+
**lineItemS3ObjectMetadataId:** `string`
|
|
5881
|
+
|
|
5882
|
+
</dd>
|
|
5883
|
+
</dl>
|
|
5884
|
+
|
|
5885
|
+
<dl>
|
|
5886
|
+
<dd>
|
|
5887
|
+
|
|
5888
|
+
**requestOptions:** `S3Objects.RequestOptions`
|
|
5889
|
+
|
|
5890
|
+
</dd>
|
|
5891
|
+
</dl>
|
|
5892
|
+
</dd>
|
|
5893
|
+
</dl>
|
|
5894
|
+
|
|
5895
|
+
</dd>
|
|
5896
|
+
</dl>
|
|
5897
|
+
</details>
|
|
5898
|
+
|
|
5899
|
+
<details><summary><code>client.billing.lineItems.s3Objects.<a href="/src/api/resources/billing/resources/lineItems/resources/s3Objects/client/Client.ts">getV1</a>(lineItemS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
5900
|
+
<dl>
|
|
5901
|
+
<dd>
|
|
5902
|
+
|
|
5903
|
+
#### 📝 Description
|
|
5904
|
+
|
|
5905
|
+
<dl>
|
|
5906
|
+
<dd>
|
|
5907
|
+
|
|
5908
|
+
<dl>
|
|
5909
|
+
<dd>
|
|
5910
|
+
|
|
5911
|
+
Streams a line item S3 object file from storage. | authz_personas=[lig_org_operators, lig_driver] | () -> (binary)
|
|
5912
|
+
|
|
5913
|
+
</dd>
|
|
5914
|
+
</dl>
|
|
5915
|
+
</dd>
|
|
5916
|
+
</dl>
|
|
5917
|
+
|
|
5918
|
+
#### 🔌 Usage
|
|
5919
|
+
|
|
5920
|
+
<dl>
|
|
5921
|
+
<dd>
|
|
5922
|
+
|
|
5923
|
+
<dl>
|
|
5924
|
+
<dd>
|
|
5925
|
+
|
|
5926
|
+
```typescript
|
|
5927
|
+
await client.billing.lineItems.s3Objects.getV1("line_item_s3_object_metadata_id");
|
|
5928
|
+
```
|
|
5929
|
+
|
|
5930
|
+
</dd>
|
|
5931
|
+
</dl>
|
|
5932
|
+
</dd>
|
|
5933
|
+
</dl>
|
|
5934
|
+
|
|
5935
|
+
#### ⚙️ Parameters
|
|
5936
|
+
|
|
5937
|
+
<dl>
|
|
5938
|
+
<dd>
|
|
5939
|
+
|
|
5940
|
+
<dl>
|
|
5941
|
+
<dd>
|
|
5942
|
+
|
|
5943
|
+
**lineItemS3ObjectMetadataId:** `string`
|
|
5944
|
+
|
|
5945
|
+
</dd>
|
|
5946
|
+
</dl>
|
|
5947
|
+
|
|
5948
|
+
<dl>
|
|
5949
|
+
<dd>
|
|
5950
|
+
|
|
5951
|
+
**requestOptions:** `S3Objects.RequestOptions`
|
|
5952
|
+
|
|
5953
|
+
</dd>
|
|
5954
|
+
</dl>
|
|
5955
|
+
</dd>
|
|
5956
|
+
</dl>
|
|
5957
|
+
|
|
5958
|
+
</dd>
|
|
5959
|
+
</dl>
|
|
5960
|
+
</details>
|
|
5961
|
+
|
|
5962
|
+
<details><summary><code>client.billing.lineItems.s3Objects.<a href="/src/api/resources/billing/resources/lineItems/resources/s3Objects/client/Client.ts">addV1</a>(lineItemId, { ...params }) -> boolean</code></summary>
|
|
5963
|
+
<dl>
|
|
5964
|
+
<dd>
|
|
5965
|
+
|
|
5966
|
+
#### 📝 Description
|
|
5967
|
+
|
|
5968
|
+
<dl>
|
|
5969
|
+
<dd>
|
|
5970
|
+
|
|
5971
|
+
<dl>
|
|
5972
|
+
<dd>
|
|
5973
|
+
|
|
5974
|
+
Uploads a file to a line item. Automatic blurhash generation for images. | authz_personas=[lig_org_operators, lig_driver] | (UploadFile) -> (bool)
|
|
5975
|
+
|
|
5976
|
+
</dd>
|
|
5977
|
+
</dl>
|
|
5978
|
+
</dd>
|
|
5979
|
+
</dl>
|
|
5980
|
+
|
|
5981
|
+
#### 🔌 Usage
|
|
5982
|
+
|
|
5983
|
+
<dl>
|
|
5984
|
+
<dd>
|
|
5985
|
+
|
|
5986
|
+
<dl>
|
|
5987
|
+
<dd>
|
|
5988
|
+
|
|
5989
|
+
```typescript
|
|
5990
|
+
await client.billing.lineItems.s3Objects.addV1("line_item_id", {
|
|
5991
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
5992
|
+
});
|
|
5993
|
+
```
|
|
5994
|
+
|
|
5995
|
+
</dd>
|
|
5996
|
+
</dl>
|
|
5997
|
+
</dd>
|
|
5998
|
+
</dl>
|
|
5999
|
+
|
|
6000
|
+
#### ⚙️ Parameters
|
|
6001
|
+
|
|
6002
|
+
<dl>
|
|
6003
|
+
<dd>
|
|
6004
|
+
|
|
6005
|
+
<dl>
|
|
6006
|
+
<dd>
|
|
6007
|
+
|
|
6008
|
+
**lineItemId:** `string`
|
|
6009
|
+
|
|
6010
|
+
</dd>
|
|
6011
|
+
</dl>
|
|
6012
|
+
|
|
6013
|
+
<dl>
|
|
6014
|
+
<dd>
|
|
6015
|
+
|
|
6016
|
+
**request:** `Chrt.billing.lineItems.BodyLineItemsS3ObjectPostAddV1BillingLineItemsS3ObjectsAddV1LineItemIdPost`
|
|
6017
|
+
|
|
6018
|
+
</dd>
|
|
6019
|
+
</dl>
|
|
6020
|
+
|
|
6021
|
+
<dl>
|
|
6022
|
+
<dd>
|
|
6023
|
+
|
|
6024
|
+
**requestOptions:** `S3Objects.RequestOptions`
|
|
6025
|
+
|
|
6026
|
+
</dd>
|
|
6027
|
+
</dl>
|
|
6028
|
+
</dd>
|
|
6029
|
+
</dl>
|
|
6030
|
+
|
|
6031
|
+
</dd>
|
|
6032
|
+
</dl>
|
|
6033
|
+
</details>
|
|
6034
|
+
|
|
6035
|
+
<details><summary><code>client.billing.lineItems.s3Objects.<a href="/src/api/resources/billing/resources/lineItems/resources/s3Objects/client/Client.ts">deleteV1</a>(lineItemS3ObjectMetadataId) -> boolean</code></summary>
|
|
6036
|
+
<dl>
|
|
6037
|
+
<dd>
|
|
6038
|
+
|
|
6039
|
+
#### 📝 Description
|
|
6040
|
+
|
|
6041
|
+
<dl>
|
|
6042
|
+
<dd>
|
|
6043
|
+
|
|
6044
|
+
<dl>
|
|
6045
|
+
<dd>
|
|
6046
|
+
|
|
6047
|
+
Deletes an S3 object metadata and the associated S3 object from a line item. | authz_personas=[lig_org_operators, lig_driver] | () -> (bool)
|
|
6048
|
+
|
|
6049
|
+
</dd>
|
|
6050
|
+
</dl>
|
|
6051
|
+
</dd>
|
|
6052
|
+
</dl>
|
|
6053
|
+
|
|
6054
|
+
#### 🔌 Usage
|
|
6055
|
+
|
|
6056
|
+
<dl>
|
|
6057
|
+
<dd>
|
|
6058
|
+
|
|
6059
|
+
<dl>
|
|
6060
|
+
<dd>
|
|
6061
|
+
|
|
6062
|
+
```typescript
|
|
6063
|
+
await client.billing.lineItems.s3Objects.deleteV1("line_item_s3_object_metadata_id");
|
|
6064
|
+
```
|
|
6065
|
+
|
|
6066
|
+
</dd>
|
|
6067
|
+
</dl>
|
|
6068
|
+
</dd>
|
|
6069
|
+
</dl>
|
|
6070
|
+
|
|
6071
|
+
#### ⚙️ Parameters
|
|
6072
|
+
|
|
6073
|
+
<dl>
|
|
6074
|
+
<dd>
|
|
6075
|
+
|
|
6076
|
+
<dl>
|
|
6077
|
+
<dd>
|
|
6078
|
+
|
|
6079
|
+
**lineItemS3ObjectMetadataId:** `string`
|
|
6080
|
+
|
|
6081
|
+
</dd>
|
|
6082
|
+
</dl>
|
|
6083
|
+
|
|
6084
|
+
<dl>
|
|
6085
|
+
<dd>
|
|
6086
|
+
|
|
6087
|
+
**requestOptions:** `S3Objects.RequestOptions`
|
|
6088
|
+
|
|
6089
|
+
</dd>
|
|
6090
|
+
</dl>
|
|
6091
|
+
</dd>
|
|
6092
|
+
</dl>
|
|
6093
|
+
|
|
6094
|
+
</dd>
|
|
6095
|
+
</dl>
|
|
6096
|
+
</details>
|
|
6097
|
+
|
|
5771
6098
|
## Integrations AirWaybills
|
|
5772
6099
|
|
|
5773
6100
|
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">createV1</a>({ ...params }) -> Chrt.ChampAirWaybill1</code></summary>
|