@teemill/gfn-catalog 3.6.3 → 3.7.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/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/gfn-catalog@3.6.3
1
+ ## @teemill/gfn-catalog@3.7.0
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @teemill/gfn-catalog@3.6.3 --save
39
+ npm install @teemill/gfn-catalog@3.7.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -56,6 +56,7 @@ Class | Method | HTTP request | Description
56
56
  *StatementsApi* | [**getStatement**](docs/StatementsApi.md#getstatement) | **GET** /v1/gfn/statements/{statementId} | Get a GFN statement
57
57
  *StatementsApi* | [**listStatements**](docs/StatementsApi.md#liststatements) | **GET** /v1/gfn/statements | List GFN statements
58
58
  *TransactionsApi* | [**exportTransactions**](docs/TransactionsApi.md#exporttransactions) | **POST** /v1/gfn/transactions/export | Export GFN transactions
59
+ *TransactionsApi* | [**getTransaction**](docs/TransactionsApi.md#gettransaction) | **GET** /v1/gfn/transactions/{transactionId} | Get a GFN transaction
59
60
  *TransactionsApi* | [**listFulfillments**](docs/TransactionsApi.md#listfulfillments) | **GET** /v1/gfn/transactions/fulfillments | Lists the GFN fulfillments of the project
60
61
  *TransactionsApi* | [**listTransactions**](docs/TransactionsApi.md#listtransactions) | **GET** /v1/gfn/transactions | List GFN transactions
61
62
  *VariantsApi* | [**getStock**](docs/VariantsApi.md#getstock) | **GET** /v1/gfn/catalog/stock/{variantId} | Get GFN variant stock
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * GFN Catalog API
5
5
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
6
6
  *
7
- * The version of the OpenAPI document: 3.6.3
7
+ * The version of the OpenAPI document: 3.7.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -240,6 +240,7 @@ export interface Transaction {
240
240
  */
241
241
  'statement'?: string | null;
242
242
  'cost'?: number;
243
+ 'quantity': number;
243
244
  'type'?: TransactionTypeEnum;
244
245
  'taxable'?: boolean;
245
246
  'createdAt': string;
@@ -896,6 +897,54 @@ export const TransactionsApiAxiosParamCreator = function (configuration?: Config
896
897
  options: localVarRequestOptions,
897
898
  };
898
899
  },
900
+ /**
901
+ * Gets a GFN transaction by the given ID.
902
+ * @summary Get a GFN transaction
903
+ * @param {string} project What project it is
904
+ * @param {string} transactionId
905
+ * @param {*} [options] Override http request option.
906
+ * @throws {RequiredError}
907
+ */
908
+ getTransaction: async (project: string, transactionId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
909
+ // verify required parameter 'project' is not null or undefined
910
+ assertParamExists('getTransaction', 'project', project)
911
+ // verify required parameter 'transactionId' is not null or undefined
912
+ assertParamExists('getTransaction', 'transactionId', transactionId)
913
+ const localVarPath = `/v1/gfn/transactions/{transactionId}`
914
+ .replace(`{${"transactionId"}}`, encodeURIComponent(String(transactionId)));
915
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
916
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
917
+ let baseOptions;
918
+ if (configuration) {
919
+ baseOptions = configuration.baseOptions;
920
+ }
921
+
922
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
923
+ const localVarHeaderParameter = {} as any;
924
+ const localVarQueryParameter = {} as any;
925
+
926
+ // authentication session-oauth required
927
+ // oauth required
928
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
929
+
930
+ // authentication api-key required
931
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
932
+
933
+ if (project !== undefined) {
934
+ localVarQueryParameter['project'] = project;
935
+ }
936
+
937
+
938
+
939
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
940
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
941
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
942
+
943
+ return {
944
+ url: toPathString(localVarUrlObj),
945
+ options: localVarRequestOptions,
946
+ };
947
+ },
899
948
  /**
900
949
  * Lists all the fulfillments in the project with GFN transactions
901
950
  * @summary Lists the GFN fulfillments of the project
@@ -1047,6 +1096,20 @@ export const TransactionsApiFp = function(configuration?: Configuration) {
1047
1096
  const localVarOperationServerBasePath = operationServerMap['TransactionsApi.exportTransactions']?.[localVarOperationServerIndex]?.url;
1048
1097
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1049
1098
  },
1099
+ /**
1100
+ * Gets a GFN transaction by the given ID.
1101
+ * @summary Get a GFN transaction
1102
+ * @param {string} project What project it is
1103
+ * @param {string} transactionId
1104
+ * @param {*} [options] Override http request option.
1105
+ * @throws {RequiredError}
1106
+ */
1107
+ async getTransaction(project: string, transactionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Transaction>> {
1108
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getTransaction(project, transactionId, options);
1109
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1110
+ const localVarOperationServerBasePath = operationServerMap['TransactionsApi.getTransaction']?.[localVarOperationServerIndex]?.url;
1111
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1112
+ },
1050
1113
  /**
1051
1114
  * Lists all the fulfillments in the project with GFN transactions
1052
1115
  * @summary Lists the GFN fulfillments of the project
@@ -1100,6 +1163,16 @@ export const TransactionsApiFactory = function (configuration?: Configuration, b
1100
1163
  exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
1101
1164
  return localVarFp.exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(axios, basePath));
1102
1165
  },
1166
+ /**
1167
+ * Gets a GFN transaction by the given ID.
1168
+ * @summary Get a GFN transaction
1169
+ * @param {TransactionsApiGetTransactionRequest} requestParameters Request parameters.
1170
+ * @param {*} [options] Override http request option.
1171
+ * @throws {RequiredError}
1172
+ */
1173
+ getTransaction(requestParameters: TransactionsApiGetTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise<Transaction> {
1174
+ return localVarFp.getTransaction(requestParameters.project, requestParameters.transactionId, options).then((request) => request(axios, basePath));
1175
+ },
1103
1176
  /**
1104
1177
  * Lists all the fulfillments in the project with GFN transactions
1105
1178
  * @summary Lists the GFN fulfillments of the project
@@ -1138,6 +1211,18 @@ export interface TransactionsApiExportTransactionsRequest {
1138
1211
  readonly exportTransactionsRequest: ExportTransactionsRequest
1139
1212
  }
1140
1213
 
1214
+ /**
1215
+ * Request parameters for getTransaction operation in TransactionsApi.
1216
+ */
1217
+ export interface TransactionsApiGetTransactionRequest {
1218
+ /**
1219
+ * What project it is
1220
+ */
1221
+ readonly project: string
1222
+
1223
+ readonly transactionId: string
1224
+ }
1225
+
1141
1226
  /**
1142
1227
  * Request parameters for listFulfillments operation in TransactionsApi.
1143
1228
  */
@@ -1204,6 +1289,17 @@ export class TransactionsApi extends BaseAPI {
1204
1289
  return TransactionsApiFp(this.configuration).exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(this.axios, this.basePath));
1205
1290
  }
1206
1291
 
1292
+ /**
1293
+ * Gets a GFN transaction by the given ID.
1294
+ * @summary Get a GFN transaction
1295
+ * @param {TransactionsApiGetTransactionRequest} requestParameters Request parameters.
1296
+ * @param {*} [options] Override http request option.
1297
+ * @throws {RequiredError}
1298
+ */
1299
+ public getTransaction(requestParameters: TransactionsApiGetTransactionRequest, options?: RawAxiosRequestConfig) {
1300
+ return TransactionsApiFp(this.configuration).getTransaction(requestParameters.project, requestParameters.transactionId, options).then((request) => request(this.axios, this.basePath));
1301
+ }
1302
+
1207
1303
  /**
1208
1304
  * Lists all the fulfillments in the project with GFN transactions
1209
1305
  * @summary Lists the GFN fulfillments of the project
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * GFN Catalog API
5
5
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
6
6
  *
7
- * The version of the OpenAPI document: 3.6.3
7
+ * The version of the OpenAPI document: 3.7.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * GFN Catalog API
5
5
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
6
6
  *
7
- * The version of the OpenAPI document: 3.6.3
7
+ * The version of the OpenAPI document: 3.7.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -1,10 +1,9 @@
1
1
  /* tslint:disable */
2
- /* eslint-disable */
3
2
  /**
4
3
  * GFN Catalog API
5
4
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
6
5
  *
7
- * The version of the OpenAPI document: 3.6.3
6
+ * The version of the OpenAPI document: 3.7.0
8
7
  *
9
8
  *
10
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,12 +11,24 @@
12
11
  * Do not edit the class manually.
13
12
  */
14
13
 
14
+ interface AWSv4Configuration {
15
+ options?: {
16
+ region?: string
17
+ service?: string
18
+ }
19
+ credentials?: {
20
+ accessKeyId?: string
21
+ secretAccessKey?: string,
22
+ sessionToken?: string
23
+ }
24
+ }
15
25
 
16
26
  export interface ConfigurationParameters {
17
27
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
18
28
  username?: string;
19
29
  password?: string;
20
30
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
31
+ awsv4?: AWSv4Configuration;
21
32
  basePath?: string;
22
33
  serverIndex?: number;
23
34
  baseOptions?: any;
@@ -44,6 +55,17 @@ export class Configuration {
44
55
  * @param scopes oauth2 scope
45
56
  */
46
57
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
58
+ /**
59
+ * parameter for aws4 signature security
60
+ * @param {Object} AWS4Signature - AWS4 Signature security
61
+ * @param {string} options.region - aws region
62
+ * @param {string} options.service - name of the service.
63
+ * @param {string} credentials.accessKeyId - aws access key id
64
+ * @param {string} credentials.secretAccessKey - aws access key
65
+ * @param {string} credentials.sessionToken - aws session token
66
+ * @memberof Configuration
67
+ */
68
+ awsv4?: AWSv4Configuration;
47
69
  /**
48
70
  * override base path
49
71
  */
@@ -70,6 +92,7 @@ export class Configuration {
70
92
  this.username = param.username;
71
93
  this.password = param.password;
72
94
  this.accessToken = param.accessToken;
95
+ this.awsv4 = param.awsv4;
73
96
  this.basePath = param.basePath;
74
97
  this.serverIndex = param.serverIndex;
75
98
  this.baseOptions = {
package/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * GFN Catalog API
3
3
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
4
4
  *
5
- * The version of the OpenAPI document: 3.6.3
5
+ * The version of the OpenAPI document: 3.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -229,6 +229,7 @@ export interface Transaction {
229
229
  */
230
230
  'statement'?: string | null;
231
231
  'cost'?: number;
232
+ 'quantity': number;
232
233
  'type'?: TransactionTypeEnum;
233
234
  'taxable'?: boolean;
234
235
  'createdAt': string;
@@ -577,6 +578,15 @@ export declare const TransactionsApiAxiosParamCreator: (configuration?: Configur
577
578
  * @throws {RequiredError}
578
579
  */
579
580
  exportTransactions: (project: string, exportTransactionsRequest: ExportTransactionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
581
+ /**
582
+ * Gets a GFN transaction by the given ID.
583
+ * @summary Get a GFN transaction
584
+ * @param {string} project What project it is
585
+ * @param {string} transactionId
586
+ * @param {*} [options] Override http request option.
587
+ * @throws {RequiredError}
588
+ */
589
+ getTransaction: (project: string, transactionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
580
590
  /**
581
591
  * Lists all the fulfillments in the project with GFN transactions
582
592
  * @summary Lists the GFN fulfillments of the project
@@ -615,6 +625,15 @@ export declare const TransactionsApiFp: (configuration?: Configuration) => {
615
625
  * @throws {RequiredError}
616
626
  */
617
627
  exportTransactions(project: string, exportTransactionsRequest: ExportTransactionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
628
+ /**
629
+ * Gets a GFN transaction by the given ID.
630
+ * @summary Get a GFN transaction
631
+ * @param {string} project What project it is
632
+ * @param {string} transactionId
633
+ * @param {*} [options] Override http request option.
634
+ * @throws {RequiredError}
635
+ */
636
+ getTransaction(project: string, transactionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Transaction>>;
618
637
  /**
619
638
  * Lists all the fulfillments in the project with GFN transactions
620
639
  * @summary Lists the GFN fulfillments of the project
@@ -652,6 +671,14 @@ export declare const TransactionsApiFactory: (configuration?: Configuration, bas
652
671
  * @throws {RequiredError}
653
672
  */
654
673
  exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
674
+ /**
675
+ * Gets a GFN transaction by the given ID.
676
+ * @summary Get a GFN transaction
677
+ * @param {TransactionsApiGetTransactionRequest} requestParameters Request parameters.
678
+ * @param {*} [options] Override http request option.
679
+ * @throws {RequiredError}
680
+ */
681
+ getTransaction(requestParameters: TransactionsApiGetTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise<Transaction>;
655
682
  /**
656
683
  * Lists all the fulfillments in the project with GFN transactions
657
684
  * @summary Lists the GFN fulfillments of the project
@@ -682,6 +709,16 @@ export interface TransactionsApiExportTransactionsRequest {
682
709
  */
683
710
  readonly exportTransactionsRequest: ExportTransactionsRequest;
684
711
  }
712
+ /**
713
+ * Request parameters for getTransaction operation in TransactionsApi.
714
+ */
715
+ export interface TransactionsApiGetTransactionRequest {
716
+ /**
717
+ * What project it is
718
+ */
719
+ readonly project: string;
720
+ readonly transactionId: string;
721
+ }
685
722
  /**
686
723
  * Request parameters for listFulfillments operation in TransactionsApi.
687
724
  */
@@ -735,6 +772,14 @@ export declare class TransactionsApi extends BaseAPI {
735
772
  * @throws {RequiredError}
736
773
  */
737
774
  exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
775
+ /**
776
+ * Gets a GFN transaction by the given ID.
777
+ * @summary Get a GFN transaction
778
+ * @param {TransactionsApiGetTransactionRequest} requestParameters Request parameters.
779
+ * @param {*} [options] Override http request option.
780
+ * @throws {RequiredError}
781
+ */
782
+ getTransaction(requestParameters: TransactionsApiGetTransactionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Transaction, any, {}>>;
738
783
  /**
739
784
  * Lists all the fulfillments in the project with GFN transactions
740
785
  * @summary Lists the GFN fulfillments of the project
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * GFN Catalog API
6
6
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
7
7
  *
8
- * The version of the OpenAPI document: 3.6.3
8
+ * The version of the OpenAPI document: 3.7.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -487,6 +487,46 @@ const TransactionsApiAxiosParamCreator = function (configuration) {
487
487
  options: localVarRequestOptions,
488
488
  };
489
489
  }),
490
+ /**
491
+ * Gets a GFN transaction by the given ID.
492
+ * @summary Get a GFN transaction
493
+ * @param {string} project What project it is
494
+ * @param {string} transactionId
495
+ * @param {*} [options] Override http request option.
496
+ * @throws {RequiredError}
497
+ */
498
+ getTransaction: (project_1, transactionId_1, ...args_1) => __awaiter(this, [project_1, transactionId_1, ...args_1], void 0, function* (project, transactionId, options = {}) {
499
+ // verify required parameter 'project' is not null or undefined
500
+ (0, common_1.assertParamExists)('getTransaction', 'project', project);
501
+ // verify required parameter 'transactionId' is not null or undefined
502
+ (0, common_1.assertParamExists)('getTransaction', 'transactionId', transactionId);
503
+ const localVarPath = `/v1/gfn/transactions/{transactionId}`
504
+ .replace(`{${"transactionId"}}`, encodeURIComponent(String(transactionId)));
505
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
506
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
507
+ let baseOptions;
508
+ if (configuration) {
509
+ baseOptions = configuration.baseOptions;
510
+ }
511
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
512
+ const localVarHeaderParameter = {};
513
+ const localVarQueryParameter = {};
514
+ // authentication session-oauth required
515
+ // oauth required
516
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
517
+ // authentication api-key required
518
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
519
+ if (project !== undefined) {
520
+ localVarQueryParameter['project'] = project;
521
+ }
522
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
523
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
524
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
525
+ return {
526
+ url: (0, common_1.toPathString)(localVarUrlObj),
527
+ options: localVarRequestOptions,
528
+ };
529
+ }),
490
530
  /**
491
531
  * Lists all the fulfillments in the project with GFN transactions
492
532
  * @summary Lists the GFN fulfillments of the project
@@ -617,6 +657,23 @@ const TransactionsApiFp = function (configuration) {
617
657
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
618
658
  });
619
659
  },
660
+ /**
661
+ * Gets a GFN transaction by the given ID.
662
+ * @summary Get a GFN transaction
663
+ * @param {string} project What project it is
664
+ * @param {string} transactionId
665
+ * @param {*} [options] Override http request option.
666
+ * @throws {RequiredError}
667
+ */
668
+ getTransaction(project, transactionId, options) {
669
+ return __awaiter(this, void 0, void 0, function* () {
670
+ var _a, _b, _c;
671
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getTransaction(project, transactionId, options);
672
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
673
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['TransactionsApi.getTransaction']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
674
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
675
+ });
676
+ },
620
677
  /**
621
678
  * Lists all the fulfillments in the project with GFN transactions
622
679
  * @summary Lists the GFN fulfillments of the project
@@ -676,6 +733,16 @@ const TransactionsApiFactory = function (configuration, basePath, axios) {
676
733
  exportTransactions(requestParameters, options) {
677
734
  return localVarFp.exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(axios, basePath));
678
735
  },
736
+ /**
737
+ * Gets a GFN transaction by the given ID.
738
+ * @summary Get a GFN transaction
739
+ * @param {TransactionsApiGetTransactionRequest} requestParameters Request parameters.
740
+ * @param {*} [options] Override http request option.
741
+ * @throws {RequiredError}
742
+ */
743
+ getTransaction(requestParameters, options) {
744
+ return localVarFp.getTransaction(requestParameters.project, requestParameters.transactionId, options).then((request) => request(axios, basePath));
745
+ },
679
746
  /**
680
747
  * Lists all the fulfillments in the project with GFN transactions
681
748
  * @summary Lists the GFN fulfillments of the project
@@ -713,6 +780,16 @@ class TransactionsApi extends base_1.BaseAPI {
713
780
  exportTransactions(requestParameters, options) {
714
781
  return (0, exports.TransactionsApiFp)(this.configuration).exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(this.axios, this.basePath));
715
782
  }
783
+ /**
784
+ * Gets a GFN transaction by the given ID.
785
+ * @summary Get a GFN transaction
786
+ * @param {TransactionsApiGetTransactionRequest} requestParameters Request parameters.
787
+ * @param {*} [options] Override http request option.
788
+ * @throws {RequiredError}
789
+ */
790
+ getTransaction(requestParameters, options) {
791
+ return (0, exports.TransactionsApiFp)(this.configuration).getTransaction(requestParameters.project, requestParameters.transactionId, options).then((request) => request(this.axios, this.basePath));
792
+ }
716
793
  /**
717
794
  * Lists all the fulfillments in the project with GFN transactions
718
795
  * @summary Lists the GFN fulfillments of the project
package/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * GFN Catalog API
3
3
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
4
4
  *
5
- * The version of the OpenAPI document: 3.6.3
5
+ * The version of the OpenAPI document: 3.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * GFN Catalog API
6
6
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
7
7
  *
8
- * The version of the OpenAPI document: 3.6.3
8
+ * The version of the OpenAPI document: 3.7.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * GFN Catalog API
3
3
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
4
4
  *
5
- * The version of the OpenAPI document: 3.6.3
5
+ * The version of the OpenAPI document: 3.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * GFN Catalog API
6
6
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
7
7
  *
8
- * The version of the OpenAPI document: 3.6.3
8
+ * The version of the OpenAPI document: 3.7.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,18 +2,30 @@
2
2
  * GFN Catalog API
3
3
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
4
4
  *
5
- * The version of the OpenAPI document: 3.6.3
5
+ * The version of the OpenAPI document: 3.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ interface AWSv4Configuration {
13
+ options?: {
14
+ region?: string;
15
+ service?: string;
16
+ };
17
+ credentials?: {
18
+ accessKeyId?: string;
19
+ secretAccessKey?: string;
20
+ sessionToken?: string;
21
+ };
22
+ }
12
23
  export interface ConfigurationParameters {
13
24
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
14
25
  username?: string;
15
26
  password?: string;
16
27
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
+ awsv4?: AWSv4Configuration;
17
29
  basePath?: string;
18
30
  serverIndex?: number;
19
31
  baseOptions?: any;
@@ -39,6 +51,17 @@ export declare class Configuration {
39
51
  * @param scopes oauth2 scope
40
52
  */
41
53
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
+ /**
55
+ * parameter for aws4 signature security
56
+ * @param {Object} AWS4Signature - AWS4 Signature security
57
+ * @param {string} options.region - aws region
58
+ * @param {string} options.service - name of the service.
59
+ * @param {string} credentials.accessKeyId - aws access key id
60
+ * @param {string} credentials.secretAccessKey - aws access key
61
+ * @param {string} credentials.sessionToken - aws session token
62
+ * @memberof Configuration
63
+ */
64
+ awsv4?: AWSv4Configuration;
42
65
  /**
43
66
  * override base path
44
67
  */
@@ -72,3 +95,4 @@ export declare class Configuration {
72
95
  */
73
96
  isJsonMime(mime: string): boolean;
74
97
  }
98
+ export {};
@@ -1,11 +1,10 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
- /* eslint-disable */
4
3
  /**
5
4
  * GFN Catalog API
6
5
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
7
6
  *
8
- * The version of the OpenAPI document: 3.6.3
7
+ * The version of the OpenAPI document: 3.7.0
9
8
  *
10
9
  *
11
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -21,6 +20,7 @@ class Configuration {
21
20
  this.username = param.username;
22
21
  this.password = param.password;
23
22
  this.accessToken = param.accessToken;
23
+ this.awsv4 = param.awsv4;
24
24
  this.basePath = param.basePath;
25
25
  this.serverIndex = param.serverIndex;
26
26
  this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
package/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * GFN Catalog API
3
3
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
4
4
  *
5
- * The version of the OpenAPI document: 3.6.3
5
+ * The version of the OpenAPI document: 3.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -229,6 +229,7 @@ export interface Transaction {
229
229
  */
230
230
  'statement'?: string | null;
231
231
  'cost'?: number;
232
+ 'quantity': number;
232
233
  'type'?: TransactionTypeEnum;
233
234
  'taxable'?: boolean;
234
235
  'createdAt': string;
@@ -577,6 +578,15 @@ export declare const TransactionsApiAxiosParamCreator: (configuration?: Configur
577
578
  * @throws {RequiredError}
578
579
  */
579
580
  exportTransactions: (project: string, exportTransactionsRequest: ExportTransactionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
581
+ /**
582
+ * Gets a GFN transaction by the given ID.
583
+ * @summary Get a GFN transaction
584
+ * @param {string} project What project it is
585
+ * @param {string} transactionId
586
+ * @param {*} [options] Override http request option.
587
+ * @throws {RequiredError}
588
+ */
589
+ getTransaction: (project: string, transactionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
580
590
  /**
581
591
  * Lists all the fulfillments in the project with GFN transactions
582
592
  * @summary Lists the GFN fulfillments of the project
@@ -615,6 +625,15 @@ export declare const TransactionsApiFp: (configuration?: Configuration) => {
615
625
  * @throws {RequiredError}
616
626
  */
617
627
  exportTransactions(project: string, exportTransactionsRequest: ExportTransactionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
628
+ /**
629
+ * Gets a GFN transaction by the given ID.
630
+ * @summary Get a GFN transaction
631
+ * @param {string} project What project it is
632
+ * @param {string} transactionId
633
+ * @param {*} [options] Override http request option.
634
+ * @throws {RequiredError}
635
+ */
636
+ getTransaction(project: string, transactionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Transaction>>;
618
637
  /**
619
638
  * Lists all the fulfillments in the project with GFN transactions
620
639
  * @summary Lists the GFN fulfillments of the project
@@ -652,6 +671,14 @@ export declare const TransactionsApiFactory: (configuration?: Configuration, bas
652
671
  * @throws {RequiredError}
653
672
  */
654
673
  exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
674
+ /**
675
+ * Gets a GFN transaction by the given ID.
676
+ * @summary Get a GFN transaction
677
+ * @param {TransactionsApiGetTransactionRequest} requestParameters Request parameters.
678
+ * @param {*} [options] Override http request option.
679
+ * @throws {RequiredError}
680
+ */
681
+ getTransaction(requestParameters: TransactionsApiGetTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise<Transaction>;
655
682
  /**
656
683
  * Lists all the fulfillments in the project with GFN transactions
657
684
  * @summary Lists the GFN fulfillments of the project
@@ -682,6 +709,16 @@ export interface TransactionsApiExportTransactionsRequest {
682
709
  */
683
710
  readonly exportTransactionsRequest: ExportTransactionsRequest;
684
711
  }
712
+ /**
713
+ * Request parameters for getTransaction operation in TransactionsApi.
714
+ */
715
+ export interface TransactionsApiGetTransactionRequest {
716
+ /**
717
+ * What project it is
718
+ */
719
+ readonly project: string;
720
+ readonly transactionId: string;
721
+ }
685
722
  /**
686
723
  * Request parameters for listFulfillments operation in TransactionsApi.
687
724
  */
@@ -735,6 +772,14 @@ export declare class TransactionsApi extends BaseAPI {
735
772
  * @throws {RequiredError}
736
773
  */
737
774
  exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
775
+ /**
776
+ * Gets a GFN transaction by the given ID.
777
+ * @summary Get a GFN transaction
778
+ * @param {TransactionsApiGetTransactionRequest} requestParameters Request parameters.
779
+ * @param {*} [options] Override http request option.
780
+ * @throws {RequiredError}
781
+ */
782
+ getTransaction(requestParameters: TransactionsApiGetTransactionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Transaction, any, {}>>;
738
783
  /**
739
784
  * Lists all the fulfillments in the project with GFN transactions
740
785
  * @summary Lists the GFN fulfillments of the project
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * GFN Catalog API
5
5
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
6
6
  *
7
- * The version of the OpenAPI document: 3.6.3
7
+ * The version of the OpenAPI document: 3.7.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -476,6 +476,46 @@ export const TransactionsApiAxiosParamCreator = function (configuration) {
476
476
  options: localVarRequestOptions,
477
477
  };
478
478
  }),
479
+ /**
480
+ * Gets a GFN transaction by the given ID.
481
+ * @summary Get a GFN transaction
482
+ * @param {string} project What project it is
483
+ * @param {string} transactionId
484
+ * @param {*} [options] Override http request option.
485
+ * @throws {RequiredError}
486
+ */
487
+ getTransaction: (project_1, transactionId_1, ...args_1) => __awaiter(this, [project_1, transactionId_1, ...args_1], void 0, function* (project, transactionId, options = {}) {
488
+ // verify required parameter 'project' is not null or undefined
489
+ assertParamExists('getTransaction', 'project', project);
490
+ // verify required parameter 'transactionId' is not null or undefined
491
+ assertParamExists('getTransaction', 'transactionId', transactionId);
492
+ const localVarPath = `/v1/gfn/transactions/{transactionId}`
493
+ .replace(`{${"transactionId"}}`, encodeURIComponent(String(transactionId)));
494
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
495
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
496
+ let baseOptions;
497
+ if (configuration) {
498
+ baseOptions = configuration.baseOptions;
499
+ }
500
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
501
+ const localVarHeaderParameter = {};
502
+ const localVarQueryParameter = {};
503
+ // authentication session-oauth required
504
+ // oauth required
505
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
506
+ // authentication api-key required
507
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
508
+ if (project !== undefined) {
509
+ localVarQueryParameter['project'] = project;
510
+ }
511
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
512
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
513
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
514
+ return {
515
+ url: toPathString(localVarUrlObj),
516
+ options: localVarRequestOptions,
517
+ };
518
+ }),
479
519
  /**
480
520
  * Lists all the fulfillments in the project with GFN transactions
481
521
  * @summary Lists the GFN fulfillments of the project
@@ -605,6 +645,23 @@ export const TransactionsApiFp = function (configuration) {
605
645
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
606
646
  });
607
647
  },
648
+ /**
649
+ * Gets a GFN transaction by the given ID.
650
+ * @summary Get a GFN transaction
651
+ * @param {string} project What project it is
652
+ * @param {string} transactionId
653
+ * @param {*} [options] Override http request option.
654
+ * @throws {RequiredError}
655
+ */
656
+ getTransaction(project, transactionId, options) {
657
+ return __awaiter(this, void 0, void 0, function* () {
658
+ var _a, _b, _c;
659
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getTransaction(project, transactionId, options);
660
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
661
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['TransactionsApi.getTransaction']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
662
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
663
+ });
664
+ },
608
665
  /**
609
666
  * Lists all the fulfillments in the project with GFN transactions
610
667
  * @summary Lists the GFN fulfillments of the project
@@ -663,6 +720,16 @@ export const TransactionsApiFactory = function (configuration, basePath, axios)
663
720
  exportTransactions(requestParameters, options) {
664
721
  return localVarFp.exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(axios, basePath));
665
722
  },
723
+ /**
724
+ * Gets a GFN transaction by the given ID.
725
+ * @summary Get a GFN transaction
726
+ * @param {TransactionsApiGetTransactionRequest} requestParameters Request parameters.
727
+ * @param {*} [options] Override http request option.
728
+ * @throws {RequiredError}
729
+ */
730
+ getTransaction(requestParameters, options) {
731
+ return localVarFp.getTransaction(requestParameters.project, requestParameters.transactionId, options).then((request) => request(axios, basePath));
732
+ },
666
733
  /**
667
734
  * Lists all the fulfillments in the project with GFN transactions
668
735
  * @summary Lists the GFN fulfillments of the project
@@ -699,6 +766,16 @@ export class TransactionsApi extends BaseAPI {
699
766
  exportTransactions(requestParameters, options) {
700
767
  return TransactionsApiFp(this.configuration).exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(this.axios, this.basePath));
701
768
  }
769
+ /**
770
+ * Gets a GFN transaction by the given ID.
771
+ * @summary Get a GFN transaction
772
+ * @param {TransactionsApiGetTransactionRequest} requestParameters Request parameters.
773
+ * @param {*} [options] Override http request option.
774
+ * @throws {RequiredError}
775
+ */
776
+ getTransaction(requestParameters, options) {
777
+ return TransactionsApiFp(this.configuration).getTransaction(requestParameters.project, requestParameters.transactionId, options).then((request) => request(this.axios, this.basePath));
778
+ }
702
779
  /**
703
780
  * Lists all the fulfillments in the project with GFN transactions
704
781
  * @summary Lists the GFN fulfillments of the project
@@ -2,7 +2,7 @@
2
2
  * GFN Catalog API
3
3
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
4
4
  *
5
- * The version of the OpenAPI document: 3.6.3
5
+ * The version of the OpenAPI document: 3.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * GFN Catalog API
5
5
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
6
6
  *
7
- * The version of the OpenAPI document: 3.6.3
7
+ * The version of the OpenAPI document: 3.7.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * GFN Catalog API
3
3
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
4
4
  *
5
- * The version of the OpenAPI document: 3.6.3
5
+ * The version of the OpenAPI document: 3.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * GFN Catalog API
5
5
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
6
6
  *
7
- * The version of the OpenAPI document: 3.6.3
7
+ * The version of the OpenAPI document: 3.7.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,18 +2,30 @@
2
2
  * GFN Catalog API
3
3
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
4
4
  *
5
- * The version of the OpenAPI document: 3.6.3
5
+ * The version of the OpenAPI document: 3.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ interface AWSv4Configuration {
13
+ options?: {
14
+ region?: string;
15
+ service?: string;
16
+ };
17
+ credentials?: {
18
+ accessKeyId?: string;
19
+ secretAccessKey?: string;
20
+ sessionToken?: string;
21
+ };
22
+ }
12
23
  export interface ConfigurationParameters {
13
24
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
14
25
  username?: string;
15
26
  password?: string;
16
27
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
+ awsv4?: AWSv4Configuration;
17
29
  basePath?: string;
18
30
  serverIndex?: number;
19
31
  baseOptions?: any;
@@ -39,6 +51,17 @@ export declare class Configuration {
39
51
  * @param scopes oauth2 scope
40
52
  */
41
53
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
+ /**
55
+ * parameter for aws4 signature security
56
+ * @param {Object} AWS4Signature - AWS4 Signature security
57
+ * @param {string} options.region - aws region
58
+ * @param {string} options.service - name of the service.
59
+ * @param {string} credentials.accessKeyId - aws access key id
60
+ * @param {string} credentials.secretAccessKey - aws access key
61
+ * @param {string} credentials.sessionToken - aws session token
62
+ * @memberof Configuration
63
+ */
64
+ awsv4?: AWSv4Configuration;
42
65
  /**
43
66
  * override base path
44
67
  */
@@ -72,3 +95,4 @@ export declare class Configuration {
72
95
  */
73
96
  isJsonMime(mime: string): boolean;
74
97
  }
98
+ export {};
@@ -1,10 +1,9 @@
1
1
  /* tslint:disable */
2
- /* eslint-disable */
3
2
  /**
4
3
  * GFN Catalog API
5
4
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
6
5
  *
7
- * The version of the OpenAPI document: 3.6.3
6
+ * The version of the OpenAPI document: 3.7.0
8
7
  *
9
8
  *
10
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,6 +17,7 @@ export class Configuration {
18
17
  this.username = param.username;
19
18
  this.password = param.password;
20
19
  this.accessToken = param.accessToken;
20
+ this.awsv4 = param.awsv4;
21
21
  this.basePath = param.basePath;
22
22
  this.serverIndex = param.serverIndex;
23
23
  this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
@@ -2,7 +2,7 @@
2
2
  * GFN Catalog API
3
3
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
4
4
  *
5
- * The version of the OpenAPI document: 3.6.3
5
+ * The version of the OpenAPI document: 3.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * GFN Catalog API
5
5
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
6
6
  *
7
- * The version of the OpenAPI document: 3.6.3
7
+ * The version of the OpenAPI document: 3.7.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * GFN Catalog API
3
3
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
4
4
  *
5
- * The version of the OpenAPI document: 3.6.3
5
+ * The version of the OpenAPI document: 3.7.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * GFN Catalog API
6
6
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
7
7
  *
8
- * The version of the OpenAPI document: 3.6.3
8
+ * The version of the OpenAPI document: 3.7.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **ref** | **string** | A reference to the resource location | [default to undefined]
10
10
  **statement** | **string** | A reference to the resource location | [optional] [default to undefined]
11
11
  **cost** | **number** | | [optional] [default to undefined]
12
+ **quantity** | **number** | | [default to undefined]
12
13
  **type** | **string** | | [optional] [default to undefined]
13
14
  **taxable** | **boolean** | | [optional] [default to undefined]
14
15
  **createdAt** | **string** | | [default to undefined]
@@ -26,6 +27,7 @@ const instance: Transaction = {
26
27
  ref,
27
28
  statement,
28
29
  cost,
30
+ quantity,
29
31
  type,
30
32
  taxable,
31
33
  createdAt,
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.podos.io*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**exportTransactions**](#exporttransactions) | **POST** /v1/gfn/transactions/export | Export GFN transactions|
8
+ |[**getTransaction**](#gettransaction) | **GET** /v1/gfn/transactions/{transactionId} | Get a GFN transaction|
8
9
  |[**listFulfillments**](#listfulfillments) | **GET** /v1/gfn/transactions/fulfillments | Lists the GFN fulfillments of the project|
9
10
  |[**listTransactions**](#listtransactions) | **GET** /v1/gfn/transactions | List GFN transactions|
10
11
 
@@ -69,6 +70,65 @@ const { status, data } = await apiInstance.exportTransactions(
69
70
 
70
71
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
71
72
 
73
+ # **getTransaction**
74
+ > Transaction getTransaction()
75
+
76
+ Gets a GFN transaction by the given ID.
77
+
78
+ ### Example
79
+
80
+ ```typescript
81
+ import {
82
+ TransactionsApi,
83
+ Configuration
84
+ } from '@teemill/gfn-catalog';
85
+
86
+ const configuration = new Configuration();
87
+ const apiInstance = new TransactionsApi(configuration);
88
+
89
+ let project: string; //What project it is (default to undefined)
90
+ let transactionId: string; // (default to undefined)
91
+
92
+ const { status, data } = await apiInstance.getTransaction(
93
+ project,
94
+ transactionId
95
+ );
96
+ ```
97
+
98
+ ### Parameters
99
+
100
+ |Name | Type | Description | Notes|
101
+ |------------- | ------------- | ------------- | -------------|
102
+ | **project** | [**string**] | What project it is | defaults to undefined|
103
+ | **transactionId** | [**string**] | | defaults to undefined|
104
+
105
+
106
+ ### Return type
107
+
108
+ **Transaction**
109
+
110
+ ### Authorization
111
+
112
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
113
+
114
+ ### HTTP request headers
115
+
116
+ - **Content-Type**: Not defined
117
+ - **Accept**: application/json
118
+
119
+
120
+ ### HTTP response details
121
+ | Status code | Description | Response headers |
122
+ |-------------|-------------|------------------|
123
+ |**200** | Successfully retrieved a GFN transaction | - |
124
+ |**400** | Failed validation. | - |
125
+ |**401** | Not authorised to access this resource. | - |
126
+ |**403** | Refuse to authorize. | - |
127
+ |**404** | Resource not found. | - |
128
+ |**500** | Unknown server error. | - |
129
+
130
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
131
+
72
132
  # **listFulfillments**
73
133
  > ListFulfillments200Response listFulfillments()
74
134
 
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * GFN Catalog API
5
5
  * Use this API to access the Global Fulfillment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
6
6
  *
7
- * The version of the OpenAPI document: 3.6.3
7
+ * The version of the OpenAPI document: 3.7.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/gfn-catalog",
3
- "version": "3.6.3",
3
+ "version": "3.7.0",
4
4
  "description": "OpenAPI client for @teemill/gfn-catalog",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -24,7 +24,7 @@
24
24
  "prepare": "npm run build"
25
25
  },
26
26
  "dependencies": {
27
- "axios": "^1.6.1"
27
+ "axios": "1.12.2"
28
28
  },
29
29
  "devDependencies": {
30
30
  "@types/node": "12.11.5 - 12.20.42",