@whiplashmerch/whiplash-api-client 3.2.18 → 3.2.20

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.
@@ -1,4 +1,4 @@
1
- import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesBundleItem, ApiV21EntitiesCount, ApiV21EntitiesIncident, ApiV21EntitiesItem, ApiV21EntitiesItemLocation, ApiV21EntitiesItemWarehouseQuantity, ApiV21EntitiesListValue, ApiV21EntitiesLocation, ApiV21EntitiesMessage, ApiV21EntitiesOriginator, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesScancode, ApiV21EntitiesScancodeAlias, ApiV21EntitiesShipnoticeItem, ApiV21EntitiesTransaction, ApiV2EntitiesBundleItem, ApiV2EntitiesCount, ApiV2EntitiesIncident, ApiV2EntitiesItem, ApiV2EntitiesItemLocation, ApiV2EntitiesItemWarehouseQuantity, ApiV2EntitiesListValue, ApiV2EntitiesLocation, ApiV2EntitiesMessage, ApiV2EntitiesOriginator, ApiV2EntitiesResult, ApiV2EntitiesScancode, ApiV2EntitiesScancodeAlias, ApiV2EntitiesShipnoticeItem, ApiV2EntitiesTransaction, GetApiV21ItemsAggregateParams, GetApiV21ItemsCountParams, GetApiV21ItemsIdCallTraitParams, GetApiV21ItemsIdInboundParams, GetApiV21ItemsIdIncidentsCountParams, GetApiV21ItemsIdIncidentsParams, GetApiV21ItemsIdLocationsCountParams, GetApiV21ItemsIdLocationsParams, GetApiV21ItemsIdLocationsWithTransferCountParams, GetApiV21ItemsIdMessagesCountParams, GetApiV21ItemsIdMessagesParams, GetApiV21ItemsIdMetaFieldsParams, GetApiV21ItemsIdOriginatorsCountParams, GetApiV21ItemsIdOriginatorsParams, GetApiV21ItemsIdScancodeAliasesParams, GetApiV21ItemsIdScancodesCountParams, GetApiV21ItemsIdScancodesParams, GetApiV21ItemsIdShipnoticeItemsCountParams, GetApiV21ItemsIdShipnoticeItemsParams, GetApiV21ItemsIdTraitsParams, GetApiV21ItemsIdTransactionsCountParams, GetApiV21ItemsIdTransactionsParams, GetApiV21ItemsParams, GetApiV2ItemsAggregateParams, GetApiV2ItemsCountParams, GetApiV2ItemsIdCallTraitParams, GetApiV2ItemsIdInboundParams, GetApiV2ItemsIdIncidentsCountParams, GetApiV2ItemsIdIncidentsParams, GetApiV2ItemsIdLocationsCountParams, GetApiV2ItemsIdLocationsParams, GetApiV2ItemsIdLocationsWithTransferCountParams, GetApiV2ItemsIdMessagesCountParams, GetApiV2ItemsIdMessagesParams, GetApiV2ItemsIdMetaFieldsParams, GetApiV2ItemsIdOriginatorsCountParams, GetApiV2ItemsIdOriginatorsParams, GetApiV2ItemsIdScancodeAliasesParams, GetApiV2ItemsIdScancodesCountParams, GetApiV2ItemsIdScancodesParams, GetApiV2ItemsIdShipnoticeItemsCountParams, GetApiV2ItemsIdShipnoticeItemsParams, GetApiV2ItemsIdTraitsParams, GetApiV2ItemsIdTransactionsCountParams, GetApiV2ItemsIdTransactionsParams, GetApiV2ItemsParams, PostApiV21ItemsIdBundleItemsRequest, PostApiV21ItemsIdIncidentsRequest, PostApiV21ItemsIdLocationsRequest, PostApiV21ItemsIdMessagesRequest, PostApiV21ItemsIdOriginatorsRequest, PostApiV21ItemsRequest, PostApiV2ItemsIdBundleItemsRequest, PostApiV2ItemsIdIncidentsRequest, PostApiV2ItemsIdLocationsRequest, PostApiV2ItemsIdMessagesRequest, PostApiV2ItemsIdOriginatorsRequest, PostApiV2ItemsRequest, PutApiV21ItemsIdCallActionRequest, PutApiV21ItemsIdCallAsyncActionRequest, PutApiV21ItemsIdMetaFieldsRequest, PutApiV21ItemsIdRequest, PutApiV2ItemsIdCallActionRequest, PutApiV2ItemsIdCallAsyncActionRequest, PutApiV2ItemsIdMetaFieldsRequest, PutApiV2ItemsIdRequest } from "./data-contracts";
1
+ import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesBundleItem, ApiV21EntitiesCount, ApiV21EntitiesIncident, ApiV21EntitiesItem, ApiV21EntitiesItemLocation, ApiV21EntitiesItemWarehouseQuantity, ApiV21EntitiesListValue, ApiV21EntitiesLocation, ApiV21EntitiesMessage, ApiV21EntitiesOriginator, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesScancode, ApiV21EntitiesShipnoticeItem, ApiV21EntitiesTransaction, ApiV2EntitiesBundleItem, ApiV2EntitiesCount, ApiV2EntitiesIncident, ApiV2EntitiesItem, ApiV2EntitiesItemLocation, ApiV2EntitiesItemWarehouseQuantity, ApiV2EntitiesListValue, ApiV2EntitiesLocation, ApiV2EntitiesMessage, ApiV2EntitiesOriginator, ApiV2EntitiesResult, ApiV2EntitiesScancode, ApiV2EntitiesShipnoticeItem, ApiV2EntitiesTransaction, GetApiV21ItemsAggregateParams, GetApiV21ItemsCountParams, GetApiV21ItemsIdCallTraitParams, GetApiV21ItemsIdInboundParams, GetApiV21ItemsIdIncidentsCountParams, GetApiV21ItemsIdIncidentsParams, GetApiV21ItemsIdLocationsCountParams, GetApiV21ItemsIdLocationsParams, GetApiV21ItemsIdLocationsWithTransferCountParams, GetApiV21ItemsIdMessagesCountParams, GetApiV21ItemsIdMessagesParams, GetApiV21ItemsIdMetaFieldsParams, GetApiV21ItemsIdOriginatorsCountParams, GetApiV21ItemsIdOriginatorsParams, GetApiV21ItemsIdScancodesCountParams, GetApiV21ItemsIdScancodesParams, GetApiV21ItemsIdShipnoticeItemsCountParams, GetApiV21ItemsIdShipnoticeItemsParams, GetApiV21ItemsIdTraitsParams, GetApiV21ItemsIdTransactionsCountParams, GetApiV21ItemsIdTransactionsParams, GetApiV21ItemsParams, GetApiV2ItemsAggregateParams, GetApiV2ItemsCountParams, GetApiV2ItemsIdCallTraitParams, GetApiV2ItemsIdInboundParams, GetApiV2ItemsIdIncidentsCountParams, GetApiV2ItemsIdIncidentsParams, GetApiV2ItemsIdLocationsCountParams, GetApiV2ItemsIdLocationsParams, GetApiV2ItemsIdLocationsWithTransferCountParams, GetApiV2ItemsIdMessagesCountParams, GetApiV2ItemsIdMessagesParams, GetApiV2ItemsIdMetaFieldsParams, GetApiV2ItemsIdOriginatorsCountParams, GetApiV2ItemsIdOriginatorsParams, GetApiV2ItemsIdScancodesCountParams, GetApiV2ItemsIdScancodesParams, GetApiV2ItemsIdShipnoticeItemsCountParams, GetApiV2ItemsIdShipnoticeItemsParams, GetApiV2ItemsIdTraitsParams, GetApiV2ItemsIdTransactionsCountParams, GetApiV2ItemsIdTransactionsParams, GetApiV2ItemsParams, PostApiV21ItemsIdBundleItemsRequest, PostApiV21ItemsIdIncidentsRequest, PostApiV21ItemsIdLocationsRequest, PostApiV21ItemsIdMessagesRequest, PostApiV21ItemsIdOriginatorsRequest, PostApiV21ItemsRequest, PostApiV2ItemsIdBundleItemsRequest, PostApiV2ItemsIdIncidentsRequest, PostApiV2ItemsIdLocationsRequest, PostApiV2ItemsIdMessagesRequest, PostApiV2ItemsIdOriginatorsRequest, PostApiV2ItemsRequest, PutApiV21ItemsIdCallActionRequest, PutApiV21ItemsIdCallAsyncActionRequest, PutApiV21ItemsIdMetaFieldsRequest, PutApiV21ItemsIdRequest, PutApiV2ItemsIdCallActionRequest, PutApiV2ItemsIdCallAsyncActionRequest, PutApiV2ItemsIdMetaFieldsRequest, PutApiV2ItemsIdRequest } from "./data-contracts";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
3
  /**
4
4
  * @description Get a list of items
@@ -297,15 +297,6 @@ export declare const postApiV2ItemsIdOriginators: (client: HttpClient, id: numbe
297
297
  * @request GET:/api/v2/items/{id}/originators/count
298
298
  */
299
299
  export declare const getApiV2ItemsIdOriginatorsCount: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdOriginatorsCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
300
- /**
301
- * @description show scancodes associated with this item
302
- *
303
- * @tags items
304
- * @name GetApiV2ItemsIdScancodeAliases
305
- * @summary List all scancodes associated with this item
306
- * @request GET:/api/v2/items/{id}/scancode_aliases
307
- */
308
- export declare const getApiV2ItemsIdScancodeAliases: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdScancodeAliasesParams, params?: RequestParams) => Promise<ApiV2EntitiesScancodeAlias[]>;
309
300
  /**
310
301
  * @description show scancodes associated with this item
311
302
  *
@@ -684,15 +675,6 @@ export declare const postApiV21ItemsIdOriginators: (client: HttpClient, id: numb
684
675
  * @request GET:/api/v2.1/items/{id}/originators/count
685
676
  */
686
677
  export declare const getApiV21ItemsIdOriginatorsCount: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdOriginatorsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
687
- /**
688
- * @description show scancodes associated with this item
689
- *
690
- * @tags items
691
- * @name GetApiV21ItemsIdScancodeAliases
692
- * @summary List all scancodes associated with this item
693
- * @request GET:/api/v2.1/items/{id}/scancode_aliases
694
- */
695
- export declare const getApiV21ItemsIdScancodeAliases: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdScancodeAliasesParams, params?: RequestParams) => Promise<ApiV21EntitiesScancodeAlias[]>;
696
678
  /**
697
679
  * @description show scancodes associated with this item
698
680
  *
@@ -4483,35 +4483,6 @@ export interface ApiV2EntitiesScancode {
4483
4483
  updated_at?: string;
4484
4484
  }
4485
4485
  /** V2 */
4486
- export interface ApiV2EntitiesScancodeAlias {
4487
- /** is this scancode_alias active? */
4488
- active?: boolean;
4489
- /**
4490
- * scancode_alias creation date
4491
- * @format date-time
4492
- */
4493
- created_at?: string;
4494
- /**
4495
- * the scancode_alias id
4496
- * @format int32
4497
- */
4498
- id?: number;
4499
- /**
4500
- * the item_id
4501
- * @format int32
4502
- */
4503
- item_id?: number | null;
4504
- /** label format for the scancode_alias */
4505
- label_format?: string | null;
4506
- /** the scancode for the scancode_alias */
4507
- scancode?: string | null;
4508
- /**
4509
- * scancode_alias last updated date
4510
- * @format date-time
4511
- */
4512
- updated_at?: string;
4513
- }
4514
- /** V2 */
4515
4486
  export interface ApiV2EntitiesSerialNumber {
4516
4487
  /**
4517
4488
  * if not null, the DateTime when the serial was deleted
@@ -9478,35 +9449,6 @@ export interface ApiV21EntitiesScancode {
9478
9449
  updated_at?: string;
9479
9450
  }
9480
9451
  /** V3 */
9481
- export interface ApiV21EntitiesScancodeAlias {
9482
- /** is this scancode_alias active? */
9483
- active?: boolean;
9484
- /**
9485
- * scancode_alias creation date
9486
- * @format date-time
9487
- */
9488
- created_at?: string;
9489
- /**
9490
- * the scancode_alias id
9491
- * @format int32
9492
- */
9493
- id?: number;
9494
- /**
9495
- * the item_id
9496
- * @format int32
9497
- */
9498
- item_id?: number | null;
9499
- /** label format for the scancode_alias */
9500
- label_format?: string | null;
9501
- /** the scancode for the scancode_alias */
9502
- scancode?: string | null;
9503
- /**
9504
- * scancode_alias last updated date
9505
- * @format date-time
9506
- */
9507
- updated_at?: string;
9508
- }
9509
- /** V3 */
9510
9452
  export interface ApiV21EntitiesSerialNumber {
9511
9453
  /**
9512
9454
  * if not null, the DateTime when the serial was deleted
@@ -11454,27 +11396,6 @@ export interface GetApiV21ItemsIdOriginatorsParams {
11454
11396
  page_links?: boolean;
11455
11397
  id: number;
11456
11398
  }
11457
- export interface GetApiV21ItemsIdScancodeAliasesParams {
11458
- /** JSON search string like {"attribute_eq": "Term"} */
11459
- search?: string;
11460
- /** A list of sort options (ex: name asc,created_at desc) */
11461
- sort?: string;
11462
- /**
11463
- * Page of results to fetch
11464
- * @format int32
11465
- */
11466
- page?: number;
11467
- /**
11468
- * Number of results to return per page
11469
- * @format int32
11470
- */
11471
- per_page?: number;
11472
- /** Include total count of results */
11473
- page_total?: boolean;
11474
- /** Include prev/next links in response headers */
11475
- page_links?: boolean;
11476
- id: number;
11477
- }
11478
11399
  export interface GetApiV21ItemsIdScancodesCountParams {
11479
11400
  /** JSON search string like {"attribute_eq": "Term"} */
11480
11401
  search?: string;
@@ -12870,28 +12791,6 @@ export interface GetApiV21RulesParams {
12870
12791
  /** Include prev/next links in response headers */
12871
12792
  page_links?: boolean;
12872
12793
  }
12873
- export interface GetApiV21ScancodeAliasesParams {
12874
- /** JSON search string like {"attribute_eq": "Term"} */
12875
- search?: string;
12876
- /** Comma-separated list of fields to include in the response */
12877
- fields?: string;
12878
- /** A list of sort options (ex: name asc,created_at desc) */
12879
- sort?: string;
12880
- /**
12881
- * Page of results to fetch
12882
- * @format int32
12883
- */
12884
- page?: number;
12885
- /**
12886
- * Number of results to return per page
12887
- * @format int32
12888
- */
12889
- per_page?: number;
12890
- /** Include total count of results */
12891
- page_total?: boolean;
12892
- /** Include prev/next links in response headers */
12893
- page_links?: boolean;
12894
- }
12895
12794
  export interface GetApiV21ScancodesParams {
12896
12795
  /** JSON search string like {"attribute_eq": "Term"} */
12897
12796
  search?: string;
@@ -13331,6 +13230,11 @@ export interface GetApiV21TemplatesRenderTypeToFileTemplateTypeSlugResourceIdPar
13331
13230
  * @format int32
13332
13231
  */
13333
13232
  scancode_id?: number;
13233
+ /**
13234
+ * the template id to use for rendering - if not provided, will use the default template for the template type
13235
+ * @format int32
13236
+ */
13237
+ template_id?: number;
13334
13238
  resourceId: number;
13335
13239
  templateTypeSlug: string;
13336
13240
  }
@@ -14303,27 +14207,6 @@ export interface GetApiV2ItemsIdOriginatorsParams {
14303
14207
  page_links?: boolean;
14304
14208
  id: number;
14305
14209
  }
14306
- export interface GetApiV2ItemsIdScancodeAliasesParams {
14307
- /** JSON search string like {"attribute_eq": "Term"} */
14308
- search?: string;
14309
- /** A list of sort options (ex: name asc,created_at desc) */
14310
- sort?: string;
14311
- /**
14312
- * Page of results to fetch
14313
- * @format int32
14314
- */
14315
- page?: number;
14316
- /**
14317
- * Number of results to return per page
14318
- * @format int32
14319
- */
14320
- per_page?: number;
14321
- /** Include total count of results */
14322
- page_total?: boolean;
14323
- /** Include prev/next links in response headers */
14324
- page_links?: boolean;
14325
- id: number;
14326
- }
14327
14210
  export interface GetApiV2ItemsIdScancodesCountParams {
14328
14211
  /** JSON search string like {"attribute_eq": "Term"} */
14329
14212
  search?: string;
@@ -15719,28 +15602,6 @@ export interface GetApiV2RulesParams {
15719
15602
  /** Include prev/next links in response headers */
15720
15603
  page_links?: boolean;
15721
15604
  }
15722
- export interface GetApiV2ScancodeAliasesParams {
15723
- /** JSON search string like {"attribute_eq": "Term"} */
15724
- search?: string;
15725
- /** Comma-separated list of fields to include in the response */
15726
- fields?: string;
15727
- /** A list of sort options (ex: name asc,created_at desc) */
15728
- sort?: string;
15729
- /**
15730
- * Page of results to fetch
15731
- * @format int32
15732
- */
15733
- page?: number;
15734
- /**
15735
- * Number of results to return per page
15736
- * @format int32
15737
- */
15738
- per_page?: number;
15739
- /** Include total count of results */
15740
- page_total?: boolean;
15741
- /** Include prev/next links in response headers */
15742
- page_links?: boolean;
15743
- }
15744
15605
  export interface GetApiV2ScancodesParams {
15745
15606
  /** JSON search string like {"attribute_eq": "Term"} */
15746
15607
  search?: string;
@@ -16180,6 +16041,11 @@ export interface GetApiV2TemplatesRenderTypeToFileTemplateTypeSlugResourceIdPara
16180
16041
  * @format int32
16181
16042
  */
16182
16043
  scancode_id?: number;
16044
+ /**
16045
+ * the template id to use for rendering - if not provided, will use the default template for the template type
16046
+ * @format int32
16047
+ */
16048
+ template_id?: number;
16183
16049
  resourceId: number;
16184
16050
  templateTypeSlug: string;
16185
16051
  }
@@ -25628,14 +25494,6 @@ export interface PutApiV21RulesIdRequest {
25628
25494
  /** apply rule while Item to be added has inventory? */
25629
25495
  while_supplies_last?: boolean;
25630
25496
  }
25631
- export interface PutApiV21ScancodeAliasesIdRequest {
25632
- /** is this scancode_alias active? */
25633
- active?: boolean;
25634
- /** label format for the scancode_alias */
25635
- label_format?: string;
25636
- /** the scancode for the scancode_alias */
25637
- scancode?: string;
25638
- }
25639
25497
  export interface PutApiV21ScancodesIdCallActionRequest {
25640
25498
  action?: string;
25641
25499
  /** Method params */
@@ -28495,14 +28353,6 @@ export interface PutApiV2RulesIdRequest {
28495
28353
  /** apply rule while Item to be added has inventory? */
28496
28354
  while_supplies_last?: boolean;
28497
28355
  }
28498
- export interface PutApiV2ScancodeAliasesIdRequest {
28499
- /** is this scancode_alias active? */
28500
- active?: boolean;
28501
- /** label format for the scancode_alias */
28502
- label_format?: string;
28503
- /** the scancode for the scancode_alias */
28504
- scancode?: string;
28505
- }
28506
28356
  export interface PutApiV2ScancodesIdCallActionRequest {
28507
28357
  action?: string;
28508
28358
  /** Method params */
@@ -59,7 +59,6 @@ export * from './RelocateInventoryTransfers';
59
59
  export * from './ReturnAddresses';
60
60
  export * from './RuleDismissals';
61
61
  export * from './Rules';
62
- export * from './ScancodeAliases';
63
62
  export * from './Scancodes';
64
63
  export * from './Schemas';
65
64
  export * from './SerialNumbers';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@whiplashmerch/whiplash-api-client",
3
- "version": "3.2.18",
3
+ "version": "3.2.20",
4
4
  "description": "",
5
5
  "devDependencies": {},
6
6
  "scripts": {
@@ -1,38 +0,0 @@
1
- import { ApiV21EntitiesScancode, ApiV2EntitiesScancode, GetApiV21ScancodeAliasesParams, GetApiV2ScancodeAliasesParams, PutApiV21ScancodeAliasesIdRequest, PutApiV2ScancodeAliasesIdRequest } from "./data-contracts";
2
- import { HttpClient, RequestParams } from "./http-client";
3
- /**
4
- * @description Get all scancode_aliases
5
- *
6
- * @tags scancode_aliases
7
- * @name GetApiV2ScancodeAliases
8
- * @summary List all scancode aliases
9
- * @request GET:/api/v2/scancode_aliases
10
- */
11
- export declare const getApiV2ScancodeAliases: (client: HttpClient, query: GetApiV2ScancodeAliasesParams, params?: RequestParams) => Promise<ApiV2EntitiesScancode[]>;
12
- /**
13
- * @description Update a scancode alias
14
- *
15
- * @tags scancode_aliases
16
- * @name PutApiV2ScancodeAliasesId
17
- * @summary Update a scancode alias
18
- * @request PUT:/api/v2/scancode_aliases/{id}
19
- */
20
- export declare const putApiV2ScancodeAliasesId: (client: HttpClient, id: number, data: PutApiV2ScancodeAliasesIdRequest, params?: RequestParams) => Promise<ApiV2EntitiesScancode>;
21
- /**
22
- * @description Get all scancode_aliases
23
- *
24
- * @tags scancode_aliases
25
- * @name GetApiV21ScancodeAliases
26
- * @summary List all scancode aliases
27
- * @request GET:/api/v2.1/scancode_aliases
28
- */
29
- export declare const getApiV21ScancodeAliases: (client: HttpClient, query: GetApiV21ScancodeAliasesParams, params?: RequestParams) => Promise<ApiV21EntitiesScancode[]>;
30
- /**
31
- * @description Update a scancode alias
32
- *
33
- * @tags scancode_aliases
34
- * @name PutApiV21ScancodeAliasesId
35
- * @summary Update a scancode alias
36
- * @request PUT:/api/v2.1/scancode_aliases/{id}
37
- */
38
- export declare const putApiV21ScancodeAliasesId: (client: HttpClient, id: number, data: PutApiV21ScancodeAliasesIdRequest, params?: RequestParams) => Promise<void>;