@vality/swag-payments@0.1.2

Description API is designed for the merchants who accept payments via user interface such as a website or a mobile app and it is the only interaction point with the system for goods and services payment transactions. ## Interaction details Whenever an API is accessed, its unique ID must be passed in the header X-Request-ID of the corresponding request: `` X-Request-ID: 37d735d4-0f42-4f05-89fa-eaa478fb5aa9 ` ### Content type and coding The system accepts and returns data in JSON format and UTF-8 coding: ` Content-Type: application/json; charset=utf-8 ` ### Date formats The system accepts and returns timestamp values in the format date-time, described in RFC 3339: ` 2017-01-01T00:00:00Z 2017-01-01T00:00:01+00:00 ` ### Maximum request processing time Whenever an API is accessed, the time cutoff parameters, that define maximum request processing time of the transaction completion, can be passed in the header X-Request-Deadline of the corresponding request: ` X-Request-Deadline: 10s ` The system stops processing the request upon the specified time. It is recommended to specify a value that is not more than one minute and not less than three seconds. X-Request-Deadline can be: specified in the format date-time according to RFC 3339; specified in relative values: in milliseconds (150000ms), in seconds (540s) or in minutes (3.5m).

The version of the OpenAPI document: 2.0.1

Building

To install the required dependencies and to build the typescript sources run:

`console
npm install
npm run build
`

Publishing

First build the package then run npm publish dist (don't forget to specify the dist folder!)

Consuming

Navigate to the folder of your consuming project and run one of next commands.

_published:_

`console
npm install @vality/swag-payments@0.1.2 --save
`

_without publishing (not recommended):_

`console
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
`

_It's important to take the tgz file, otherwise you'll get trouble with links on windows_

_using npm link:_

In PATH_TO_GENERATED_PACKAGE/dist:

`console
npm link
`

In your project:

`console
npm link @vality/swag-payments
`

__Note for Windows users:__ The Angular CLI has troubles to use linked npm packages.
Please refer to this issue for a solution / workaround.
Published packages are not effected by this issue.

$3

In your Angular project:

`typescript

import { ApplicationConfig } from '@angular/core';
import { provideHttpClient } from '@angular/common/http';
import { provideApi } from '@vality/swag-payments';

export const appConfig: ApplicationConfig = {
providers: [
// ...
provideHttpClient(),
provideApi()
],
};
`

NOTE
If you're still using AppModule and haven't migrated yet, you can still import an Angular module:
`typescript
import { ApiModule } from '@vality/swag-payments';
`

If different from the generated base path, during app bootstrap, you can provide the base path to your service.

`typescript
import { ApplicationConfig } from '@angular/core';
import { provideHttpClient } from '@angular/common/http';
import { provideApi } from '@vality/swag-payments';

export const appConfig: ApplicationConfig = {
providers: [
// ...
provideHttpClient(),
provideApi('http://localhost:9999')
],
};
`

`typescript
// with a custom configuration
import { ApplicationConfig } from '@angular/core';
import { provideHttpClient } from '@angular/common/http';
import { provideApi } from '@vality/swag-payments';

export const appConfig: ApplicationConfig = {
providers: [
// ...
provideHttpClient(),
provideApi({
withCredentials: true,
username: 'user',
password: 'password'
})
],
};
`

`typescript
// with factory building a custom configuration
import { ApplicationConfig } from '@angular/core';
import { provideHttpClient } from '@angular/common/http';
import { provideApi, Configuration } from '@vality/swag-payments';

export const appConfig: ApplicationConfig = {
providers: [
// ...
provideHttpClient(),
{
provide: Configuration,
useFactory: (authService: AuthService) => new Configuration({
basePath: 'http://localhost:9999',
withCredentials: true,
username: authService.getUsername(),
password: authService.getPassword(),
}),
deps: [AuthService],
multi: false
}
],
};
`

$3

In order to use multiple APIs generated from different OpenAPI files,
you can create an alias name when importing the modules
in order to avoid naming conflicts:

`typescript
import { provideApi as provideUserApi } from 'my-user-api-path';
import { provideApi as provideAdminApi } from 'my-admin-api-path';
import { HttpClientModule } from '@angular/common/http';
import { environment } from '../environments/environment';

export const appConfig: ApplicationConfig = {
providers: [
// ...
provideHttpClient(),
provideUserApi(environment.basePath),
provideAdminApi(environment.basePath),
],
};
`

$3

Without further customization, only [path-parameters][parameter-locations-url] of [style][style-values-url] 'simple'
and Dates for format 'date-time' are encoded correctly.

Other styles (e.g. "matrix") are not that easy to encode
and thus are best delegated to other libraries (e.g.: [@honoluluhenk/http-param-expander]).

To implement your own parameter encoding (or call another library),
pass an arrow-function or method-reference to the encodeParam property of the Configuration-object
(see General Usage above).

Example value for use in your Configuration-Provider:

`typescript
new Configuration({
encodeParam: (param: Param) => myFancyParamEncoder(param),
})
``

[parameter-locations-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-locations
[style-values-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values
[@honoluluhenk/http-param-expander]: https://www.npmjs.com/package/@honoluluhenk/http-param-expander