Skip to content

Commit da6fdea

Browse files
Release 5.1.0
1 parent 60a978f commit da6fdea

File tree

7 files changed

+287
-77
lines changed

7 files changed

+287
-77
lines changed

README.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -105,24 +105,39 @@ Web Api client: [*link*](https://checkout.postfinance.ch//api/client)<br>
105105
&nbsp;&nbsp;&nbsp;&nbsp;Deactivate an account
106106
<br><br>
107107
- <strong>AnalyticsQueriesService</strong><br>
108-
&nbsp;&nbsp;* <code>deleteAnalyticsQueriesQueryToken</code>
109-
&nbsp;&nbsp;&nbsp;&nbsp;<strong>DELETE</strong> /analytics/queries/{queryToken}
110-
&nbsp;&nbsp;&nbsp;&nbsp;Cancel a query execution
108+
&nbsp;&nbsp;* <code>deleteAnalyticsQueriesQueryExternalIdQueryExternalId</code>
109+
&nbsp;&nbsp;&nbsp;&nbsp;<strong>DELETE</strong> /analytics/queries/queryExternalId/{queryExternalId}
110+
&nbsp;&nbsp;&nbsp;&nbsp;Cancel a query execution, identifying it by its external id.
111+
<br><br>
112+
- <strong>AnalyticsQueriesService</strong><br>
113+
&nbsp;&nbsp;* <code>deleteAnalyticsQueriesQueryTokenQueryToken</code>
114+
&nbsp;&nbsp;&nbsp;&nbsp;<strong>DELETE</strong> /analytics/queries/queryToken/{queryToken}
115+
&nbsp;&nbsp;&nbsp;&nbsp;Cancel a query execution, identifying it by its query token.
111116
<br><br>
112117
- <strong>AnalyticsQueriesService</strong><br>
113118
&nbsp;&nbsp;* <code>getAnalyticsQueries</code>
114119
&nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries
115120
&nbsp;&nbsp;&nbsp;&nbsp;Get portion of query executions for account
116121
<br><br>
117122
- <strong>AnalyticsQueriesService</strong><br>
118-
&nbsp;&nbsp;* <code>getAnalyticsQueriesQueryToken</code>
119-
&nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/{queryToken}
120-
&nbsp;&nbsp;&nbsp;&nbsp;Retrieve a query execution information
123+
&nbsp;&nbsp;* <code>getAnalyticsQueriesQueryExternalIdQueryExternalId</code>
124+
&nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/queryExternalId/{queryExternalId}
125+
&nbsp;&nbsp;&nbsp;&nbsp;Retrieve a query execution information by its external id
126+
<br><br>
127+
- <strong>AnalyticsQueriesService</strong><br>
128+
&nbsp;&nbsp;* <code>getAnalyticsQueriesQueryExternalIdQueryExternalIdResult</code>
129+
&nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/queryExternalId/{queryExternalId}/result
130+
&nbsp;&nbsp;&nbsp;&nbsp;Generate a temporary URL to download the query result. It retrieves the query by its external id
131+
<br><br>
132+
- <strong>AnalyticsQueriesService</strong><br>
133+
&nbsp;&nbsp;* <code>getAnalyticsQueriesQueryTokenQueryToken</code>
134+
&nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/queryToken/{queryToken}
135+
&nbsp;&nbsp;&nbsp;&nbsp;Retrieve a query execution information by its query token
121136
<br><br>
122137
- <strong>AnalyticsQueriesService</strong><br>
123-
&nbsp;&nbsp;* <code>getAnalyticsQueriesQueryTokenResult</code>
124-
&nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/{queryToken}/result
125-
&nbsp;&nbsp;&nbsp;&nbsp;Generate a temporary URL to download the query result
138+
&nbsp;&nbsp;* <code>getAnalyticsQueriesQueryTokenQueryTokenResult</code>
139+
&nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/queryToken/{queryToken}/result
140+
&nbsp;&nbsp;&nbsp;&nbsp;Generate a temporary URL to download the query result. It retrieves the query by its query token
126141
<br><br>
127142
- <strong>AnalyticsQueriesService</strong><br>
128143
&nbsp;&nbsp;* <code>postAnalyticsQueriesSubmit</code>

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "postfinancecheckout",
33
"title": "postfinancecheckout",
4-
"version": "5.0.0",
4+
"version": "5.1.0",
55
"description": "TypeScript/JavaScript client for postfinancecheckout",
66
"author": "wallee AG",
77
"repository": {

src/models/AnalyticsQueryExecutionRequest.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,19 @@ import { mapValues } from '../runtime';
2929
*/
3030
export interface AnalyticsQueryExecutionRequest {
3131
/**
32-
* Optional. Active SFTP Dispatch connection settings ID (dispatch settings ID) associated with the target account. Only required if the Analytics query result file is scheduled for delivery to a remote SFTP server.
32+
* Optional. ID of the active SFTP configuration to use (associated with the target account). This is only required if the result file is scheduled for delivery to a remote SFTP server.
3333
* @type {number}
3434
* @memberof AnalyticsQueryExecutionRequest
3535
*/
3636
sftpDispatchSettingsId?: number;
3737
/**
38-
* Optional. Renaming pattern for Analytics query result file (may be used when Analytics query results file is scheduled for SFTP delivery). Pattern may look like Latin alphabet string with some timestamp placeholder: "transaction_report_{YYYMMDD_hhmmss}". Supported placeholder formats are just these: DDMMYY , MMDDYY , YYYYMMDD , DD_MM_YY , DD-MM-YY , YYYY-MM-DD , YYYY_MM_DD , YYYYMMDD_hhmmss , YYYY-MM-DD_hh-mm-ss
38+
* Optional. Renaming pattern used for the result file during SFTP delivery. You can use a combination of fixed Latin text and timestamp variables (e.g., "transaction_report_{YYYMMDD_hhmmss}"). Supported variable formats: DDMMYY, MMDDYY, YYYYMMDD, DD_MM_YY, DD-MM-YY, YYYY-MM-DD, YYYY_MM_DD, YYYYMMDD_hhmmss, YYYY-MM-DD_hh-mm-ss.
3939
* @type {string}
4040
* @memberof AnalyticsQueryExecutionRequest
4141
*/
4242
sftpDispatchResultFileRenamePattern?: string;
4343
/**
44-
* The SQL query (in PrestoDB dialect) to be executed against the analytics database. This query defines the data retrieval operation.
44+
* The SQL query (in PrestoDB dialect) to execute on the analytics database. This query defines exactly which data should be retrieved.
4545
* @type {string}
4646
* @memberof AnalyticsQueryExecutionRequest
4747
*/

src/models/SubmittedAnalyticsQueryExecution.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ import {
3535
* @interface SubmittedAnalyticsQueryExecution
3636
*/
3737
export interface SubmittedAnalyticsQueryExecution {
38+
/**
39+
* The external id associated with this query, if any.
40+
* @type {string}
41+
* @memberof SubmittedAnalyticsQueryExecution
42+
*/
43+
readonly queryExternalId?: string;
3844
/**
3945
* The ID of the target account for which the analytics query will be executed, determining the data scope for the request.
4046
* @type {number}
@@ -108,6 +114,7 @@ export function SubmittedAnalyticsQueryExecutionFromJSONTyped(json: any, ignoreD
108114
}
109115
return {
110116

117+
'queryExternalId': json['queryExternalId'] == null ? undefined : json['queryExternalId'],
111118
'accountId': json['accountId'] == null ? undefined : json['accountId'],
112119
'totalBilledExecutionTimeMs': json['totalBilledExecutionTimeMs'] == null ? undefined : json['totalBilledExecutionTimeMs'],
113120
'createdTimestamp': json['createdTimestamp'] == null ? undefined : (new Date(json['createdTimestamp'])),
@@ -120,7 +127,7 @@ export function SubmittedAnalyticsQueryExecutionFromJSONTyped(json: any, ignoreD
120127
};
121128
}
122129

123-
export function SubmittedAnalyticsQueryExecutionToJSON(value?: Omit<SubmittedAnalyticsQueryExecution, 'accountId'|'totalBilledExecutionTimeMs'|'createdTimestamp'|'downloadRequests'|'originalQuery'|'scannedBytes'|'portalQueryToken'|'resultFileBytes'> | null): any {
130+
export function SubmittedAnalyticsQueryExecutionToJSON(value?: Omit<SubmittedAnalyticsQueryExecution, 'queryExternalId'|'accountId'|'totalBilledExecutionTimeMs'|'createdTimestamp'|'downloadRequests'|'originalQuery'|'scannedBytes'|'portalQueryToken'|'resultFileBytes'> | null): any {
124131
if (value == null) {
125132
return value;
126133
}

src/models/SubscriptionUpdateRequest.ts

Lines changed: 4 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -22,43 +22,18 @@
2222
* limitations under the License.
2323
*/
2424
import { mapValues } from '../runtime';
25-
import type { SubscriptionComponentReferenceConfiguration } from './SubscriptionComponentReferenceConfiguration';
26-
import {
27-
SubscriptionComponentReferenceConfigurationFromJSON,
28-
SubscriptionComponentReferenceConfigurationFromJSONTyped,
29-
SubscriptionComponentReferenceConfigurationToJSON,
30-
} from './SubscriptionComponentReferenceConfiguration';
31-
3225
/**
3326
*
3427
* @export
3528
* @interface SubscriptionUpdateRequest
3629
*/
3730
export interface SubscriptionUpdateRequest {
3831
/**
39-
* The configurations of the subscription's components.
40-
* @type {Set<SubscriptionComponentReferenceConfiguration>}
41-
* @memberof SubscriptionUpdateRequest
42-
*/
43-
componentConfigurations?: Set<SubscriptionComponentReferenceConfiguration>;
44-
/**
45-
* The product to subscribe to.
46-
* @type {number}
47-
* @memberof SubscriptionUpdateRequest
48-
*/
49-
product?: number;
50-
/**
51-
* The three-letter code (ISO 4217 format) of the currency used to invoice the customer. Must be one of the currencies supported by the product.
32+
* A description used to identify the subscription.
5233
* @type {string}
5334
* @memberof SubscriptionUpdateRequest
5435
*/
55-
currency?: string;
56-
/**
57-
* Whether the subscriptions' termination periods should be respected.
58-
* @type {boolean}
59-
* @memberof SubscriptionUpdateRequest
60-
*/
61-
respectTerminationPeriod?: boolean;
36+
description?: string;
6237
}
6338

6439
/**
@@ -78,10 +53,7 @@ export function SubscriptionUpdateRequestFromJSONTyped(json: any, ignoreDiscrimi
7853
}
7954
return {
8055

81-
'componentConfigurations': json['componentConfigurations'] == null ? undefined : (new Set((json['componentConfigurations'] as Array<any>).map(SubscriptionComponentReferenceConfigurationFromJSON))),
82-
'product': json['product'] == null ? undefined : json['product'],
83-
'currency': json['currency'] == null ? undefined : json['currency'],
84-
'respectTerminationPeriod': json['respectTerminationPeriod'] == null ? undefined : json['respectTerminationPeriod'],
56+
'description': json['description'] == null ? undefined : json['description'],
8557
};
8658
}
8759

@@ -91,10 +63,7 @@ export function SubscriptionUpdateRequestToJSON(value?: SubscriptionUpdateReques
9163
}
9264
return {
9365

94-
'componentConfigurations': value['componentConfigurations'] == null ? undefined : (Array.from(value['componentConfigurations'] as Set<any>).map(SubscriptionComponentReferenceConfigurationToJSON)),
95-
'product': value['product'],
96-
'currency': value['currency'],
97-
'respectTerminationPeriod': value['respectTerminationPeriod'],
66+
'description': value['description'],
9867
};
9968
}
10069

src/runtime.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ export class BaseAPI {
199199

200200
private addMetaHeaders(headerParameters: HTTPHeaders) {
201201
let defaultHeaders = {
202-
'x-meta-sdk-version': '5.0.0',
202+
'x-meta-sdk-version': '5.1.0',
203203
'x-meta-sdk-language': 'typescript',
204204
'x-meta-sdk-provider': 'postfinancecheckout',
205205
'x-meta-sdk-language-version': this.getVersion(),

0 commit comments

Comments
 (0)