@teemill/platform 0.42.0 → 0.44.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/platform@0.42.0
1
+ ## @teemill/platform@0.44.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/platform@0.42.0 --save
39
+ npm install @teemill/platform@0.44.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -76,6 +76,7 @@ Class | Method | HTTP request | Description
76
76
  *OrdersApi* | [**returnOrder**](docs/OrdersApi.md#returnorder) | **PATCH** /v1/platform/{platformId}/orders/{orderId}/return | Return the contents of an order for a refund or exchange
77
77
  *OrdersApi* | [**sendOrderReceipt**](docs/OrdersApi.md#sendorderreceipt) | **POST** /v1/platform/{platformId}/orders/{orderId}/receipt/send | Send order receipt
78
78
  *OrdersApi* | [**updateFulfillment**](docs/OrdersApi.md#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment
79
+ *OrdersApi* | [**updatePlatformFulfillmentStyleApplication**](docs/OrdersApi.md#updateplatformfulfillmentstyleapplication) | **PATCH** /v1/platform/{platformId}/styles/{styleId}/applications/{applicationId} | Update platform fulfillment style application
79
80
  *PaymentApi* | [**authorizeStripe**](docs/PaymentApi.md#authorizestripe) | **GET** /v1/platform/payment/stripe/authorize | Authorize Stripe
80
81
  *PaymentApi* | [**deauthorizeStripe**](docs/PaymentApi.md#deauthorizestripe) | **DELETE** /v1/platform/payment/stripe/deauthorize | Deauthorize Stripe
81
82
  *PaymentApi* | [**getStripePaymentAccount**](docs/PaymentApi.md#getstripepaymentaccount) | **GET** /v1/platform/payment/stripe | Get Stripe Payment Account
@@ -109,6 +110,8 @@ Class | Method | HTTP request | Description
109
110
  - [AmendOrderRequestAmendmentsInnerReason](docs/AmendOrderRequestAmendmentsInnerReason.md)
110
111
  - [AmendmentLog](docs/AmendmentLog.md)
111
112
  - [ApiError](docs/ApiError.md)
113
+ - [Application](docs/Application.md)
114
+ - [AttachedFile](docs/AttachedFile.md)
112
115
  - [AuthorizeStripe200Response](docs/AuthorizeStripe200Response.md)
113
116
  - [BulkCreateReviewPayload](docs/BulkCreateReviewPayload.md)
114
117
  - [BulkCreatedReviews](docs/BulkCreatedReviews.md)
@@ -169,6 +172,7 @@ Class | Method | HTTP request | Description
169
172
  - [Platform](docs/Platform.md)
170
173
  - [PlatformLogo](docs/PlatformLogo.md)
171
174
  - [Price](docs/Price.md)
175
+ - [PrintArea](docs/PrintArea.md)
172
176
  - [Project](docs/Project.md)
173
177
  - [ReturnOrderRequest](docs/ReturnOrderRequest.md)
174
178
  - [ReturnOrderRequestReturnsInner](docs/ReturnOrderRequestReturnsInner.md)
@@ -188,6 +192,7 @@ Class | Method | HTTP request | Description
188
192
  - [Terms](docs/Terms.md)
189
193
  - [UpdateCustomerEnquiryRequest](docs/UpdateCustomerEnquiryRequest.md)
190
194
  - [UpdateFulfillmentRequest](docs/UpdateFulfillmentRequest.md)
195
+ - [UpdatePlatformFulfillmentStyleApplicationRequest](docs/UpdatePlatformFulfillmentStyleApplicationRequest.md)
191
196
  - [UpdatePlatformRequest](docs/UpdatePlatformRequest.md)
192
197
  - [ValidationError](docs/ValidationError.md)
193
198
  - [Variant](docs/Variant.md)
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.42.0
7
+ * The version of the OpenAPI document: 0.44.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -123,6 +123,33 @@ export interface ApiError {
123
123
  'code'?: string;
124
124
  'message': string;
125
125
  }
126
+ export interface Application {
127
+ /**
128
+ * Unique object identifier
129
+ */
130
+ 'id'?: string;
131
+ /**
132
+ * Unique object identifier
133
+ */
134
+ 'styleId'?: string;
135
+ 'placement'?: ApplicationPlacementEnum;
136
+ 'mockup'?: string;
137
+ 'design'?: string;
138
+ 'printArea'?: PrintArea;
139
+ 'files'?: Array<AttachedFile>;
140
+ }
141
+
142
+ export const ApplicationPlacementEnum = {
143
+ Front: 'front',
144
+ Back: 'back'
145
+ } as const;
146
+
147
+ export type ApplicationPlacementEnum = typeof ApplicationPlacementEnum[keyof typeof ApplicationPlacementEnum];
148
+
149
+ export interface AttachedFile {
150
+ 'url'?: string;
151
+ 'name'?: string;
152
+ }
126
153
  export interface AuthorizeStripe200Response {
127
154
  /**
128
155
  * The URL to redirect to
@@ -770,6 +797,13 @@ export interface Price {
770
797
  */
771
798
  'currencyCode'?: string;
772
799
  }
800
+ /**
801
+ * Print area dimensions in mm
802
+ */
803
+ export interface PrintArea {
804
+ 'width'?: number;
805
+ 'height'?: number;
806
+ }
773
807
  export interface Project {
774
808
  'id': string;
775
809
  /**
@@ -959,6 +993,9 @@ export interface UpdateFulfillmentRequest {
959
993
  */
960
994
  'fulfillerId'?: string;
961
995
  }
996
+ export interface UpdatePlatformFulfillmentStyleApplicationRequest {
997
+ 'design'?: string;
998
+ }
962
999
  export interface UpdatePlatformRequest {
963
1000
  'logos'?: Array<PlatformLogo>;
964
1001
  'favicon'?: string;
@@ -2995,10 +3032,11 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
2995
3032
  * @param {string} start Start of date range to filter by when orders were placed
2996
3033
  * @param {string} [end] End of date range to filter when orders were placed
2997
3034
  * @param {string} [search] Search term to filter based on order reference, customer name and email
3035
+ * @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
2998
3036
  * @param {*} [options] Override http request option.
2999
3037
  * @throws {RequiredError}
3000
3038
  */
3001
- exportOrders: async (project: string, platformId: string, start: string, end?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3039
+ exportOrders: async (project: string, platformId: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3002
3040
  // verify required parameter 'project' is not null or undefined
3003
3041
  assertParamExists('exportOrders', 'project', project)
3004
3042
  // verify required parameter 'platformId' is not null or undefined
@@ -3045,6 +3083,10 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
3045
3083
  localVarQueryParameter['search'] = search;
3046
3084
  }
3047
3085
 
3086
+ if (dateFilterType !== undefined) {
3087
+ localVarQueryParameter['dateFilterType'] = dateFilterType;
3088
+ }
3089
+
3048
3090
 
3049
3091
 
3050
3092
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -3571,6 +3613,68 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
3571
3613
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3572
3614
  localVarRequestOptions.data = serializeDataIfNeeded(updateFulfillmentRequest, localVarRequestOptions, configuration)
3573
3615
 
3616
+ return {
3617
+ url: toPathString(localVarUrlObj),
3618
+ options: localVarRequestOptions,
3619
+ };
3620
+ },
3621
+ /**
3622
+ * Update a fulfillment style application for a fulfillment for a platform order
3623
+ * @summary Update platform fulfillment style application
3624
+ * @param {string} project Project unique identifier
3625
+ * @param {string} platformId The platform identifier
3626
+ * @param {string} styleId Unique identifier of a fulfillment style
3627
+ * @param {string} applicationId Unique identifier of a fulfillment style application
3628
+ * @param {UpdatePlatformFulfillmentStyleApplicationRequest} updatePlatformFulfillmentStyleApplicationRequest
3629
+ * @param {*} [options] Override http request option.
3630
+ * @throws {RequiredError}
3631
+ */
3632
+ updatePlatformFulfillmentStyleApplication: async (project: string, platformId: string, styleId: string, applicationId: string, updatePlatformFulfillmentStyleApplicationRequest: UpdatePlatformFulfillmentStyleApplicationRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3633
+ // verify required parameter 'project' is not null or undefined
3634
+ assertParamExists('updatePlatformFulfillmentStyleApplication', 'project', project)
3635
+ // verify required parameter 'platformId' is not null or undefined
3636
+ assertParamExists('updatePlatformFulfillmentStyleApplication', 'platformId', platformId)
3637
+ // verify required parameter 'styleId' is not null or undefined
3638
+ assertParamExists('updatePlatformFulfillmentStyleApplication', 'styleId', styleId)
3639
+ // verify required parameter 'applicationId' is not null or undefined
3640
+ assertParamExists('updatePlatformFulfillmentStyleApplication', 'applicationId', applicationId)
3641
+ // verify required parameter 'updatePlatformFulfillmentStyleApplicationRequest' is not null or undefined
3642
+ assertParamExists('updatePlatformFulfillmentStyleApplication', 'updatePlatformFulfillmentStyleApplicationRequest', updatePlatformFulfillmentStyleApplicationRequest)
3643
+ const localVarPath = `/v1/platform/{platformId}/styles/{styleId}/applications/{applicationId}`
3644
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3645
+ .replace(`{${"styleId"}}`, encodeURIComponent(String(styleId)))
3646
+ .replace(`{${"applicationId"}}`, encodeURIComponent(String(applicationId)));
3647
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3648
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3649
+ let baseOptions;
3650
+ if (configuration) {
3651
+ baseOptions = configuration.baseOptions;
3652
+ }
3653
+
3654
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
3655
+ const localVarHeaderParameter = {} as any;
3656
+ const localVarQueryParameter = {} as any;
3657
+
3658
+ // authentication session-oauth required
3659
+ // oauth required
3660
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3661
+
3662
+ // authentication api-key required
3663
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3664
+
3665
+ if (project !== undefined) {
3666
+ localVarQueryParameter['project'] = project;
3667
+ }
3668
+
3669
+
3670
+
3671
+ localVarHeaderParameter['Content-Type'] = 'application/json';
3672
+
3673
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3674
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3675
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3676
+ localVarRequestOptions.data = serializeDataIfNeeded(updatePlatformFulfillmentStyleApplicationRequest, localVarRequestOptions, configuration)
3677
+
3574
3678
  return {
3575
3679
  url: toPathString(localVarUrlObj),
3576
3680
  options: localVarRequestOptions,
@@ -3655,11 +3759,12 @@ export const OrdersApiFp = function(configuration?: Configuration) {
3655
3759
  * @param {string} start Start of date range to filter by when orders were placed
3656
3760
  * @param {string} [end] End of date range to filter when orders were placed
3657
3761
  * @param {string} [search] Search term to filter based on order reference, customer name and email
3762
+ * @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
3658
3763
  * @param {*} [options] Override http request option.
3659
3764
  * @throws {RequiredError}
3660
3765
  */
3661
- async exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
3662
- const localVarAxiosArgs = await localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, options);
3766
+ async exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
3767
+ const localVarAxiosArgs = await localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, dateFilterType, options);
3663
3768
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3664
3769
  const localVarOperationServerBasePath = operationServerMap['OrdersApi.exportOrders']?.[localVarOperationServerIndex]?.url;
3665
3770
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3808,6 +3913,23 @@ export const OrdersApiFp = function(configuration?: Configuration) {
3808
3913
  const localVarOperationServerBasePath = operationServerMap['OrdersApi.updateFulfillment']?.[localVarOperationServerIndex]?.url;
3809
3914
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3810
3915
  },
3916
+ /**
3917
+ * Update a fulfillment style application for a fulfillment for a platform order
3918
+ * @summary Update platform fulfillment style application
3919
+ * @param {string} project Project unique identifier
3920
+ * @param {string} platformId The platform identifier
3921
+ * @param {string} styleId Unique identifier of a fulfillment style
3922
+ * @param {string} applicationId Unique identifier of a fulfillment style application
3923
+ * @param {UpdatePlatformFulfillmentStyleApplicationRequest} updatePlatformFulfillmentStyleApplicationRequest
3924
+ * @param {*} [options] Override http request option.
3925
+ * @throws {RequiredError}
3926
+ */
3927
+ async updatePlatformFulfillmentStyleApplication(project: string, platformId: string, styleId: string, applicationId: string, updatePlatformFulfillmentStyleApplicationRequest: UpdatePlatformFulfillmentStyleApplicationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Application>> {
3928
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlatformFulfillmentStyleApplication(project, platformId, styleId, applicationId, updatePlatformFulfillmentStyleApplicationRequest, options);
3929
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3930
+ const localVarOperationServerBasePath = operationServerMap['OrdersApi.updatePlatformFulfillmentStyleApplication']?.[localVarOperationServerIndex]?.url;
3931
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3932
+ },
3811
3933
  }
3812
3934
  };
3813
3935
 
@@ -3865,7 +3987,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
3865
3987
  * @throws {RequiredError}
3866
3988
  */
3867
3989
  exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
3868
- return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(axios, basePath));
3990
+ return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
3869
3991
  },
3870
3992
  /**
3871
3993
  * Get a fulfillment for a platform by a given fulfillment ID.
@@ -3957,6 +4079,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
3957
4079
  updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment> {
3958
4080
  return localVarFp.updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(axios, basePath));
3959
4081
  },
4082
+ /**
4083
+ * Update a fulfillment style application for a fulfillment for a platform order
4084
+ * @summary Update platform fulfillment style application
4085
+ * @param {OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest} requestParameters Request parameters.
4086
+ * @param {*} [options] Override http request option.
4087
+ * @throws {RequiredError}
4088
+ */
4089
+ updatePlatformFulfillmentStyleApplication(requestParameters: OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Application> {
4090
+ return localVarFp.updatePlatformFulfillmentStyleApplication(requestParameters.project, requestParameters.platformId, requestParameters.styleId, requestParameters.applicationId, requestParameters.updatePlatformFulfillmentStyleApplicationRequest, options).then((request) => request(axios, basePath));
4091
+ },
3960
4092
  };
3961
4093
  };
3962
4094
 
@@ -4078,6 +4210,11 @@ export interface OrdersApiExportOrdersRequest {
4078
4210
  * Search term to filter based on order reference, customer name and email
4079
4211
  */
4080
4212
  readonly search?: string
4213
+
4214
+ /**
4215
+ * Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
4216
+ */
4217
+ readonly dateFilterType?: ExportOrdersDateFilterTypeEnum
4081
4218
  }
4082
4219
 
4083
4220
  /**
@@ -4302,6 +4439,33 @@ export interface OrdersApiUpdateFulfillmentRequest {
4302
4439
  readonly updateFulfillmentRequest: UpdateFulfillmentRequest
4303
4440
  }
4304
4441
 
4442
+ /**
4443
+ * Request parameters for updatePlatformFulfillmentStyleApplication operation in OrdersApi.
4444
+ */
4445
+ export interface OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest {
4446
+ /**
4447
+ * Project unique identifier
4448
+ */
4449
+ readonly project: string
4450
+
4451
+ /**
4452
+ * The platform identifier
4453
+ */
4454
+ readonly platformId: string
4455
+
4456
+ /**
4457
+ * Unique identifier of a fulfillment style
4458
+ */
4459
+ readonly styleId: string
4460
+
4461
+ /**
4462
+ * Unique identifier of a fulfillment style application
4463
+ */
4464
+ readonly applicationId: string
4465
+
4466
+ readonly updatePlatformFulfillmentStyleApplicationRequest: UpdatePlatformFulfillmentStyleApplicationRequest
4467
+ }
4468
+
4305
4469
  /**
4306
4470
  * OrdersApi - object-oriented interface
4307
4471
  */
@@ -4358,7 +4522,7 @@ export class OrdersApi extends BaseAPI {
4358
4522
  * @throws {RequiredError}
4359
4523
  */
4360
4524
  public exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig) {
4361
- return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
4525
+ return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
4362
4526
  }
4363
4527
 
4364
4528
  /**
@@ -4459,12 +4623,35 @@ export class OrdersApi extends BaseAPI {
4459
4623
  public updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig) {
4460
4624
  return OrdersApiFp(this.configuration).updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(this.axios, this.basePath));
4461
4625
  }
4626
+
4627
+ /**
4628
+ * Update a fulfillment style application for a fulfillment for a platform order
4629
+ * @summary Update platform fulfillment style application
4630
+ * @param {OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest} requestParameters Request parameters.
4631
+ * @param {*} [options] Override http request option.
4632
+ * @throws {RequiredError}
4633
+ */
4634
+ public updatePlatformFulfillmentStyleApplication(requestParameters: OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest, options?: RawAxiosRequestConfig) {
4635
+ return OrdersApiFp(this.configuration).updatePlatformFulfillmentStyleApplication(requestParameters.project, requestParameters.platformId, requestParameters.styleId, requestParameters.applicationId, requestParameters.updatePlatformFulfillmentStyleApplicationRequest, options).then((request) => request(this.axios, this.basePath));
4636
+ }
4462
4637
  }
4463
4638
 
4639
+ export const ExportOrdersDateFilterTypeEnum = {
4640
+ CreatedAt: 'createdAt',
4641
+ PaidAt: 'paidAt',
4642
+ UpdatedAt: 'updatedAt',
4643
+ StatusChangedAt: 'statusChangedAt',
4644
+ CompletedAt: 'completedAt',
4645
+ RefundedAt: 'refundedAt'
4646
+ } as const;
4647
+ export type ExportOrdersDateFilterTypeEnum = typeof ExportOrdersDateFilterTypeEnum[keyof typeof ExportOrdersDateFilterTypeEnum];
4464
4648
  export const ListOrdersDateFilterTypeEnum = {
4465
4649
  CreatedAt: 'createdAt',
4650
+ PaidAt: 'paidAt',
4466
4651
  UpdatedAt: 'updatedAt',
4467
- StatusChangedAt: 'statusChangedAt'
4652
+ StatusChangedAt: 'statusChangedAt',
4653
+ CompletedAt: 'completedAt',
4654
+ RefundedAt: 'refundedAt'
4468
4655
  } as const;
4469
4656
  export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
4470
4657
 
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.42.0
7
+ * The version of the OpenAPI document: 0.44.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
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.42.0
7
+ * The version of the OpenAPI document: 0.44.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
  * Platform API
5
4
  * Manage Your podOS platform
6
5
  *
7
- * The version of the OpenAPI document: 0.42.0
6
+ * The version of the OpenAPI document: 0.44.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
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.42.0
5
+ * The version of the OpenAPI document: 0.44.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -107,6 +107,30 @@ export interface ApiError {
107
107
  'code'?: string;
108
108
  'message': string;
109
109
  }
110
+ export interface Application {
111
+ /**
112
+ * Unique object identifier
113
+ */
114
+ 'id'?: string;
115
+ /**
116
+ * Unique object identifier
117
+ */
118
+ 'styleId'?: string;
119
+ 'placement'?: ApplicationPlacementEnum;
120
+ 'mockup'?: string;
121
+ 'design'?: string;
122
+ 'printArea'?: PrintArea;
123
+ 'files'?: Array<AttachedFile>;
124
+ }
125
+ export declare const ApplicationPlacementEnum: {
126
+ readonly Front: "front";
127
+ readonly Back: "back";
128
+ };
129
+ export type ApplicationPlacementEnum = typeof ApplicationPlacementEnum[keyof typeof ApplicationPlacementEnum];
130
+ export interface AttachedFile {
131
+ 'url'?: string;
132
+ 'name'?: string;
133
+ }
110
134
  export interface AuthorizeStripe200Response {
111
135
  /**
112
136
  * The URL to redirect to
@@ -736,6 +760,13 @@ export interface Price {
736
760
  */
737
761
  'currencyCode'?: string;
738
762
  }
763
+ /**
764
+ * Print area dimensions in mm
765
+ */
766
+ export interface PrintArea {
767
+ 'width'?: number;
768
+ 'height'?: number;
769
+ }
739
770
  export interface Project {
740
771
  'id': string;
741
772
  /**
@@ -920,6 +951,9 @@ export interface UpdateFulfillmentRequest {
920
951
  */
921
952
  'fulfillerId'?: string;
922
953
  }
954
+ export interface UpdatePlatformFulfillmentStyleApplicationRequest {
955
+ 'design'?: string;
956
+ }
923
957
  export interface UpdatePlatformRequest {
924
958
  'logos'?: Array<PlatformLogo>;
925
959
  'favicon'?: string;
@@ -1919,10 +1953,11 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
1919
1953
  * @param {string} start Start of date range to filter by when orders were placed
1920
1954
  * @param {string} [end] End of date range to filter when orders were placed
1921
1955
  * @param {string} [search] Search term to filter based on order reference, customer name and email
1956
+ * @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
1922
1957
  * @param {*} [options] Override http request option.
1923
1958
  * @throws {RequiredError}
1924
1959
  */
1925
- exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1960
+ exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1926
1961
  /**
1927
1962
  * Get a fulfillment for a platform by a given fulfillment ID.
1928
1963
  * @summary Get fulfillment
@@ -2022,6 +2057,18 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
2022
2057
  * @throws {RequiredError}
2023
2058
  */
2024
2059
  updateFulfillment: (project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2060
+ /**
2061
+ * Update a fulfillment style application for a fulfillment for a platform order
2062
+ * @summary Update platform fulfillment style application
2063
+ * @param {string} project Project unique identifier
2064
+ * @param {string} platformId The platform identifier
2065
+ * @param {string} styleId Unique identifier of a fulfillment style
2066
+ * @param {string} applicationId Unique identifier of a fulfillment style application
2067
+ * @param {UpdatePlatformFulfillmentStyleApplicationRequest} updatePlatformFulfillmentStyleApplicationRequest
2068
+ * @param {*} [options] Override http request option.
2069
+ * @throws {RequiredError}
2070
+ */
2071
+ updatePlatformFulfillmentStyleApplication: (project: string, platformId: string, styleId: string, applicationId: string, updatePlatformFulfillmentStyleApplicationRequest: UpdatePlatformFulfillmentStyleApplicationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2025
2072
  };
2026
2073
  /**
2027
2074
  * OrdersApi - functional programming interface
@@ -2077,10 +2124,11 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
2077
2124
  * @param {string} start Start of date range to filter by when orders were placed
2078
2125
  * @param {string} [end] End of date range to filter when orders were placed
2079
2126
  * @param {string} [search] Search term to filter based on order reference, customer name and email
2127
+ * @param {ExportOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
2080
2128
  * @param {*} [options] Override http request option.
2081
2129
  * @throws {RequiredError}
2082
2130
  */
2083
- exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
2131
+ exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, dateFilterType?: ExportOrdersDateFilterTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
2084
2132
  /**
2085
2133
  * Get a fulfillment for a platform by a given fulfillment ID.
2086
2134
  * @summary Get fulfillment
@@ -2180,6 +2228,18 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
2180
2228
  * @throws {RequiredError}
2181
2229
  */
2182
2230
  updateFulfillment(project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
2231
+ /**
2232
+ * Update a fulfillment style application for a fulfillment for a platform order
2233
+ * @summary Update platform fulfillment style application
2234
+ * @param {string} project Project unique identifier
2235
+ * @param {string} platformId The platform identifier
2236
+ * @param {string} styleId Unique identifier of a fulfillment style
2237
+ * @param {string} applicationId Unique identifier of a fulfillment style application
2238
+ * @param {UpdatePlatformFulfillmentStyleApplicationRequest} updatePlatformFulfillmentStyleApplicationRequest
2239
+ * @param {*} [options] Override http request option.
2240
+ * @throws {RequiredError}
2241
+ */
2242
+ updatePlatformFulfillmentStyleApplication(project: string, platformId: string, styleId: string, applicationId: string, updatePlatformFulfillmentStyleApplicationRequest: UpdatePlatformFulfillmentStyleApplicationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Application>>;
2183
2243
  };
2184
2244
  /**
2185
2245
  * OrdersApi - factory interface
@@ -2297,6 +2357,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
2297
2357
  * @throws {RequiredError}
2298
2358
  */
2299
2359
  updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
2360
+ /**
2361
+ * Update a fulfillment style application for a fulfillment for a platform order
2362
+ * @summary Update platform fulfillment style application
2363
+ * @param {OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest} requestParameters Request parameters.
2364
+ * @param {*} [options] Override http request option.
2365
+ * @throws {RequiredError}
2366
+ */
2367
+ updatePlatformFulfillmentStyleApplication(requestParameters: OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Application>;
2300
2368
  };
2301
2369
  /**
2302
2370
  * Request parameters for amendOrder operation in OrdersApi.
@@ -2398,6 +2466,10 @@ export interface OrdersApiExportOrdersRequest {
2398
2466
  * Search term to filter based on order reference, customer name and email
2399
2467
  */
2400
2468
  readonly search?: string;
2469
+ /**
2470
+ * Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query.
2471
+ */
2472
+ readonly dateFilterType?: ExportOrdersDateFilterTypeEnum;
2401
2473
  }
2402
2474
  /**
2403
2475
  * Request parameters for getFulfillment operation in OrdersApi.
@@ -2585,6 +2657,28 @@ export interface OrdersApiUpdateFulfillmentRequest {
2585
2657
  readonly fulfillmentId: string;
2586
2658
  readonly updateFulfillmentRequest: UpdateFulfillmentRequest;
2587
2659
  }
2660
+ /**
2661
+ * Request parameters for updatePlatformFulfillmentStyleApplication operation in OrdersApi.
2662
+ */
2663
+ export interface OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest {
2664
+ /**
2665
+ * Project unique identifier
2666
+ */
2667
+ readonly project: string;
2668
+ /**
2669
+ * The platform identifier
2670
+ */
2671
+ readonly platformId: string;
2672
+ /**
2673
+ * Unique identifier of a fulfillment style
2674
+ */
2675
+ readonly styleId: string;
2676
+ /**
2677
+ * Unique identifier of a fulfillment style application
2678
+ */
2679
+ readonly applicationId: string;
2680
+ readonly updatePlatformFulfillmentStyleApplicationRequest: UpdatePlatformFulfillmentStyleApplicationRequest;
2681
+ }
2588
2682
  /**
2589
2683
  * OrdersApi - object-oriented interface
2590
2684
  */
@@ -2701,11 +2795,31 @@ export declare class OrdersApi extends BaseAPI {
2701
2795
  * @throws {RequiredError}
2702
2796
  */
2703
2797
  updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any, {}>>;
2798
+ /**
2799
+ * Update a fulfillment style application for a fulfillment for a platform order
2800
+ * @summary Update platform fulfillment style application
2801
+ * @param {OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest} requestParameters Request parameters.
2802
+ * @param {*} [options] Override http request option.
2803
+ * @throws {RequiredError}
2804
+ */
2805
+ updatePlatformFulfillmentStyleApplication(requestParameters: OrdersApiUpdatePlatformFulfillmentStyleApplicationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Application, any, {}>>;
2704
2806
  }
2807
+ export declare const ExportOrdersDateFilterTypeEnum: {
2808
+ readonly CreatedAt: "createdAt";
2809
+ readonly PaidAt: "paidAt";
2810
+ readonly UpdatedAt: "updatedAt";
2811
+ readonly StatusChangedAt: "statusChangedAt";
2812
+ readonly CompletedAt: "completedAt";
2813
+ readonly RefundedAt: "refundedAt";
2814
+ };
2815
+ export type ExportOrdersDateFilterTypeEnum = typeof ExportOrdersDateFilterTypeEnum[keyof typeof ExportOrdersDateFilterTypeEnum];
2705
2816
  export declare const ListOrdersDateFilterTypeEnum: {
2706
2817
  readonly CreatedAt: "createdAt";
2818
+ readonly PaidAt: "paidAt";
2707
2819
  readonly UpdatedAt: "updatedAt";
2708
2820
  readonly StatusChangedAt: "statusChangedAt";
2821
+ readonly CompletedAt: "completedAt";
2822
+ readonly RefundedAt: "refundedAt";
2709
2823
  };
2710
2824
  export type ListOrdersDateFilterTypeEnum = typeof ListOrdersDateFilterTypeEnum[keyof typeof ListOrdersDateFilterTypeEnum];
2711
2825
  /**