@teemill/platform 0.23.0 → 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.23.0
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.23.0 --save
39
+ npm install @teemill/platform@0.24.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -61,9 +61,11 @@ Class | Method | HTTP request | Description
61
61
  *OrdersApi* | [**exportOrders**](docs/OrdersApi.md#exportorders) | **GET** /v1/platform/{platformId}/orders/export | Export orders
62
62
  *OrdersApi* | [**getFulfillment**](docs/OrdersApi.md#getfulfillment) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Get fulfillment
63
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
64
65
  *OrdersApi* | [**listAvailableFulfillers**](docs/OrdersApi.md#listavailablefulfillers) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers | List available fulfillers
65
66
  *OrdersApi* | [**listOrders**](docs/OrdersApi.md#listorders) | **GET** /v1/platform/{platformId}/orders | List orders
66
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
67
69
  *OrdersApi* | [**updateFulfillment**](docs/OrdersApi.md#updatefulfillment) | **PATCH** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment
68
70
  *PaymentApi* | [**authorizeStripe**](docs/PaymentApi.md#authorizestripe) | **GET** /v1/platform/payment/stripe/authorize | Authorize Stripe
69
71
  *PaymentApi* | [**deauthorizeStripe**](docs/PaymentApi.md#deauthorizestripe) | **DELETE** /v1/platform/payment/stripe/deauthorize | Deauthorize Stripe
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.23.0
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).
@@ -890,6 +890,12 @@ export interface Order {
890
890
  * @memberof Order
891
891
  */
892
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;
893
899
  }
894
900
 
895
901
 
@@ -3029,6 +3035,58 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
3029
3035
 
3030
3036
 
3031
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
+
3032
3090
  setSearchParams(localVarUrlObj, localVarQueryParameter);
3033
3091
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3034
3092
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -3215,6 +3273,58 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
3215
3273
 
3216
3274
 
3217
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
+
3218
3328
  setSearchParams(localVarUrlObj, localVarQueryParameter);
3219
3329
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3220
3330
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -3339,6 +3449,21 @@ export const OrdersApiFp = function(configuration?: Configuration) {
3339
3449
  const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrder']?.[localVarOperationServerIndex]?.url;
3340
3450
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3341
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
+ },
3342
3467
  /**
3343
3468
  * List available fulfillers for a given fulfillment
3344
3469
  * @summary List available fulfillers
@@ -3389,6 +3514,21 @@ export const OrdersApiFp = function(configuration?: Configuration) {
3389
3514
  const localVarOperationServerBasePath = operationServerMap['OrdersApi.retryPlatformPayment']?.[localVarOperationServerIndex]?.url;
3390
3515
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3391
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
+ },
3392
3532
  /**
3393
3533
  * Update a fulfillment that belongs to an order placed through the platform
3394
3534
  * @summary Update fulfillment
@@ -3445,6 +3585,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
3445
3585
  getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
3446
3586
  return localVarFp.getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
3447
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
+ },
3448
3598
  /**
3449
3599
  * List available fulfillers for a given fulfillment
3450
3600
  * @summary List available fulfillers
@@ -3475,6 +3625,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
3475
3625
  retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
3476
3626
  return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
3477
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
+ },
3478
3638
  /**
3479
3639
  * Update a fulfillment that belongs to an order placed through the platform
3480
3640
  * @summary Update fulfillment
@@ -3586,6 +3746,34 @@ export interface OrdersApiGetOrderRequest {
3586
3746
  readonly orderId: string
3587
3747
  }
3588
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
+
3589
3777
  /**
3590
3778
  * Request parameters for listAvailableFulfillers operation in OrdersApi.
3591
3779
  * @export
@@ -3705,6 +3893,34 @@ export interface OrdersApiRetryPlatformPaymentRequest {
3705
3893
  readonly orderId: string
3706
3894
  }
3707
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
+
3708
3924
  /**
3709
3925
  * Request parameters for updateFulfillment operation in OrdersApi.
3710
3926
  * @export
@@ -3783,6 +3999,18 @@ export class OrdersApi extends BaseAPI {
3783
3999
  return OrdersApiFp(this.configuration).getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
3784
4000
  }
3785
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
+
3786
4014
  /**
3787
4015
  * List available fulfillers for a given fulfillment
3788
4016
  * @summary List available fulfillers
@@ -3819,6 +4047,18 @@ export class OrdersApi extends BaseAPI {
3819
4047
  return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
3820
4048
  }
3821
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
+
3822
4062
  /**
3823
4063
  * Update a fulfillment that belongs to an order placed through the platform
3824
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.23.0
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.23.0
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.23.0
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/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.23.0
5
+ * The version of the OpenAPI document: 0.24.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -874,6 +874,12 @@ export interface Order {
874
874
  * @memberof Order
875
875
  */
876
876
  'paymentAttempts'?: Array<PaymentAttempt>;
877
+ /**
878
+ * The integration type of the order, e.g. \"website\" or \"shopify\"
879
+ * @type {string}
880
+ * @memberof Order
881
+ */
882
+ 'integrationType'?: string;
877
883
  }
878
884
  /**
879
885
  *
@@ -2371,6 +2377,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
2371
2377
  * @throws {RequiredError}
2372
2378
  */
2373
2379
  getOrder: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2380
+ /**
2381
+ * Get an order receipt for a platform by a given order ID.
2382
+ * @summary Get order receipt
2383
+ * @param {string} project Project unique identifier
2384
+ * @param {string} platformId The platform identifier
2385
+ * @param {string} orderId The order identifier
2386
+ * @param {*} [options] Override http request option.
2387
+ * @throws {RequiredError}
2388
+ */
2389
+ getOrderReceipt: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2374
2390
  /**
2375
2391
  * List available fulfillers for a given fulfillment
2376
2392
  * @summary List available fulfillers
@@ -2406,6 +2422,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
2406
2422
  * @throws {RequiredError}
2407
2423
  */
2408
2424
  retryPlatformPayment: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2425
+ /**
2426
+ * 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.
2427
+ * @summary Send order receipt
2428
+ * @param {string} project Project unique identifier
2429
+ * @param {string} platformId The platform identifier
2430
+ * @param {string} orderId The order identifier
2431
+ * @param {*} [options] Override http request option.
2432
+ * @throws {RequiredError}
2433
+ */
2434
+ sendOrderReceipt: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2409
2435
  /**
2410
2436
  * Update a fulfillment that belongs to an order placed through the platform
2411
2437
  * @summary Update fulfillment
@@ -2455,6 +2481,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
2455
2481
  * @throws {RequiredError}
2456
2482
  */
2457
2483
  getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
2484
+ /**
2485
+ * Get an order receipt for a platform by a given order ID.
2486
+ * @summary Get order receipt
2487
+ * @param {string} project Project unique identifier
2488
+ * @param {string} platformId The platform identifier
2489
+ * @param {string} orderId The order identifier
2490
+ * @param {*} [options] Override http request option.
2491
+ * @throws {RequiredError}
2492
+ */
2493
+ getOrderReceipt(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
2458
2494
  /**
2459
2495
  * List available fulfillers for a given fulfillment
2460
2496
  * @summary List available fulfillers
@@ -2490,6 +2526,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
2490
2526
  * @throws {RequiredError}
2491
2527
  */
2492
2528
  retryPlatformPayment(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
2529
+ /**
2530
+ * 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.
2531
+ * @summary Send order receipt
2532
+ * @param {string} project Project unique identifier
2533
+ * @param {string} platformId The platform identifier
2534
+ * @param {string} orderId The order identifier
2535
+ * @param {*} [options] Override http request option.
2536
+ * @throws {RequiredError}
2537
+ */
2538
+ sendOrderReceipt(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2493
2539
  /**
2494
2540
  * Update a fulfillment that belongs to an order placed through the platform
2495
2541
  * @summary Update fulfillment
@@ -2531,6 +2577,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
2531
2577
  * @throws {RequiredError}
2532
2578
  */
2533
2579
  getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
2580
+ /**
2581
+ * Get an order receipt for a platform by a given order ID.
2582
+ * @summary Get order receipt
2583
+ * @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
2584
+ * @param {*} [options] Override http request option.
2585
+ * @throws {RequiredError}
2586
+ */
2587
+ getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
2534
2588
  /**
2535
2589
  * List available fulfillers for a given fulfillment
2536
2590
  * @summary List available fulfillers
@@ -2555,6 +2609,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
2555
2609
  * @throws {RequiredError}
2556
2610
  */
2557
2611
  retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
2612
+ /**
2613
+ * 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.
2614
+ * @summary Send order receipt
2615
+ * @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
2616
+ * @param {*} [options] Override http request option.
2617
+ * @throws {RequiredError}
2618
+ */
2619
+ sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2558
2620
  /**
2559
2621
  * Update a fulfillment that belongs to an order placed through the platform
2560
2622
  * @summary Update fulfillment
@@ -2651,6 +2713,31 @@ export interface OrdersApiGetOrderRequest {
2651
2713
  */
2652
2714
  readonly orderId: string;
2653
2715
  }
2716
+ /**
2717
+ * Request parameters for getOrderReceipt operation in OrdersApi.
2718
+ * @export
2719
+ * @interface OrdersApiGetOrderReceiptRequest
2720
+ */
2721
+ export interface OrdersApiGetOrderReceiptRequest {
2722
+ /**
2723
+ * Project unique identifier
2724
+ * @type {string}
2725
+ * @memberof OrdersApiGetOrderReceipt
2726
+ */
2727
+ readonly project: string;
2728
+ /**
2729
+ * The platform identifier
2730
+ * @type {string}
2731
+ * @memberof OrdersApiGetOrderReceipt
2732
+ */
2733
+ readonly platformId: string;
2734
+ /**
2735
+ * The order identifier
2736
+ * @type {string}
2737
+ * @memberof OrdersApiGetOrderReceipt
2738
+ */
2739
+ readonly orderId: string;
2740
+ }
2654
2741
  /**
2655
2742
  * Request parameters for listAvailableFulfillers operation in OrdersApi.
2656
2743
  * @export
@@ -2756,6 +2843,31 @@ export interface OrdersApiRetryPlatformPaymentRequest {
2756
2843
  */
2757
2844
  readonly orderId: string;
2758
2845
  }
2846
+ /**
2847
+ * Request parameters for sendOrderReceipt operation in OrdersApi.
2848
+ * @export
2849
+ * @interface OrdersApiSendOrderReceiptRequest
2850
+ */
2851
+ export interface OrdersApiSendOrderReceiptRequest {
2852
+ /**
2853
+ * Project unique identifier
2854
+ * @type {string}
2855
+ * @memberof OrdersApiSendOrderReceipt
2856
+ */
2857
+ readonly project: string;
2858
+ /**
2859
+ * The platform identifier
2860
+ * @type {string}
2861
+ * @memberof OrdersApiSendOrderReceipt
2862
+ */
2863
+ readonly platformId: string;
2864
+ /**
2865
+ * The order identifier
2866
+ * @type {string}
2867
+ * @memberof OrdersApiSendOrderReceipt
2868
+ */
2869
+ readonly orderId: string;
2870
+ }
2759
2871
  /**
2760
2872
  * Request parameters for updateFulfillment operation in OrdersApi.
2761
2873
  * @export
@@ -2821,6 +2933,15 @@ export declare class OrdersApi extends BaseAPI {
2821
2933
  * @memberof OrdersApi
2822
2934
  */
2823
2935
  getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
2936
+ /**
2937
+ * Get an order receipt for a platform by a given order ID.
2938
+ * @summary Get order receipt
2939
+ * @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
2940
+ * @param {*} [options] Override http request option.
2941
+ * @throws {RequiredError}
2942
+ * @memberof OrdersApi
2943
+ */
2944
+ getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
2824
2945
  /**
2825
2946
  * List available fulfillers for a given fulfillment
2826
2947
  * @summary List available fulfillers
@@ -2848,6 +2969,15 @@ export declare class OrdersApi extends BaseAPI {
2848
2969
  * @memberof OrdersApi
2849
2970
  */
2850
2971
  retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
2972
+ /**
2973
+ * 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.
2974
+ * @summary Send order receipt
2975
+ * @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
2976
+ * @param {*} [options] Override http request option.
2977
+ * @throws {RequiredError}
2978
+ * @memberof OrdersApi
2979
+ */
2980
+ sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
2851
2981
  /**
2852
2982
  * Update a fulfillment that belongs to an order placed through the platform
2853
2983
  * @summary Update fulfillment