@emilgroup/payment-sdk 1.22.1-beta.32 → 1.22.1-beta.34

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.
@@ -11,6 +11,7 @@ api/credit-allocation-api.ts
11
11
  api/exceeding-credits-api.ts
12
12
  api/health-check-api.ts
13
13
  api/ibanvalidator-api.ts
14
+ api/jobs-api.ts
14
15
  api/payment-methods-api.ts
15
16
  api/payment-receipts-api.ts
16
17
  api/payment-reminders-api.ts
@@ -154,6 +155,9 @@ models/policy-payment-method-class.ts
154
155
  models/primary-bank-account-response-class.ts
155
156
  models/refund-class.ts
156
157
  models/refund-item-class.ts
158
+ models/run-job-grpc-request-dto.ts
159
+ models/run-job-request-dto.ts
160
+ models/run-job-response-class.ts
157
161
  models/sepa-direct-dto.ts
158
162
  models/set-primary-bank-account-request-dto-rest.ts
159
163
  models/shared-transaction-class.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/payment-sdk@1.22.1-beta.32 --save
20
+ npm install @emilgroup/payment-sdk@1.22.1-beta.34 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/payment-sdk@1.22.1-beta.32
24
+ yarn add @emilgroup/payment-sdk@1.22.1-beta.34
25
25
  ```
26
26
 
27
27
  And then you can import `PaymentsApi`.
@@ -0,0 +1,165 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Emil Payment Service
5
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { RunJobRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { RunJobResponseClass } from '../models';
27
+ /**
28
+ * JobsApi - axios parameter creator
29
+ * @export
30
+ */
31
+ export const JobsApiAxiosParamCreator = function (configuration?: Configuration) {
32
+ return {
33
+ /**
34
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
35
+ * @summary Create the job run
36
+ * @param {RunJobRequestDto} runJobRequestDto
37
+ * @param {string} [authorization] Bearer Token
38
+ * @param {*} [options] Override http request option.
39
+ * @throws {RequiredError}
40
+ */
41
+ runJob: async (runJobRequestDto: RunJobRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
42
+ // verify required parameter 'runJobRequestDto' is not null or undefined
43
+ assertParamExists('runJob', 'runJobRequestDto', runJobRequestDto)
44
+ const localVarPath = `/paymentservice/v1/jobs/run`;
45
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
46
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
47
+ let baseOptions;
48
+ let baseAccessToken;
49
+ if (configuration) {
50
+ baseOptions = configuration.baseOptions;
51
+ baseAccessToken = configuration.accessToken;
52
+ }
53
+
54
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
55
+ const localVarHeaderParameter = {} as any;
56
+ const localVarQueryParameter = {} as any;
57
+
58
+ // authentication bearer required
59
+ // http bearer authentication required
60
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
61
+
62
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
63
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
64
+ }
65
+
66
+
67
+
68
+ localVarHeaderParameter['Content-Type'] = 'application/json';
69
+
70
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
71
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
72
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
73
+ localVarRequestOptions.data = serializeDataIfNeeded(runJobRequestDto, localVarRequestOptions, configuration)
74
+
75
+ return {
76
+ url: toPathString(localVarUrlObj),
77
+ options: localVarRequestOptions,
78
+ };
79
+ },
80
+ }
81
+ };
82
+
83
+ /**
84
+ * JobsApi - functional programming interface
85
+ * @export
86
+ */
87
+ export const JobsApiFp = function(configuration?: Configuration) {
88
+ const localVarAxiosParamCreator = JobsApiAxiosParamCreator(configuration)
89
+ return {
90
+ /**
91
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
92
+ * @summary Create the job run
93
+ * @param {RunJobRequestDto} runJobRequestDto
94
+ * @param {string} [authorization] Bearer Token
95
+ * @param {*} [options] Override http request option.
96
+ * @throws {RequiredError}
97
+ */
98
+ async runJob(runJobRequestDto: RunJobRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunJobResponseClass>> {
99
+ const localVarAxiosArgs = await localVarAxiosParamCreator.runJob(runJobRequestDto, authorization, options);
100
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
101
+ },
102
+ }
103
+ };
104
+
105
+ /**
106
+ * JobsApi - factory interface
107
+ * @export
108
+ */
109
+ export const JobsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
110
+ const localVarFp = JobsApiFp(configuration)
111
+ return {
112
+ /**
113
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
114
+ * @summary Create the job run
115
+ * @param {RunJobRequestDto} runJobRequestDto
116
+ * @param {string} [authorization] Bearer Token
117
+ * @param {*} [options] Override http request option.
118
+ * @throws {RequiredError}
119
+ */
120
+ runJob(runJobRequestDto: RunJobRequestDto, authorization?: string, options?: any): AxiosPromise<RunJobResponseClass> {
121
+ return localVarFp.runJob(runJobRequestDto, authorization, options).then((request) => request(axios, basePath));
122
+ },
123
+ };
124
+ };
125
+
126
+ /**
127
+ * Request parameters for runJob operation in JobsApi.
128
+ * @export
129
+ * @interface JobsApiRunJobRequest
130
+ */
131
+ export interface JobsApiRunJobRequest {
132
+ /**
133
+ *
134
+ * @type {RunJobRequestDto}
135
+ * @memberof JobsApiRunJob
136
+ */
137
+ readonly runJobRequestDto: RunJobRequestDto
138
+
139
+ /**
140
+ * Bearer Token
141
+ * @type {string}
142
+ * @memberof JobsApiRunJob
143
+ */
144
+ readonly authorization?: string
145
+ }
146
+
147
+ /**
148
+ * JobsApi - object-oriented interface
149
+ * @export
150
+ * @class JobsApi
151
+ * @extends {BaseAPI}
152
+ */
153
+ export class JobsApi extends BaseAPI {
154
+ /**
155
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
156
+ * @summary Create the job run
157
+ * @param {JobsApiRunJobRequest} requestParameters Request parameters.
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ * @memberof JobsApi
161
+ */
162
+ public runJob(requestParameters: JobsApiRunJobRequest, options?: AxiosRequestConfig) {
163
+ return JobsApiFp(this.configuration).runJob(requestParameters.runJobRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
164
+ }
165
+ }
package/api.ts CHANGED
@@ -28,6 +28,7 @@ import { CreditAllocationApi } from './api';
28
28
  import { ExceedingCreditsApi } from './api';
29
29
  import { HealthCheckApi } from './api';
30
30
  import { IBANValidatorApi } from './api';
31
+ import { JobsApi } from './api';
31
32
  import { PaymentMethodsApi } from './api';
32
33
  import { PaymentReceiptsApi } from './api';
33
34
  import { PaymentRemindersApi } from './api';
@@ -49,6 +50,7 @@ export * from './api/credit-allocation-api';
49
50
  export * from './api/exceeding-credits-api';
50
51
  export * from './api/health-check-api';
51
52
  export * from './api/ibanvalidator-api';
53
+ export * from './api/jobs-api';
52
54
  export * from './api/payment-methods-api';
53
55
  export * from './api/payment-receipts-api';
54
56
  export * from './api/payment-reminders-api';
@@ -0,0 +1,97 @@
1
+ /**
2
+ * Emil Payment Service
3
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { RunJobRequestDto } from '../models';
16
+ import { RunJobResponseClass } from '../models';
17
+ /**
18
+ * JobsApi - axios parameter creator
19
+ * @export
20
+ */
21
+ export declare const JobsApiAxiosParamCreator: (configuration?: Configuration) => {
22
+ /**
23
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
24
+ * @summary Create the job run
25
+ * @param {RunJobRequestDto} runJobRequestDto
26
+ * @param {string} [authorization] Bearer Token
27
+ * @param {*} [options] Override http request option.
28
+ * @throws {RequiredError}
29
+ */
30
+ runJob: (runJobRequestDto: RunJobRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
+ };
32
+ /**
33
+ * JobsApi - functional programming interface
34
+ * @export
35
+ */
36
+ export declare const JobsApiFp: (configuration?: Configuration) => {
37
+ /**
38
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
39
+ * @summary Create the job run
40
+ * @param {RunJobRequestDto} runJobRequestDto
41
+ * @param {string} [authorization] Bearer Token
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ runJob(runJobRequestDto: RunJobRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunJobResponseClass>>;
46
+ };
47
+ /**
48
+ * JobsApi - factory interface
49
+ * @export
50
+ */
51
+ export declare const JobsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
52
+ /**
53
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
54
+ * @summary Create the job run
55
+ * @param {RunJobRequestDto} runJobRequestDto
56
+ * @param {string} [authorization] Bearer Token
57
+ * @param {*} [options] Override http request option.
58
+ * @throws {RequiredError}
59
+ */
60
+ runJob(runJobRequestDto: RunJobRequestDto, authorization?: string, options?: any): AxiosPromise<RunJobResponseClass>;
61
+ };
62
+ /**
63
+ * Request parameters for runJob operation in JobsApi.
64
+ * @export
65
+ * @interface JobsApiRunJobRequest
66
+ */
67
+ export interface JobsApiRunJobRequest {
68
+ /**
69
+ *
70
+ * @type {RunJobRequestDto}
71
+ * @memberof JobsApiRunJob
72
+ */
73
+ readonly runJobRequestDto: RunJobRequestDto;
74
+ /**
75
+ * Bearer Token
76
+ * @type {string}
77
+ * @memberof JobsApiRunJob
78
+ */
79
+ readonly authorization?: string;
80
+ }
81
+ /**
82
+ * JobsApi - object-oriented interface
83
+ * @export
84
+ * @class JobsApi
85
+ * @extends {BaseAPI}
86
+ */
87
+ export declare class JobsApi extends BaseAPI {
88
+ /**
89
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
90
+ * @summary Create the job run
91
+ * @param {JobsApiRunJobRequest} requestParameters Request parameters.
92
+ * @param {*} [options] Override http request option.
93
+ * @throws {RequiredError}
94
+ * @memberof JobsApi
95
+ */
96
+ runJob(requestParameters: JobsApiRunJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RunJobResponseClass, any, {}>>;
97
+ }
@@ -0,0 +1,224 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Emil Payment Service
6
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __extends = (this && this.__extends) || (function () {
16
+ var extendStatics = function (d, b) {
17
+ extendStatics = Object.setPrototypeOf ||
18
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
19
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
20
+ return extendStatics(d, b);
21
+ };
22
+ return function (d, b) {
23
+ if (typeof b !== "function" && b !== null)
24
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
25
+ extendStatics(d, b);
26
+ function __() { this.constructor = d; }
27
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
+ };
29
+ })();
30
+ var __assign = (this && this.__assign) || function () {
31
+ __assign = Object.assign || function(t) {
32
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
33
+ s = arguments[i];
34
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
35
+ t[p] = s[p];
36
+ }
37
+ return t;
38
+ };
39
+ return __assign.apply(this, arguments);
40
+ };
41
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
42
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
43
+ return new (P || (P = Promise))(function (resolve, reject) {
44
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
45
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
46
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
47
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
48
+ });
49
+ };
50
+ var __generator = (this && this.__generator) || function (thisArg, body) {
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
52
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
+ function verb(n) { return function (v) { return step([n, v]); }; }
54
+ function step(op) {
55
+ if (f) throw new TypeError("Generator is already executing.");
56
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
57
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
58
+ if (y = 0, t) op = [op[0] & 2, t.value];
59
+ switch (op[0]) {
60
+ case 0: case 1: t = op; break;
61
+ case 4: _.label++; return { value: op[1], done: false };
62
+ case 5: _.label++; y = op[1]; op = [0]; continue;
63
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
64
+ default:
65
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
66
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
67
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
68
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
69
+ if (t[2]) _.ops.pop();
70
+ _.trys.pop(); continue;
71
+ }
72
+ op = body.call(thisArg, _);
73
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
74
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
+ }
76
+ };
77
+ var __importDefault = (this && this.__importDefault) || function (mod) {
78
+ return (mod && mod.__esModule) ? mod : { "default": mod };
79
+ };
80
+ Object.defineProperty(exports, "__esModule", { value: true });
81
+ exports.JobsApi = exports.JobsApiFactory = exports.JobsApiFp = exports.JobsApiAxiosParamCreator = void 0;
82
+ var axios_1 = __importDefault(require("axios"));
83
+ // Some imports not used depending on template conditions
84
+ // @ts-ignore
85
+ var common_1 = require("../common");
86
+ // @ts-ignore
87
+ var base_1 = require("../base");
88
+ /**
89
+ * JobsApi - axios parameter creator
90
+ * @export
91
+ */
92
+ var JobsApiAxiosParamCreator = function (configuration) {
93
+ var _this = this;
94
+ return {
95
+ /**
96
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
97
+ * @summary Create the job run
98
+ * @param {RunJobRequestDto} runJobRequestDto
99
+ * @param {string} [authorization] Bearer Token
100
+ * @param {*} [options] Override http request option.
101
+ * @throws {RequiredError}
102
+ */
103
+ runJob: function (runJobRequestDto, authorization, options) {
104
+ if (options === void 0) { options = {}; }
105
+ return __awaiter(_this, void 0, void 0, function () {
106
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
107
+ return __generator(this, function (_a) {
108
+ switch (_a.label) {
109
+ case 0:
110
+ // verify required parameter 'runJobRequestDto' is not null or undefined
111
+ (0, common_1.assertParamExists)('runJob', 'runJobRequestDto', runJobRequestDto);
112
+ localVarPath = "/paymentservice/v1/jobs/run";
113
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
114
+ if (configuration) {
115
+ baseOptions = configuration.baseOptions;
116
+ baseAccessToken = configuration.accessToken;
117
+ }
118
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
119
+ localVarHeaderParameter = {};
120
+ localVarQueryParameter = {};
121
+ // authentication bearer required
122
+ // http bearer authentication required
123
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
124
+ case 1:
125
+ // authentication bearer required
126
+ // http bearer authentication required
127
+ _a.sent();
128
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
129
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
130
+ }
131
+ localVarHeaderParameter['Content-Type'] = 'application/json';
132
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
133
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
134
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
135
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(runJobRequestDto, localVarRequestOptions, configuration);
136
+ return [2 /*return*/, {
137
+ url: (0, common_1.toPathString)(localVarUrlObj),
138
+ options: localVarRequestOptions,
139
+ }];
140
+ }
141
+ });
142
+ });
143
+ },
144
+ };
145
+ };
146
+ exports.JobsApiAxiosParamCreator = JobsApiAxiosParamCreator;
147
+ /**
148
+ * JobsApi - functional programming interface
149
+ * @export
150
+ */
151
+ var JobsApiFp = function (configuration) {
152
+ var localVarAxiosParamCreator = (0, exports.JobsApiAxiosParamCreator)(configuration);
153
+ return {
154
+ /**
155
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
156
+ * @summary Create the job run
157
+ * @param {RunJobRequestDto} runJobRequestDto
158
+ * @param {string} [authorization] Bearer Token
159
+ * @param {*} [options] Override http request option.
160
+ * @throws {RequiredError}
161
+ */
162
+ runJob: function (runJobRequestDto, authorization, options) {
163
+ return __awaiter(this, void 0, void 0, function () {
164
+ var localVarAxiosArgs;
165
+ return __generator(this, function (_a) {
166
+ switch (_a.label) {
167
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.runJob(runJobRequestDto, authorization, options)];
168
+ case 1:
169
+ localVarAxiosArgs = _a.sent();
170
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
171
+ }
172
+ });
173
+ });
174
+ },
175
+ };
176
+ };
177
+ exports.JobsApiFp = JobsApiFp;
178
+ /**
179
+ * JobsApi - factory interface
180
+ * @export
181
+ */
182
+ var JobsApiFactory = function (configuration, basePath, axios) {
183
+ var localVarFp = (0, exports.JobsApiFp)(configuration);
184
+ return {
185
+ /**
186
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
187
+ * @summary Create the job run
188
+ * @param {RunJobRequestDto} runJobRequestDto
189
+ * @param {string} [authorization] Bearer Token
190
+ * @param {*} [options] Override http request option.
191
+ * @throws {RequiredError}
192
+ */
193
+ runJob: function (runJobRequestDto, authorization, options) {
194
+ return localVarFp.runJob(runJobRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
195
+ },
196
+ };
197
+ };
198
+ exports.JobsApiFactory = JobsApiFactory;
199
+ /**
200
+ * JobsApi - object-oriented interface
201
+ * @export
202
+ * @class JobsApi
203
+ * @extends {BaseAPI}
204
+ */
205
+ var JobsApi = /** @class */ (function (_super) {
206
+ __extends(JobsApi, _super);
207
+ function JobsApi() {
208
+ return _super !== null && _super.apply(this, arguments) || this;
209
+ }
210
+ /**
211
+ * Starts one of the payment jobs for the current tenant immediately, instead of waiting for its schedule. The job runs in the background; the call returns as soon as the run is accepted. **Required Permissions** \"payment-management.bank-orders.run\"
212
+ * @summary Create the job run
213
+ * @param {JobsApiRunJobRequest} requestParameters Request parameters.
214
+ * @param {*} [options] Override http request option.
215
+ * @throws {RequiredError}
216
+ * @memberof JobsApi
217
+ */
218
+ JobsApi.prototype.runJob = function (requestParameters, options) {
219
+ var _this = this;
220
+ return (0, exports.JobsApiFp)(this.configuration).runJob(requestParameters.runJobRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
221
+ };
222
+ return JobsApi;
223
+ }(base_1.BaseAPI));
224
+ exports.JobsApi = JobsApi;
package/dist/api.d.ts CHANGED
@@ -17,6 +17,7 @@ export * from './api/credit-allocation-api';
17
17
  export * from './api/exceeding-credits-api';
18
18
  export * from './api/health-check-api';
19
19
  export * from './api/ibanvalidator-api';
20
+ export * from './api/jobs-api';
20
21
  export * from './api/payment-methods-api';
21
22
  export * from './api/payment-receipts-api';
22
23
  export * from './api/payment-reminders-api';
package/dist/api.js CHANGED
@@ -35,6 +35,7 @@ __exportStar(require("./api/credit-allocation-api"), exports);
35
35
  __exportStar(require("./api/exceeding-credits-api"), exports);
36
36
  __exportStar(require("./api/health-check-api"), exports);
37
37
  __exportStar(require("./api/ibanvalidator-api"), exports);
38
+ __exportStar(require("./api/jobs-api"), exports);
38
39
  __exportStar(require("./api/payment-methods-api"), exports);
39
40
  __exportStar(require("./api/payment-receipts-api"), exports);
40
41
  __exportStar(require("./api/payment-reminders-api"), exports);
@@ -124,6 +124,9 @@ export * from './policy-payment-method-class';
124
124
  export * from './primary-bank-account-response-class';
125
125
  export * from './refund-class';
126
126
  export * from './refund-item-class';
127
+ export * from './run-job-grpc-request-dto';
128
+ export * from './run-job-request-dto';
129
+ export * from './run-job-response-class';
127
130
  export * from './sepa-direct-dto';
128
131
  export * from './set-primary-bank-account-request-dto-rest';
129
132
  export * from './shared-transaction-class';
@@ -140,6 +140,9 @@ __exportStar(require("./policy-payment-method-class"), exports);
140
140
  __exportStar(require("./primary-bank-account-response-class"), exports);
141
141
  __exportStar(require("./refund-class"), exports);
142
142
  __exportStar(require("./refund-item-class"), exports);
143
+ __exportStar(require("./run-job-grpc-request-dto"), exports);
144
+ __exportStar(require("./run-job-request-dto"), exports);
145
+ __exportStar(require("./run-job-response-class"), exports);
143
146
  __exportStar(require("./sepa-direct-dto"), exports);
144
147
  __exportStar(require("./set-primary-bank-account-request-dto-rest"), exports);
145
148
  __exportStar(require("./shared-transaction-class"), exports);
@@ -0,0 +1,63 @@
1
+ /**
2
+ * Emil Payment Service
3
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface RunJobGrpcRequestDto
16
+ */
17
+ export interface RunJobGrpcRequestDto {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof RunJobGrpcRequestDto
22
+ */
23
+ 'jobName': RunJobGrpcRequestDtoJobNameEnum;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof RunJobGrpcRequestDto
28
+ */
29
+ 'tenantBankAccountCode': string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof RunJobGrpcRequestDto
34
+ */
35
+ 'executionDate'?: string;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof RunJobGrpcRequestDto
40
+ */
41
+ 'leadDays'?: number;
42
+ /**
43
+ *
44
+ * @type {string}
45
+ * @memberof RunJobGrpcRequestDto
46
+ */
47
+ 'dateField'?: RunJobGrpcRequestDtoDateFieldEnum;
48
+ /**
49
+ *
50
+ * @type {boolean}
51
+ * @memberof RunJobGrpcRequestDto
52
+ */
53
+ 'dryRun'?: boolean;
54
+ }
55
+ export declare const RunJobGrpcRequestDtoJobNameEnum: {
56
+ readonly BankOrders: "bank-orders";
57
+ };
58
+ export type RunJobGrpcRequestDtoJobNameEnum = typeof RunJobGrpcRequestDtoJobNameEnum[keyof typeof RunJobGrpcRequestDtoJobNameEnum];
59
+ export declare const RunJobGrpcRequestDtoDateFieldEnum: {
60
+ readonly DueDate: "dueDate";
61
+ readonly CreatedAt: "createdAt";
62
+ };
63
+ export type RunJobGrpcRequestDtoDateFieldEnum = typeof RunJobGrpcRequestDtoDateFieldEnum[keyof typeof RunJobGrpcRequestDtoDateFieldEnum];
@@ -0,0 +1,23 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Emil Payment Service
6
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.RunJobGrpcRequestDtoDateFieldEnum = exports.RunJobGrpcRequestDtoJobNameEnum = void 0;
17
+ exports.RunJobGrpcRequestDtoJobNameEnum = {
18
+ BankOrders: 'bank-orders'
19
+ };
20
+ exports.RunJobGrpcRequestDtoDateFieldEnum = {
21
+ DueDate: 'dueDate',
22
+ CreatedAt: 'createdAt'
23
+ };
@@ -0,0 +1,63 @@
1
+ /**
2
+ * Emil Payment Service
3
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface RunJobRequestDto
16
+ */
17
+ export interface RunJobRequestDto {
18
+ /**
19
+ * Job to run.
20
+ * @type {string}
21
+ * @memberof RunJobRequestDto
22
+ */
23
+ 'jobName': RunJobRequestDtoJobNameEnum;
24
+ /**
25
+ * Tenant bank account the bank orders are created for.
26
+ * @type {string}
27
+ * @memberof RunJobRequestDto
28
+ */
29
+ 'tenantBankAccountCode': string;
30
+ /**
31
+ * Date the run acts as if it were running on (YYYY-MM-DD). Defaults to today.
32
+ * @type {string}
33
+ * @memberof RunJobRequestDto
34
+ */
35
+ 'executionDate'?: string;
36
+ /**
37
+ * Also collect invoices due up to this many days after executionDate. Defaults to 0.
38
+ * @type {number}
39
+ * @memberof RunJobRequestDto
40
+ */
41
+ 'leadDays'?: number;
42
+ /**
43
+ * Invoice date the selection window applies to. Defaults to dueDate.
44
+ * @type {string}
45
+ * @memberof RunJobRequestDto
46
+ */
47
+ 'dateField'?: RunJobRequestDtoDateFieldEnum;
48
+ /**
49
+ * Log what would be created without creating bank orders.
50
+ * @type {boolean}
51
+ * @memberof RunJobRequestDto
52
+ */
53
+ 'dryRun'?: boolean;
54
+ }
55
+ export declare const RunJobRequestDtoJobNameEnum: {
56
+ readonly BankOrders: "bank-orders";
57
+ };
58
+ export type RunJobRequestDtoJobNameEnum = typeof RunJobRequestDtoJobNameEnum[keyof typeof RunJobRequestDtoJobNameEnum];
59
+ export declare const RunJobRequestDtoDateFieldEnum: {
60
+ readonly DueDate: "dueDate";
61
+ readonly CreatedAt: "createdAt";
62
+ };
63
+ export type RunJobRequestDtoDateFieldEnum = typeof RunJobRequestDtoDateFieldEnum[keyof typeof RunJobRequestDtoDateFieldEnum];
@@ -0,0 +1,23 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Emil Payment Service
6
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.RunJobRequestDtoDateFieldEnum = exports.RunJobRequestDtoJobNameEnum = void 0;
17
+ exports.RunJobRequestDtoJobNameEnum = {
18
+ BankOrders: 'bank-orders'
19
+ };
20
+ exports.RunJobRequestDtoDateFieldEnum = {
21
+ DueDate: 'dueDate',
22
+ CreatedAt: 'createdAt'
23
+ };
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Emil Payment Service
3
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface RunJobResponseClass
16
+ */
17
+ export interface RunJobResponseClass {
18
+ /**
19
+ * The job run was accepted and is executing in the background.
20
+ * @type {boolean}
21
+ * @memberof RunJobResponseClass
22
+ */
23
+ 'success': boolean;
24
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Emil Payment Service
6
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
package/models/index.ts CHANGED
@@ -124,6 +124,9 @@ export * from './policy-payment-method-class';
124
124
  export * from './primary-bank-account-response-class';
125
125
  export * from './refund-class';
126
126
  export * from './refund-item-class';
127
+ export * from './run-job-grpc-request-dto';
128
+ export * from './run-job-request-dto';
129
+ export * from './run-job-response-class';
127
130
  export * from './sepa-direct-dto';
128
131
  export * from './set-primary-bank-account-request-dto-rest';
129
132
  export * from './shared-transaction-class';
@@ -0,0 +1,73 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Emil Payment Service
5
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface RunJobGrpcRequestDto
21
+ */
22
+ export interface RunJobGrpcRequestDto {
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof RunJobGrpcRequestDto
27
+ */
28
+ 'jobName': RunJobGrpcRequestDtoJobNameEnum;
29
+ /**
30
+ *
31
+ * @type {string}
32
+ * @memberof RunJobGrpcRequestDto
33
+ */
34
+ 'tenantBankAccountCode': string;
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof RunJobGrpcRequestDto
39
+ */
40
+ 'executionDate'?: string;
41
+ /**
42
+ *
43
+ * @type {number}
44
+ * @memberof RunJobGrpcRequestDto
45
+ */
46
+ 'leadDays'?: number;
47
+ /**
48
+ *
49
+ * @type {string}
50
+ * @memberof RunJobGrpcRequestDto
51
+ */
52
+ 'dateField'?: RunJobGrpcRequestDtoDateFieldEnum;
53
+ /**
54
+ *
55
+ * @type {boolean}
56
+ * @memberof RunJobGrpcRequestDto
57
+ */
58
+ 'dryRun'?: boolean;
59
+ }
60
+
61
+ export const RunJobGrpcRequestDtoJobNameEnum = {
62
+ BankOrders: 'bank-orders'
63
+ } as const;
64
+
65
+ export type RunJobGrpcRequestDtoJobNameEnum = typeof RunJobGrpcRequestDtoJobNameEnum[keyof typeof RunJobGrpcRequestDtoJobNameEnum];
66
+ export const RunJobGrpcRequestDtoDateFieldEnum = {
67
+ DueDate: 'dueDate',
68
+ CreatedAt: 'createdAt'
69
+ } as const;
70
+
71
+ export type RunJobGrpcRequestDtoDateFieldEnum = typeof RunJobGrpcRequestDtoDateFieldEnum[keyof typeof RunJobGrpcRequestDtoDateFieldEnum];
72
+
73
+
@@ -0,0 +1,73 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Emil Payment Service
5
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface RunJobRequestDto
21
+ */
22
+ export interface RunJobRequestDto {
23
+ /**
24
+ * Job to run.
25
+ * @type {string}
26
+ * @memberof RunJobRequestDto
27
+ */
28
+ 'jobName': RunJobRequestDtoJobNameEnum;
29
+ /**
30
+ * Tenant bank account the bank orders are created for.
31
+ * @type {string}
32
+ * @memberof RunJobRequestDto
33
+ */
34
+ 'tenantBankAccountCode': string;
35
+ /**
36
+ * Date the run acts as if it were running on (YYYY-MM-DD). Defaults to today.
37
+ * @type {string}
38
+ * @memberof RunJobRequestDto
39
+ */
40
+ 'executionDate'?: string;
41
+ /**
42
+ * Also collect invoices due up to this many days after executionDate. Defaults to 0.
43
+ * @type {number}
44
+ * @memberof RunJobRequestDto
45
+ */
46
+ 'leadDays'?: number;
47
+ /**
48
+ * Invoice date the selection window applies to. Defaults to dueDate.
49
+ * @type {string}
50
+ * @memberof RunJobRequestDto
51
+ */
52
+ 'dateField'?: RunJobRequestDtoDateFieldEnum;
53
+ /**
54
+ * Log what would be created without creating bank orders.
55
+ * @type {boolean}
56
+ * @memberof RunJobRequestDto
57
+ */
58
+ 'dryRun'?: boolean;
59
+ }
60
+
61
+ export const RunJobRequestDtoJobNameEnum = {
62
+ BankOrders: 'bank-orders'
63
+ } as const;
64
+
65
+ export type RunJobRequestDtoJobNameEnum = typeof RunJobRequestDtoJobNameEnum[keyof typeof RunJobRequestDtoJobNameEnum];
66
+ export const RunJobRequestDtoDateFieldEnum = {
67
+ DueDate: 'dueDate',
68
+ CreatedAt: 'createdAt'
69
+ } as const;
70
+
71
+ export type RunJobRequestDtoDateFieldEnum = typeof RunJobRequestDtoDateFieldEnum[keyof typeof RunJobRequestDtoDateFieldEnum];
72
+
73
+
@@ -0,0 +1,30 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Emil Payment Service
5
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface RunJobResponseClass
21
+ */
22
+ export interface RunJobResponseClass {
23
+ /**
24
+ * The job run was accepted and is executing in the background.
25
+ * @type {boolean}
26
+ * @memberof RunJobResponseClass
27
+ */
28
+ 'success': boolean;
29
+ }
30
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/payment-sdk",
3
- "version": "1.22.1-beta.32",
3
+ "version": "1.22.1-beta.34",
4
4
  "description": "OpenAPI client for @emilgroup/payment-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [