@teemill/platform 0.22.3 → 0.24.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.22.3
1
+ ## @teemill/platform@0.24.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.22.3 --save
39
+ npm install @teemill/platform@0.24.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,15 +54,18 @@ Class | Method | HTTP request | Description
54
54
  *CustomersApi* | [**exportCustomers**](docs/CustomersApi.md#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers
55
55
  *CustomersApi* | [**getCustomer**](docs/CustomersApi.md#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer
56
56
  *CustomersApi* | [**listCustomers**](docs/CustomersApi.md#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers
57
+ *EnquiriesApi* | [**createChatChannel**](docs/EnquiriesApi.md#createchatchannel) | **POST** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/chat-channel | Create chat channel
57
58
  *EnquiriesApi* | [**getCustomerEnquiry**](docs/EnquiriesApi.md#getcustomerenquiry) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Get customer enquiry
58
59
  *EnquiriesApi* | [**listCustomerEnquiries**](docs/EnquiriesApi.md#listcustomerenquiries) | **GET** /v1/platform/{platformId}/customers/enquiries | List customer enquiries
59
60
  *EnquiriesApi* | [**listCustomerEnquiryLogs**](docs/EnquiriesApi.md#listcustomerenquirylogs) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs | List customer enquiry Logs
60
61
  *OrdersApi* | [**exportOrders**](docs/OrdersApi.md#exportorders) | **GET** /v1/platform/{platformId}/orders/export | Export orders
61
62
  *OrdersApi* | [**getFulfillment**](docs/OrdersApi.md#getfulfillment) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Get fulfillment
62
63
  *OrdersApi* | [**getOrder**](docs/OrdersApi.md#getorder) | **GET** /v1/platform/{platformId}/orders/{orderId} | Get order
64
+ *OrdersApi* | [**getOrderReceipt**](docs/OrdersApi.md#getorderreceipt) | **GET** /v1/platform/{platformId}/orders/{orderId}/receipt | Get order receipt
63
65
  *OrdersApi* | [**listAvailableFulfillers**](docs/OrdersApi.md#listavailablefulfillers) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers | List available fulfillers
64
66
  *OrdersApi* | [**listOrders**](docs/OrdersApi.md#listorders) | **GET** /v1/platform/{platformId}/orders | List orders
65
67
  *OrdersApi* | [**retryPlatformPayment**](docs/OrdersApi.md#retryplatformpayment) | **POST** /v1/platform/{platformId}/orders/{orderId}/retryPlatformPayment | Retry
68
+ *OrdersApi* | [**sendOrderReceipt**](docs/OrdersApi.md#sendorderreceipt) | **POST** /v1/platform/{platformId}/orders/{orderId}/receipt/send | Send order receipt
66
69
  *OrdersApi* | [**updateFulfillment**](docs/OrdersApi.md#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment
67
70
  *PaymentApi* | [**authorizeStripe**](docs/PaymentApi.md#authorizestripe) | **GET** /v1/platform/payment/stripe/authorize | Authorize Stripe
68
71
  *PaymentApi* | [**deauthorizeStripe**](docs/PaymentApi.md#deauthorizestripe) | **DELETE** /v1/platform/payment/stripe/deauthorize | Deauthorize Stripe
@@ -90,6 +93,7 @@ Class | Method | HTTP request | Description
90
93
  - [Client](docs/Client.md)
91
94
  - [ContactInformation](docs/ContactInformation.md)
92
95
  - [Coupon](docs/Coupon.md)
96
+ - [CreateChatChannel200Response](docs/CreateChatChannel200Response.md)
93
97
  - [CreateDomainRequest](docs/CreateDomainRequest.md)
94
98
  - [Customer](docs/Customer.md)
95
99
  - [CustomersResponse](docs/CustomersResponse.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.22.3
7
+ * The version of the OpenAPI document: 0.24.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -160,6 +160,19 @@ export interface Coupon {
160
160
  */
161
161
  'code': string;
162
162
  }
163
+ /**
164
+ *
165
+ * @export
166
+ * @interface CreateChatChannel200Response
167
+ */
168
+ export interface CreateChatChannel200Response {
169
+ /**
170
+ * Reference to the chat channel resource
171
+ * @type {string}
172
+ * @memberof CreateChatChannel200Response
173
+ */
174
+ 'chatChannelRef': string;
175
+ }
163
176
  /**
164
177
  *
165
178
  * @export
@@ -369,6 +382,12 @@ export interface Enquiry {
369
382
  * @memberof Enquiry
370
383
  */
371
384
  'extraInputs': Array<EnquiryExtraInputsInner> | null;
385
+ /**
386
+ * Reference to the chat channel resource
387
+ * @type {string}
388
+ * @memberof Enquiry
389
+ */
390
+ 'chatChannelRef'?: string | null;
372
391
  }
373
392
 
374
393
  export const EnquiryStatusEnum = {
@@ -871,6 +890,12 @@ export interface Order {
871
890
  * @memberof Order
872
891
  */
873
892
  'paymentAttempts'?: Array<PaymentAttempt>;
893
+ /**
894
+ * The integration type of the order, e.g. \"website\" or \"shopify\"
895
+ * @type {string}
896
+ * @memberof Order
897
+ */
898
+ 'integrationType'?: string;
874
899
  }
875
900
 
876
901
 
@@ -2282,12 +2307,64 @@ export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeo
2282
2307
  */
2283
2308
  export const EnquiriesApiAxiosParamCreator = function (configuration?: Configuration) {
2284
2309
  return {
2310
+ /**
2311
+ * Create a chat channel for a customer enquiry if it doesn\'t exist
2312
+ * @summary Create chat channel
2313
+ * @param {string} project Project unique identifier
2314
+ * @param {string} platformId The platform identifier
2315
+ * @param {string} enquiryId The enquiry identifier
2316
+ * @param {*} [options] Override http request option.
2317
+ * @throws {RequiredError}
2318
+ */
2319
+ createChatChannel: async (project: string, platformId: string, enquiryId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2320
+ // verify required parameter 'project' is not null or undefined
2321
+ assertParamExists('createChatChannel', 'project', project)
2322
+ // verify required parameter 'platformId' is not null or undefined
2323
+ assertParamExists('createChatChannel', 'platformId', platformId)
2324
+ // verify required parameter 'enquiryId' is not null or undefined
2325
+ assertParamExists('createChatChannel', 'enquiryId', enquiryId)
2326
+ const localVarPath = `/v1/platform/{platformId}/customers/enquiries/{enquiryId}/chat-channel`
2327
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
2328
+ .replace(`{${"enquiryId"}}`, encodeURIComponent(String(enquiryId)));
2329
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2330
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2331
+ let baseOptions;
2332
+ if (configuration) {
2333
+ baseOptions = configuration.baseOptions;
2334
+ }
2335
+
2336
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2337
+ const localVarHeaderParameter = {} as any;
2338
+ const localVarQueryParameter = {} as any;
2339
+
2340
+ // authentication session-oauth required
2341
+ // oauth required
2342
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
2343
+
2344
+ // authentication api-key required
2345
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2346
+
2347
+ if (project !== undefined) {
2348
+ localVarQueryParameter['project'] = project;
2349
+ }
2350
+
2351
+
2352
+
2353
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2354
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2355
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2356
+
2357
+ return {
2358
+ url: toPathString(localVarUrlObj),
2359
+ options: localVarRequestOptions,
2360
+ };
2361
+ },
2285
2362
  /**
2286
2363
  * Get a customer enquiry
2287
2364
  * @summary Get customer enquiry
2288
2365
  * @param {string} project Project unique identifier
2289
2366
  * @param {string} platformId The platform identifier
2290
- * @param {string} enquiryId
2367
+ * @param {string} enquiryId The enquiry identifier
2291
2368
  * @param {*} [options] Override http request option.
2292
2369
  * @throws {RequiredError}
2293
2370
  */
@@ -2416,7 +2493,7 @@ export const EnquiriesApiAxiosParamCreator = function (configuration?: Configura
2416
2493
  * @summary List customer enquiry Logs
2417
2494
  * @param {string} project Project unique identifier
2418
2495
  * @param {string} platformId The platform identifier
2419
- * @param {string} enquiryId
2496
+ * @param {string} enquiryId The enquiry identifier
2420
2497
  * @param {*} [options] Override http request option.
2421
2498
  * @throws {RequiredError}
2422
2499
  */
@@ -2473,12 +2550,27 @@ export const EnquiriesApiAxiosParamCreator = function (configuration?: Configura
2473
2550
  export const EnquiriesApiFp = function(configuration?: Configuration) {
2474
2551
  const localVarAxiosParamCreator = EnquiriesApiAxiosParamCreator(configuration)
2475
2552
  return {
2553
+ /**
2554
+ * Create a chat channel for a customer enquiry if it doesn\'t exist
2555
+ * @summary Create chat channel
2556
+ * @param {string} project Project unique identifier
2557
+ * @param {string} platformId The platform identifier
2558
+ * @param {string} enquiryId The enquiry identifier
2559
+ * @param {*} [options] Override http request option.
2560
+ * @throws {RequiredError}
2561
+ */
2562
+ async createChatChannel(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateChatChannel200Response>> {
2563
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createChatChannel(project, platformId, enquiryId, options);
2564
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2565
+ const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.createChatChannel']?.[localVarOperationServerIndex]?.url;
2566
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2567
+ },
2476
2568
  /**
2477
2569
  * Get a customer enquiry
2478
2570
  * @summary Get customer enquiry
2479
2571
  * @param {string} project Project unique identifier
2480
2572
  * @param {string} platformId The platform identifier
2481
- * @param {string} enquiryId
2573
+ * @param {string} enquiryId The enquiry identifier
2482
2574
  * @param {*} [options] Override http request option.
2483
2575
  * @throws {RequiredError}
2484
2576
  */
@@ -2512,7 +2604,7 @@ export const EnquiriesApiFp = function(configuration?: Configuration) {
2512
2604
  * @summary List customer enquiry Logs
2513
2605
  * @param {string} project Project unique identifier
2514
2606
  * @param {string} platformId The platform identifier
2515
- * @param {string} enquiryId
2607
+ * @param {string} enquiryId The enquiry identifier
2516
2608
  * @param {*} [options] Override http request option.
2517
2609
  * @throws {RequiredError}
2518
2610
  */
@@ -2532,6 +2624,16 @@ export const EnquiriesApiFp = function(configuration?: Configuration) {
2532
2624
  export const EnquiriesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2533
2625
  const localVarFp = EnquiriesApiFp(configuration)
2534
2626
  return {
2627
+ /**
2628
+ * Create a chat channel for a customer enquiry if it doesn\'t exist
2629
+ * @summary Create chat channel
2630
+ * @param {EnquiriesApiCreateChatChannelRequest} requestParameters Request parameters.
2631
+ * @param {*} [options] Override http request option.
2632
+ * @throws {RequiredError}
2633
+ */
2634
+ createChatChannel(requestParameters: EnquiriesApiCreateChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateChatChannel200Response> {
2635
+ return localVarFp.createChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
2636
+ },
2535
2637
  /**
2536
2638
  * Get a customer enquiry
2537
2639
  * @summary Get customer enquiry
@@ -2565,6 +2667,34 @@ export const EnquiriesApiFactory = function (configuration?: Configuration, base
2565
2667
  };
2566
2668
  };
2567
2669
 
2670
+ /**
2671
+ * Request parameters for createChatChannel operation in EnquiriesApi.
2672
+ * @export
2673
+ * @interface EnquiriesApiCreateChatChannelRequest
2674
+ */
2675
+ export interface EnquiriesApiCreateChatChannelRequest {
2676
+ /**
2677
+ * Project unique identifier
2678
+ * @type {string}
2679
+ * @memberof EnquiriesApiCreateChatChannel
2680
+ */
2681
+ readonly project: string
2682
+
2683
+ /**
2684
+ * The platform identifier
2685
+ * @type {string}
2686
+ * @memberof EnquiriesApiCreateChatChannel
2687
+ */
2688
+ readonly platformId: string
2689
+
2690
+ /**
2691
+ * The enquiry identifier
2692
+ * @type {string}
2693
+ * @memberof EnquiriesApiCreateChatChannel
2694
+ */
2695
+ readonly enquiryId: string
2696
+ }
2697
+
2568
2698
  /**
2569
2699
  * Request parameters for getCustomerEnquiry operation in EnquiriesApi.
2570
2700
  * @export
@@ -2586,7 +2716,7 @@ export interface EnquiriesApiGetCustomerEnquiryRequest {
2586
2716
  readonly platformId: string
2587
2717
 
2588
2718
  /**
2589
- *
2719
+ * The enquiry identifier
2590
2720
  * @type {string}
2591
2721
  * @memberof EnquiriesApiGetCustomerEnquiry
2592
2722
  */
@@ -2670,7 +2800,7 @@ export interface EnquiriesApiListCustomerEnquiryLogsRequest {
2670
2800
  readonly platformId: string
2671
2801
 
2672
2802
  /**
2673
- *
2803
+ * The enquiry identifier
2674
2804
  * @type {string}
2675
2805
  * @memberof EnquiriesApiListCustomerEnquiryLogs
2676
2806
  */
@@ -2684,6 +2814,18 @@ export interface EnquiriesApiListCustomerEnquiryLogsRequest {
2684
2814
  * @extends {BaseAPI}
2685
2815
  */
2686
2816
  export class EnquiriesApi extends BaseAPI {
2817
+ /**
2818
+ * Create a chat channel for a customer enquiry if it doesn\'t exist
2819
+ * @summary Create chat channel
2820
+ * @param {EnquiriesApiCreateChatChannelRequest} requestParameters Request parameters.
2821
+ * @param {*} [options] Override http request option.
2822
+ * @throws {RequiredError}
2823
+ * @memberof EnquiriesApi
2824
+ */
2825
+ public createChatChannel(requestParameters: EnquiriesApiCreateChatChannelRequest, options?: RawAxiosRequestConfig) {
2826
+ return EnquiriesApiFp(this.configuration).createChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
2827
+ }
2828
+
2687
2829
  /**
2688
2830
  * Get a customer enquiry
2689
2831
  * @summary Get customer enquiry
@@ -2893,6 +3035,58 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
2893
3035
 
2894
3036
 
2895
3037
 
3038
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3039
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3040
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3041
+
3042
+ return {
3043
+ url: toPathString(localVarUrlObj),
3044
+ options: localVarRequestOptions,
3045
+ };
3046
+ },
3047
+ /**
3048
+ * Get an order receipt for a platform by a given order ID.
3049
+ * @summary Get order receipt
3050
+ * @param {string} project Project unique identifier
3051
+ * @param {string} platformId The platform identifier
3052
+ * @param {string} orderId The order identifier
3053
+ * @param {*} [options] Override http request option.
3054
+ * @throws {RequiredError}
3055
+ */
3056
+ getOrderReceipt: async (project: string, platformId: string, orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3057
+ // verify required parameter 'project' is not null or undefined
3058
+ assertParamExists('getOrderReceipt', 'project', project)
3059
+ // verify required parameter 'platformId' is not null or undefined
3060
+ assertParamExists('getOrderReceipt', 'platformId', platformId)
3061
+ // verify required parameter 'orderId' is not null or undefined
3062
+ assertParamExists('getOrderReceipt', 'orderId', orderId)
3063
+ const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/receipt`
3064
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3065
+ .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
3066
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3067
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3068
+ let baseOptions;
3069
+ if (configuration) {
3070
+ baseOptions = configuration.baseOptions;
3071
+ }
3072
+
3073
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3074
+ const localVarHeaderParameter = {} as any;
3075
+ const localVarQueryParameter = {} as any;
3076
+
3077
+ // authentication session-oauth required
3078
+ // oauth required
3079
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3080
+
3081
+ // authentication api-key required
3082
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3083
+
3084
+ if (project !== undefined) {
3085
+ localVarQueryParameter['project'] = project;
3086
+ }
3087
+
3088
+
3089
+
2896
3090
  setSearchParams(localVarUrlObj, localVarQueryParameter);
2897
3091
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2898
3092
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -3079,6 +3273,58 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
3079
3273
 
3080
3274
 
3081
3275
 
3276
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3277
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3278
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3279
+
3280
+ return {
3281
+ url: toPathString(localVarUrlObj),
3282
+ options: localVarRequestOptions,
3283
+ };
3284
+ },
3285
+ /**
3286
+ * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
3287
+ * @summary Send order receipt
3288
+ * @param {string} project Project unique identifier
3289
+ * @param {string} platformId The platform identifier
3290
+ * @param {string} orderId The order identifier
3291
+ * @param {*} [options] Override http request option.
3292
+ * @throws {RequiredError}
3293
+ */
3294
+ sendOrderReceipt: async (project: string, platformId: string, orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3295
+ // verify required parameter 'project' is not null or undefined
3296
+ assertParamExists('sendOrderReceipt', 'project', project)
3297
+ // verify required parameter 'platformId' is not null or undefined
3298
+ assertParamExists('sendOrderReceipt', 'platformId', platformId)
3299
+ // verify required parameter 'orderId' is not null or undefined
3300
+ assertParamExists('sendOrderReceipt', 'orderId', orderId)
3301
+ const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/receipt/send`
3302
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3303
+ .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
3304
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3305
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3306
+ let baseOptions;
3307
+ if (configuration) {
3308
+ baseOptions = configuration.baseOptions;
3309
+ }
3310
+
3311
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
3312
+ const localVarHeaderParameter = {} as any;
3313
+ const localVarQueryParameter = {} as any;
3314
+
3315
+ // authentication session-oauth required
3316
+ // oauth required
3317
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3318
+
3319
+ // authentication api-key required
3320
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3321
+
3322
+ if (project !== undefined) {
3323
+ localVarQueryParameter['project'] = project;
3324
+ }
3325
+
3326
+
3327
+
3082
3328
  setSearchParams(localVarUrlObj, localVarQueryParameter);
3083
3329
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3084
3330
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -3203,6 +3449,21 @@ export const OrdersApiFp = function(configuration?: Configuration) {
3203
3449
  const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrder']?.[localVarOperationServerIndex]?.url;
3204
3450
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3205
3451
  },
3452
+ /**
3453
+ * Get an order receipt for a platform by a given order ID.
3454
+ * @summary Get order receipt
3455
+ * @param {string} project Project unique identifier
3456
+ * @param {string} platformId The platform identifier
3457
+ * @param {string} orderId The order identifier
3458
+ * @param {*} [options] Override http request option.
3459
+ * @throws {RequiredError}
3460
+ */
3461
+ async getOrderReceipt(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
3462
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderReceipt(project, platformId, orderId, options);
3463
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3464
+ const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderReceipt']?.[localVarOperationServerIndex]?.url;
3465
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3466
+ },
3206
3467
  /**
3207
3468
  * List available fulfillers for a given fulfillment
3208
3469
  * @summary List available fulfillers
@@ -3253,6 +3514,21 @@ export const OrdersApiFp = function(configuration?: Configuration) {
3253
3514
  const localVarOperationServerBasePath = operationServerMap['OrdersApi.retryPlatformPayment']?.[localVarOperationServerIndex]?.url;
3254
3515
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3255
3516
  },
3517
+ /**
3518
+ * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
3519
+ * @summary Send order receipt
3520
+ * @param {string} project Project unique identifier
3521
+ * @param {string} platformId The platform identifier
3522
+ * @param {string} orderId The order identifier
3523
+ * @param {*} [options] Override http request option.
3524
+ * @throws {RequiredError}
3525
+ */
3526
+ async sendOrderReceipt(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
3527
+ const localVarAxiosArgs = await localVarAxiosParamCreator.sendOrderReceipt(project, platformId, orderId, options);
3528
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3529
+ const localVarOperationServerBasePath = operationServerMap['OrdersApi.sendOrderReceipt']?.[localVarOperationServerIndex]?.url;
3530
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3531
+ },
3256
3532
  /**
3257
3533
  * Update a fulfillment that belongs to an order placed through the platform
3258
3534
  * @summary Update fulfillment
@@ -3309,6 +3585,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
3309
3585
  getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
3310
3586
  return localVarFp.getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
3311
3587
  },
3588
+ /**
3589
+ * Get an order receipt for a platform by a given order ID.
3590
+ * @summary Get order receipt
3591
+ * @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
3592
+ * @param {*} [options] Override http request option.
3593
+ * @throws {RequiredError}
3594
+ */
3595
+ getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<string> {
3596
+ return localVarFp.getOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
3597
+ },
3312
3598
  /**
3313
3599
  * List available fulfillers for a given fulfillment
3314
3600
  * @summary List available fulfillers
@@ -3339,6 +3625,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
3339
3625
  retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
3340
3626
  return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
3341
3627
  },
3628
+ /**
3629
+ * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
3630
+ * @summary Send order receipt
3631
+ * @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
3632
+ * @param {*} [options] Override http request option.
3633
+ * @throws {RequiredError}
3634
+ */
3635
+ sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
3636
+ return localVarFp.sendOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
3637
+ },
3342
3638
  /**
3343
3639
  * Update a fulfillment that belongs to an order placed through the platform
3344
3640
  * @summary Update fulfillment
@@ -3450,6 +3746,34 @@ export interface OrdersApiGetOrderRequest {
3450
3746
  readonly orderId: string
3451
3747
  }
3452
3748
 
3749
+ /**
3750
+ * Request parameters for getOrderReceipt operation in OrdersApi.
3751
+ * @export
3752
+ * @interface OrdersApiGetOrderReceiptRequest
3753
+ */
3754
+ export interface OrdersApiGetOrderReceiptRequest {
3755
+ /**
3756
+ * Project unique identifier
3757
+ * @type {string}
3758
+ * @memberof OrdersApiGetOrderReceipt
3759
+ */
3760
+ readonly project: string
3761
+
3762
+ /**
3763
+ * The platform identifier
3764
+ * @type {string}
3765
+ * @memberof OrdersApiGetOrderReceipt
3766
+ */
3767
+ readonly platformId: string
3768
+
3769
+ /**
3770
+ * The order identifier
3771
+ * @type {string}
3772
+ * @memberof OrdersApiGetOrderReceipt
3773
+ */
3774
+ readonly orderId: string
3775
+ }
3776
+
3453
3777
  /**
3454
3778
  * Request parameters for listAvailableFulfillers operation in OrdersApi.
3455
3779
  * @export
@@ -3569,6 +3893,34 @@ export interface OrdersApiRetryPlatformPaymentRequest {
3569
3893
  readonly orderId: string
3570
3894
  }
3571
3895
 
3896
+ /**
3897
+ * Request parameters for sendOrderReceipt operation in OrdersApi.
3898
+ * @export
3899
+ * @interface OrdersApiSendOrderReceiptRequest
3900
+ */
3901
+ export interface OrdersApiSendOrderReceiptRequest {
3902
+ /**
3903
+ * Project unique identifier
3904
+ * @type {string}
3905
+ * @memberof OrdersApiSendOrderReceipt
3906
+ */
3907
+ readonly project: string
3908
+
3909
+ /**
3910
+ * The platform identifier
3911
+ * @type {string}
3912
+ * @memberof OrdersApiSendOrderReceipt
3913
+ */
3914
+ readonly platformId: string
3915
+
3916
+ /**
3917
+ * The order identifier
3918
+ * @type {string}
3919
+ * @memberof OrdersApiSendOrderReceipt
3920
+ */
3921
+ readonly orderId: string
3922
+ }
3923
+
3572
3924
  /**
3573
3925
  * Request parameters for updateFulfillment operation in OrdersApi.
3574
3926
  * @export
@@ -3647,6 +3999,18 @@ export class OrdersApi extends BaseAPI {
3647
3999
  return OrdersApiFp(this.configuration).getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
3648
4000
  }
3649
4001
 
4002
+ /**
4003
+ * Get an order receipt for a platform by a given order ID.
4004
+ * @summary Get order receipt
4005
+ * @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
4006
+ * @param {*} [options] Override http request option.
4007
+ * @throws {RequiredError}
4008
+ * @memberof OrdersApi
4009
+ */
4010
+ public getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig) {
4011
+ return OrdersApiFp(this.configuration).getOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
4012
+ }
4013
+
3650
4014
  /**
3651
4015
  * List available fulfillers for a given fulfillment
3652
4016
  * @summary List available fulfillers
@@ -3683,6 +4047,18 @@ export class OrdersApi extends BaseAPI {
3683
4047
  return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
3684
4048
  }
3685
4049
 
4050
+ /**
4051
+ * Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
4052
+ * @summary Send order receipt
4053
+ * @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
4054
+ * @param {*} [options] Override http request option.
4055
+ * @throws {RequiredError}
4056
+ * @memberof OrdersApi
4057
+ */
4058
+ public sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig) {
4059
+ return OrdersApiFp(this.configuration).sendOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
4060
+ }
4061
+
3686
4062
  /**
3687
4063
  * Update a fulfillment that belongs to an order placed through the platform
3688
4064
  * @summary Update fulfillment
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.22.3
7
+ * The version of the OpenAPI document: 0.24.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.22.3
7
+ * The version of the OpenAPI document: 0.24.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.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.22.3
7
+ * The version of the OpenAPI document: 0.24.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).