@shapediver/api.platform-api-dto-v1 2.12.8 → 2.12.9
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/dist/request/SdPlatformRequestChargebee.d.ts +28 -0
- package/dist/request/SdPlatformRequestChargebee.d.ts.map +1 -1
- package/dist/response/SdPlatformResponseApiClient.d.ts +30 -0
- package/dist/response/SdPlatformResponseApiClient.d.ts.map +1 -1
- package/dist/response/SdPlatformResponseHttpLog.d.ts +29 -0
- package/dist/response/SdPlatformResponseHttpLog.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1,12 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Request options for getting data which allow opening a hosted page.
|
|
3
|
+
* @see {@link https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2}
|
|
4
|
+
*/
|
|
1
5
|
export interface SdPlatformRequestChargebeeHostedPage {
|
|
6
|
+
/**
|
|
7
|
+
* Plan for which to get data for.
|
|
8
|
+
*/
|
|
2
9
|
plan_id: string;
|
|
10
|
+
/**
|
|
11
|
+
* Optional customer id, if passed in, gets data for opening a hosted page for customer which id was passed in.
|
|
12
|
+
*/
|
|
3
13
|
customer_id?: string;
|
|
4
14
|
}
|
|
15
|
+
/**
|
|
16
|
+
* Returns data required for openning a hosted update payment method page.
|
|
17
|
+
* @see {@link https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2}
|
|
18
|
+
*/
|
|
5
19
|
export interface SdPlatformRequestChargebeeHostedPageUpdatePaymentMethod {
|
|
20
|
+
/**
|
|
21
|
+
* The id of a customer.
|
|
22
|
+
*/
|
|
6
23
|
customer_id: string;
|
|
7
24
|
}
|
|
25
|
+
/**
|
|
26
|
+
* Request options for getting data which allows to open a portal session to chargebee.
|
|
27
|
+
* @see {@link https://apidocs.chargebee.com/docs/api/portal_sessions?prod_cat_ver=2}
|
|
28
|
+
*/
|
|
8
29
|
export interface SdPlatformRequestChargebeePortalSession {
|
|
30
|
+
/**
|
|
31
|
+
* The customer id.
|
|
32
|
+
*/
|
|
9
33
|
customer_id: string;
|
|
34
|
+
/**
|
|
35
|
+
* URL to redirect when the user logs out from the portal.
|
|
36
|
+
* @see {@link https://apidocs.chargebee.com/docs/api/portal_sessions?prod_cat_ver=2}
|
|
37
|
+
*/
|
|
10
38
|
redirect_url: string;
|
|
11
39
|
}
|
|
12
40
|
//# sourceMappingURL=SdPlatformRequestChargebee.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SdPlatformRequestChargebee.d.ts","sourceRoot":"","sources":["../../src/request/SdPlatformRequestChargebee.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,oCAAoC;IAEjD,OAAO,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"SdPlatformRequestChargebee.d.ts","sourceRoot":"","sources":["../../src/request/SdPlatformRequestChargebee.ts"],"names":[],"mappings":"AACA;;;GAGG;AACH,MAAM,WAAW,oCAAoC;IAEjD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,uDAAuD;IAEpE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,uCAAuC;IAEpD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;CACxB"}
|
|
@@ -1,12 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An API client for the ShapeDiver Platform Backend API.
|
|
3
|
+
*/
|
|
1
4
|
export interface SdPlatformResponseApiClient {
|
|
5
|
+
/**
|
|
6
|
+
* The client id.
|
|
7
|
+
*/
|
|
2
8
|
readonly client_id: string;
|
|
9
|
+
/**
|
|
10
|
+
* The client secret.
|
|
11
|
+
*/
|
|
3
12
|
readonly client_secret?: string;
|
|
13
|
+
/**
|
|
14
|
+
* The client name.
|
|
15
|
+
*/
|
|
4
16
|
readonly client_name?: string;
|
|
17
|
+
/**
|
|
18
|
+
* Should a refresh token be issued?
|
|
19
|
+
*/
|
|
5
20
|
readonly refresh_token: boolean;
|
|
21
|
+
/**
|
|
22
|
+
* The access token lifetime in seconds
|
|
23
|
+
*/
|
|
6
24
|
readonly access_token_lifetime?: number;
|
|
25
|
+
/**
|
|
26
|
+
* The refresh token lifetime in seconds.
|
|
27
|
+
*/
|
|
7
28
|
readonly refresh_token_lifetime?: number;
|
|
29
|
+
/**
|
|
30
|
+
* The refresh token limit (how often can refresh tokens be used?)
|
|
31
|
+
*/
|
|
8
32
|
readonly refresh_token_limit?: number;
|
|
33
|
+
/**
|
|
34
|
+
* The required feature. If this is set, the user must have this feature enabled in order to be allowed to sign in from this client. {@link SdPlatformResponseFeatures}
|
|
35
|
+
*/
|
|
9
36
|
readonly required_feature?: string;
|
|
37
|
+
/**
|
|
38
|
+
* The allowed origins.
|
|
39
|
+
*/
|
|
10
40
|
readonly allowed_origins: Array<string>;
|
|
11
41
|
}
|
|
12
42
|
//# sourceMappingURL=SdPlatformResponseApiClient.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SdPlatformResponseApiClient.d.ts","sourceRoot":"","sources":["../../src/response/SdPlatformResponseApiClient.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"SdPlatformResponseApiClient.d.ts","sourceRoot":"","sources":["../../src/response/SdPlatformResponseApiClient.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAExC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3C"}
|
|
@@ -1,15 +1,44 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* A HTTP log entry.
|
|
3
|
+
* Platform backend http request to outside world.
|
|
3
4
|
*/
|
|
4
5
|
export interface SdPlatformResponseHttpLog {
|
|
6
|
+
/**
|
|
7
|
+
* The uri to which platform backend has made request to.
|
|
8
|
+
*/
|
|
5
9
|
uri: string;
|
|
10
|
+
/**
|
|
11
|
+
* The http method.
|
|
12
|
+
*/
|
|
6
13
|
method: string;
|
|
14
|
+
/**
|
|
15
|
+
* Exception parameters if any.
|
|
16
|
+
*/
|
|
7
17
|
exception?: object;
|
|
18
|
+
/**
|
|
19
|
+
* The parameters or body of a request.
|
|
20
|
+
* If get then query parameters, otherwise body parameters.
|
|
21
|
+
*/
|
|
8
22
|
parameters?: object | Array<any>;
|
|
23
|
+
/**
|
|
24
|
+
* The response code of a request.
|
|
25
|
+
*/
|
|
9
26
|
response_code: number;
|
|
27
|
+
/**
|
|
28
|
+
* The response message.
|
|
29
|
+
*/
|
|
10
30
|
response_message?: string;
|
|
31
|
+
/**
|
|
32
|
+
* The UNIX timestamp of a request.
|
|
33
|
+
*/
|
|
11
34
|
created_at: number;
|
|
35
|
+
/**
|
|
36
|
+
* The created date in format 'YYYY-MM-DD'
|
|
37
|
+
*/
|
|
12
38
|
created_date: string;
|
|
39
|
+
/**
|
|
40
|
+
* Response result.
|
|
41
|
+
*/
|
|
13
42
|
response_result?: object;
|
|
14
43
|
}
|
|
15
44
|
//# sourceMappingURL=SdPlatformResponseHttpLog.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SdPlatformResponseHttpLog.d.ts","sourceRoot":"","sources":["../../src/response/SdPlatformResponseHttpLog.ts"],"names":[],"mappings":"AACA
|
|
1
|
+
{"version":3,"file":"SdPlatformResponseHttpLog.d.ts","sourceRoot":"","sources":["../../src/response/SdPlatformResponseHttpLog.ts"],"names":[],"mappings":"AACA;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IAEtC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;IAEjC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B"}
|