@shapediver/sdk.platform-api-sdk-v1 2.14.1 → 2.14.4
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/LICENSE +7 -7
- package/README.md +61 -61
- package/dist/SdPlatformErrors.d.ts +134 -134
- package/dist/SdPlatformSdk.d.ts +197 -191
- package/dist/SdPlatformSdk.d.ts.map +1 -1
- package/dist/SdPlatformSdkContext.d.ts +71 -71
- package/dist/SdPlatformSdkCreate.d.ts +7 -7
- package/dist/api/SdPlatformRequestId.d.ts +139 -138
- package/dist/api/SdPlatformRequestId.d.ts.map +1 -1
- package/dist/api/SdPlatformSdkApi.d.ts +66 -66
- package/dist/api/SdPlatformSdkConfig.d.ts +18 -18
- package/dist/api/SdPlatformSdkErrorMapping.d.ts +6 -6
- package/dist/auth/SdPlatformAuthServiceApi.d.ts +79 -79
- package/dist/bundle.js +3978 -3931
- package/dist/bundle.node.js +4103 -4033
- package/dist/index.d.ts +28 -27
- package/dist/index.d.ts.map +1 -1
- package/dist/resources/SdPlatformApiClientsApi.d.ts +43 -43
- package/dist/resources/SdPlatformApiClientsApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformApiTokenApi.d.ts +43 -43
- package/dist/resources/SdPlatformApiTokenApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformBackendSystemApi.d.ts +43 -43
- package/dist/resources/SdPlatformBackendSystemApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformBookmarkApi.d.ts +24 -24
- package/dist/resources/SdPlatformChargebeeApi.d.ts +43 -43
- package/dist/resources/SdPlatformChargebeeApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformDocumentApi.d.ts +83 -83
- package/dist/resources/SdPlatformDocumentApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformDomainApi.d.ts +46 -46
- package/dist/resources/SdPlatformDomainApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformHttpLogApi.d.ts +16 -16
- package/dist/resources/SdPlatformHttpLogApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformImageApi.d.ts +44 -44
- package/dist/resources/SdPlatformImageApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformJobLogApi.d.ts +16 -16
- package/dist/resources/SdPlatformJobLogApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformModelApi.d.ts +78 -78
- package/dist/resources/SdPlatformModelApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformModelSharingApi.d.ts +65 -65
- package/dist/resources/SdPlatformModelSharingApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformModelTokenApi.d.ts +15 -15
- package/dist/resources/SdPlatformModelTransferApi.d.ts +47 -47
- package/dist/resources/SdPlatformNotificationApi.d.ts +65 -65
- package/dist/resources/SdPlatformNotificationApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformOpenIDProviderApi.d.ts +41 -41
- package/dist/resources/SdPlatformOpenIDProviderApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformOrganizationAnalyticsApi.d.ts +15 -15
- package/dist/resources/SdPlatformOrganizationApi.d.ts +95 -95
- package/dist/resources/SdPlatformOrganizationApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformPolicyApi.d.ts +43 -43
- package/dist/resources/SdPlatformPolicyApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformSavedStateApi.d.ts +51 -51
- package/dist/resources/SdPlatformSavedStateApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformSavedStateSharingApi.d.ts +66 -66
- package/dist/resources/SdPlatformSavedStateSharingApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformStargateApi.d.ts +13 -0
- package/dist/resources/SdPlatformStargateApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformTagApi.d.ts +25 -25
- package/dist/resources/SdPlatformTagApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformUserAnalyticsApi.d.ts +15 -15
- package/dist/resources/SdPlatformUserApi.d.ts +86 -86
- package/dist/resources/SdPlatformUserApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformWebhookApi.d.ts +52 -52
- package/dist/resources/commons/FilterBuilder.d.ts +54 -54
- package/dist/resources/commons/ResourcesApi.d.ts +42 -42
- package/package.json +14 -12
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
-
import { SdPlatformResponseTag, SdPlatformResponseTagAdmin } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
-
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
export declare enum SdPlatformTagQueryEmbeddableFields {
|
|
5
|
-
ModelsCount = "models_count"
|
|
6
|
-
}
|
|
7
|
-
export
|
|
8
|
-
/**
|
|
9
|
-
* Operations for tags which can be attached to models.
|
|
10
|
-
*/
|
|
11
|
-
export declare class SdPlatformTagApi extends ResourcesApi {
|
|
12
|
-
protected get __resourcePath(): string;
|
|
13
|
-
/**
|
|
14
|
-
* Gets the {@link SdPlatformResponseTag} by id.
|
|
15
|
-
* @param id - the id of a tag.
|
|
16
|
-
* @returns the {@link SdPlatformGetResponse} with {@link SdPlatformResponseTag} or {@link SdPlatformResponseTagAdmin} as data.
|
|
17
|
-
*/
|
|
18
|
-
get(id: string): Promise<SdPlatformGetResponse<SdPlatformResponseTag | SdPlatformResponseTagAdmin>>;
|
|
19
|
-
/**
|
|
20
|
-
* Queries the {@link SdPlatformResponseTag} tags.
|
|
21
|
-
* @param query {@link SdPlatformTagQueryParameters} - query parameters for tags.
|
|
22
|
-
* @returns collection of {@link SdPlatformResponseTag} based on query parameters.
|
|
23
|
-
*/
|
|
24
|
-
query(query?: SdPlatformTagQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseTag | SdPlatformResponseTagAdmin>>;
|
|
25
|
-
}
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformResponseTag, SdPlatformResponseTagAdmin } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
+
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
export declare enum SdPlatformTagQueryEmbeddableFields {
|
|
5
|
+
ModelsCount = "models_count"
|
|
6
|
+
}
|
|
7
|
+
export type SdPlatformTagQueryParameters = SdPlatformQueryParameters<SdPlatformTagQueryEmbeddableFields>;
|
|
8
|
+
/**
|
|
9
|
+
* Operations for tags which can be attached to models.
|
|
10
|
+
*/
|
|
11
|
+
export declare class SdPlatformTagApi extends ResourcesApi {
|
|
12
|
+
protected get __resourcePath(): string;
|
|
13
|
+
/**
|
|
14
|
+
* Gets the {@link SdPlatformResponseTag} by id.
|
|
15
|
+
* @param id - the id of a tag.
|
|
16
|
+
* @returns the {@link SdPlatformGetResponse} with {@link SdPlatformResponseTag} or {@link SdPlatformResponseTagAdmin} as data.
|
|
17
|
+
*/
|
|
18
|
+
get(id: string): Promise<SdPlatformGetResponse<SdPlatformResponseTag | SdPlatformResponseTagAdmin>>;
|
|
19
|
+
/**
|
|
20
|
+
* Queries the {@link SdPlatformResponseTag} tags.
|
|
21
|
+
* @param query {@link SdPlatformTagQueryParameters} - query parameters for tags.
|
|
22
|
+
* @returns collection of {@link SdPlatformResponseTag} based on query parameters.
|
|
23
|
+
*/
|
|
24
|
+
query(query?: SdPlatformTagQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseTag | SdPlatformResponseTagAdmin>>;
|
|
25
|
+
}
|
|
26
26
|
//# sourceMappingURL=SdPlatformTagApi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SdPlatformTagApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformTagApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAA;AACvG,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAE/H,oBAAY,kCAAkC;IAE1C,WAAW,iBAAiB;CAC/B;AAED,
|
|
1
|
+
{"version":3,"file":"SdPlatformTagApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformTagApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAA;AACvG,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAE/H,oBAAY,kCAAkC;IAE1C,WAAW,iBAAiB;CAC/B;AAED,MAAM,MAAM,4BAA4B,GAAG,yBAAyB,CAAC,kCAAkC,CAAC,CAAC;AAEzG;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAE9C,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,qBAAqB,GAAG,0BAA0B,CAAC,CAAC;IAK1G;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,4BAAiC,GAAG,OAAO,CAAC,uBAAuB,CAAC,qBAAqB,GAAG,0BAA0B,CAAC,CAAC;CAI/I"}
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
import { SdPlatformResponseUserModelSessionAnalyticsPerTimestamp } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
3
|
-
import { SdPlatformQueryParameters, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
/**
|
|
5
|
-
* Analytics for users.
|
|
6
|
-
*/
|
|
7
|
-
export declare class SdPlatformUserAnalyticsApi extends ResourcesApi {
|
|
8
|
-
protected get __resourcePath(): string;
|
|
9
|
-
/**
|
|
10
|
-
* Query session analytics aggregated per user.
|
|
11
|
-
* @param body the query parameters.
|
|
12
|
-
* @returns collection of {@link SdPlatformResponseUserModelSessionAnalyticsPerTimestamp} based on query parameters.
|
|
13
|
-
*/
|
|
14
|
-
query(body?: SdPlatformQueryParameters<unknown>): Promise<SdPlatformQueryResponse<SdPlatformResponseUserModelSessionAnalyticsPerTimestamp>>;
|
|
15
|
-
}
|
|
1
|
+
import { SdPlatformResponseUserModelSessionAnalyticsPerTimestamp } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
3
|
+
import { SdPlatformQueryParameters, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
/**
|
|
5
|
+
* Analytics for users.
|
|
6
|
+
*/
|
|
7
|
+
export declare class SdPlatformUserAnalyticsApi extends ResourcesApi {
|
|
8
|
+
protected get __resourcePath(): string;
|
|
9
|
+
/**
|
|
10
|
+
* Query session analytics aggregated per user.
|
|
11
|
+
* @param body the query parameters.
|
|
12
|
+
* @returns collection of {@link SdPlatformResponseUserModelSessionAnalyticsPerTimestamp} based on query parameters.
|
|
13
|
+
*/
|
|
14
|
+
query(body?: SdPlatformQueryParameters<unknown>): Promise<SdPlatformQueryResponse<SdPlatformResponseUserModelSessionAnalyticsPerTimestamp>>;
|
|
15
|
+
}
|
|
16
16
|
//# sourceMappingURL=SdPlatformUserAnalyticsApi.d.ts.map
|
|
@@ -1,87 +1,87 @@
|
|
|
1
|
-
import { SdPlatformRequestUserPatchAdmin, SdPlatformRequestUserPasswordResetConfirm, SdPlatformRequestUserPatch, SdPlatformRequestUserRegister, SdPlatformResponseUserSelf, SdPlatformResponseUserMinimal, SdPlatformResponseUserRefreshToken } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
3
|
-
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
export declare enum SdPlatformUserQueryEmbeddableFields {
|
|
5
|
-
BackendSystem = "backend_system",
|
|
6
|
-
ChargebeeAddons = "chargebee_addons",
|
|
7
|
-
ChargebeeCustomer = "chargebee_customer",
|
|
8
|
-
ChargebeePlan = "chargebee_plan",
|
|
9
|
-
ChargebeeSubscription = "chargebee_subscription",
|
|
10
|
-
GlobalAccessDomains = "global_accessdomains",
|
|
11
|
-
Organization = "organization"
|
|
12
|
-
}
|
|
13
|
-
export declare enum SdPlatformUserGetEmbeddableFields {
|
|
14
|
-
BackendSystem = "backend_system",
|
|
15
|
-
ChargebeeAddons = "chargebee_addons",
|
|
16
|
-
ChargebeeCustomer = "chargebee_customer",
|
|
17
|
-
ChargebeePlan = "chargebee_plan",
|
|
18
|
-
ChargebeeSubscription = "chargebee_subscription",
|
|
19
|
-
GlobalAccessDomains = "global_accessdomains",
|
|
20
|
-
Organization = "organization",
|
|
21
|
-
UsedCredits = "used_credits"
|
|
22
|
-
}
|
|
23
|
-
export
|
|
24
|
-
/**
|
|
25
|
-
* Operations for users.
|
|
26
|
-
*/
|
|
27
|
-
export declare class SdPlatformUserApi extends ResourcesApi {
|
|
28
|
-
protected get __resourcePath(): string;
|
|
29
|
-
/**
|
|
30
|
-
* Gets the specific user by id
|
|
31
|
-
* @param id - user id.
|
|
32
|
-
* @param embed array of {@link SdPlatformUserGetEmbeddableFields} embeddable resources.
|
|
33
|
-
*/
|
|
34
|
-
get<T = SdPlatformResponseUserMinimal>(id: string, embed?: Array<SdPlatformUserGetEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
|
|
35
|
-
/**
|
|
36
|
-
* Register a new user. If successful a registration confirmation email will be sent.
|
|
37
|
-
* @param body {@link SdPlatformRequestUserRegister}
|
|
38
|
-
*/
|
|
39
|
-
register(body: SdPlatformRequestUserRegister): Promise<SdPlatformPostResponse<void>>;
|
|
40
|
-
/**
|
|
41
|
-
* Query users.
|
|
42
|
-
* @param body {@link SdPlatformUserQueryParameters}
|
|
43
|
-
*/
|
|
44
|
-
query<T = SdPlatformResponseUserMinimal>(body?: SdPlatformUserQueryParameters): Promise<SdPlatformQueryResponse<T>>;
|
|
45
|
-
/**
|
|
46
|
-
* Patch a user.
|
|
47
|
-
* @param id - the id of a user
|
|
48
|
-
* @param body {@link SdPlatformRequestUserPatch} properties to patch
|
|
49
|
-
*/
|
|
50
|
-
patch<T = SdPlatformResponseUserSelf>(id: string, body: SdPlatformRequestUserPatch | SdPlatformRequestUserPatchAdmin): Promise<SdPlatformPatchResponse<T>>;
|
|
51
|
-
/**
|
|
52
|
-
* Delete a user
|
|
53
|
-
* @param id
|
|
54
|
-
* @returns
|
|
55
|
-
*/
|
|
56
|
-
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
57
|
-
/**
|
|
58
|
-
* Confirm a user registration.
|
|
59
|
-
* @param token Token which was provided via registration confirmation email.
|
|
60
|
-
* @returns
|
|
61
|
-
*/
|
|
62
|
-
confirm(token: string): Promise<SdPlatformPostResponse<SdPlatformResponseUserSelf>>;
|
|
63
|
-
/**
|
|
64
|
-
* Request reset password token by email
|
|
65
|
-
* @param email
|
|
66
|
-
*/
|
|
67
|
-
passwordReset(email: string): Promise<SdPlatformPostResponse<void>>;
|
|
68
|
-
/**
|
|
69
|
-
* Change password using token
|
|
70
|
-
* @param body {@see SdPlatformRequestUserPasswordResetConfirm}
|
|
71
|
-
*/
|
|
72
|
-
passwordResetConfirm(body: SdPlatformRequestUserPasswordResetConfirm): Promise<SdPlatformPostResponse<void>>;
|
|
73
|
-
/**
|
|
74
|
-
* Returns an array of data about authorized client applications and their refresh tokens.
|
|
75
|
-
* @param user_id
|
|
76
|
-
* @returns the {@link SdPlatformGetResponse} with array of {@link SdPlatformResponseUserRefreshToken} as data
|
|
77
|
-
*/
|
|
78
|
-
getUserRefreshTokens(user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseUserRefreshToken>>>;
|
|
79
|
-
/**
|
|
80
|
-
* Delete refresh token.
|
|
81
|
-
* @param user_id
|
|
82
|
-
* @param refresh_token_id
|
|
83
|
-
* @returns the {@link SdPlatformDeleteResponse} response.
|
|
84
|
-
*/
|
|
85
|
-
deleteRefreshToken(user_id: string, refresh_token_id: string): Promise<SdPlatformDeleteResponse>;
|
|
86
|
-
}
|
|
1
|
+
import { SdPlatformRequestUserPatchAdmin, SdPlatformRequestUserPasswordResetConfirm, SdPlatformRequestUserPatch, SdPlatformRequestUserRegister, SdPlatformResponseUserSelf, SdPlatformResponseUserMinimal, SdPlatformResponseUserRefreshToken } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
3
|
+
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
export declare enum SdPlatformUserQueryEmbeddableFields {
|
|
5
|
+
BackendSystem = "backend_system",
|
|
6
|
+
ChargebeeAddons = "chargebee_addons",
|
|
7
|
+
ChargebeeCustomer = "chargebee_customer",
|
|
8
|
+
ChargebeePlan = "chargebee_plan",
|
|
9
|
+
ChargebeeSubscription = "chargebee_subscription",
|
|
10
|
+
GlobalAccessDomains = "global_accessdomains",
|
|
11
|
+
Organization = "organization"
|
|
12
|
+
}
|
|
13
|
+
export declare enum SdPlatformUserGetEmbeddableFields {
|
|
14
|
+
BackendSystem = "backend_system",
|
|
15
|
+
ChargebeeAddons = "chargebee_addons",
|
|
16
|
+
ChargebeeCustomer = "chargebee_customer",
|
|
17
|
+
ChargebeePlan = "chargebee_plan",
|
|
18
|
+
ChargebeeSubscription = "chargebee_subscription",
|
|
19
|
+
GlobalAccessDomains = "global_accessdomains",
|
|
20
|
+
Organization = "organization",
|
|
21
|
+
UsedCredits = "used_credits"
|
|
22
|
+
}
|
|
23
|
+
export type SdPlatformUserQueryParameters = SdPlatformQueryParameters<SdPlatformUserQueryEmbeddableFields>;
|
|
24
|
+
/**
|
|
25
|
+
* Operations for users.
|
|
26
|
+
*/
|
|
27
|
+
export declare class SdPlatformUserApi extends ResourcesApi {
|
|
28
|
+
protected get __resourcePath(): string;
|
|
29
|
+
/**
|
|
30
|
+
* Gets the specific user by id
|
|
31
|
+
* @param id - user id.
|
|
32
|
+
* @param embed array of {@link SdPlatformUserGetEmbeddableFields} embeddable resources.
|
|
33
|
+
*/
|
|
34
|
+
get<T = SdPlatformResponseUserMinimal>(id: string, embed?: Array<SdPlatformUserGetEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
|
|
35
|
+
/**
|
|
36
|
+
* Register a new user. If successful a registration confirmation email will be sent.
|
|
37
|
+
* @param body {@link SdPlatformRequestUserRegister}
|
|
38
|
+
*/
|
|
39
|
+
register(body: SdPlatformRequestUserRegister): Promise<SdPlatformPostResponse<void>>;
|
|
40
|
+
/**
|
|
41
|
+
* Query users.
|
|
42
|
+
* @param body {@link SdPlatformUserQueryParameters}
|
|
43
|
+
*/
|
|
44
|
+
query<T = SdPlatformResponseUserMinimal>(body?: SdPlatformUserQueryParameters): Promise<SdPlatformQueryResponse<T>>;
|
|
45
|
+
/**
|
|
46
|
+
* Patch a user.
|
|
47
|
+
* @param id - the id of a user
|
|
48
|
+
* @param body {@link SdPlatformRequestUserPatch} properties to patch
|
|
49
|
+
*/
|
|
50
|
+
patch<T = SdPlatformResponseUserSelf>(id: string, body: SdPlatformRequestUserPatch | SdPlatformRequestUserPatchAdmin): Promise<SdPlatformPatchResponse<T>>;
|
|
51
|
+
/**
|
|
52
|
+
* Delete a user
|
|
53
|
+
* @param id
|
|
54
|
+
* @returns
|
|
55
|
+
*/
|
|
56
|
+
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
57
|
+
/**
|
|
58
|
+
* Confirm a user registration.
|
|
59
|
+
* @param token Token which was provided via registration confirmation email.
|
|
60
|
+
* @returns
|
|
61
|
+
*/
|
|
62
|
+
confirm(token: string): Promise<SdPlatformPostResponse<SdPlatformResponseUserSelf>>;
|
|
63
|
+
/**
|
|
64
|
+
* Request reset password token by email
|
|
65
|
+
* @param email
|
|
66
|
+
*/
|
|
67
|
+
passwordReset(email: string): Promise<SdPlatformPostResponse<void>>;
|
|
68
|
+
/**
|
|
69
|
+
* Change password using token
|
|
70
|
+
* @param body {@see SdPlatformRequestUserPasswordResetConfirm}
|
|
71
|
+
*/
|
|
72
|
+
passwordResetConfirm(body: SdPlatformRequestUserPasswordResetConfirm): Promise<SdPlatformPostResponse<void>>;
|
|
73
|
+
/**
|
|
74
|
+
* Returns an array of data about authorized client applications and their refresh tokens.
|
|
75
|
+
* @param user_id
|
|
76
|
+
* @returns the {@link SdPlatformGetResponse} with array of {@link SdPlatformResponseUserRefreshToken} as data
|
|
77
|
+
*/
|
|
78
|
+
getUserRefreshTokens(user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseUserRefreshToken>>>;
|
|
79
|
+
/**
|
|
80
|
+
* Delete refresh token.
|
|
81
|
+
* @param user_id
|
|
82
|
+
* @param refresh_token_id
|
|
83
|
+
* @returns the {@link SdPlatformDeleteResponse} response.
|
|
84
|
+
*/
|
|
85
|
+
deleteRefreshToken(user_id: string, refresh_token_id: string): Promise<SdPlatformDeleteResponse>;
|
|
86
|
+
}
|
|
87
87
|
//# sourceMappingURL=SdPlatformUserApi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SdPlatformUserApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformUserApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,yCAAyC,EAAE,0BAA0B,EAAE,6BAA6B,EAAE,0BAA0B,EAAE,6BAA6B,EAAG,kCAAkC,EAAE,MAAM,qCAAqC,CAAC;AAE5R,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,mCAAmC;IAE3C,aAAa,mBAAmB;IAChC,eAAe,qBAAqB;IACpC,iBAAiB,uBAAuB;IACxC,aAAa,mBAAmB;IAChC,qBAAqB,2BAA2B;IAChD,mBAAmB,yBAAyB;IAC5C,YAAY,iBAAiB;CAChC;AAED,oBAAY,iCAAiC;IAEzC,aAAa,mBAAmB;IAChC,eAAe,qBAAqB;IACpC,iBAAiB,uBAAuB;IACxC,aAAa,mBAAmB;IAChC,qBAAqB,2BAA2B;IAChD,mBAAmB,yBAAyB;IAC5C,YAAY,iBAAiB;IAC7B,WAAW,iBAAiB;CAC/B;AAED,
|
|
1
|
+
{"version":3,"file":"SdPlatformUserApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformUserApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,yCAAyC,EAAE,0BAA0B,EAAE,6BAA6B,EAAE,0BAA0B,EAAE,6BAA6B,EAAG,kCAAkC,EAAE,MAAM,qCAAqC,CAAC;AAE5R,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,mCAAmC;IAE3C,aAAa,mBAAmB;IAChC,eAAe,qBAAqB;IACpC,iBAAiB,uBAAuB;IACxC,aAAa,mBAAmB;IAChC,qBAAqB,2BAA2B;IAChD,mBAAmB,yBAAyB;IAC5C,YAAY,iBAAiB;CAChC;AAED,oBAAY,iCAAiC;IAEzC,aAAa,mBAAmB;IAChC,eAAe,qBAAqB;IACpC,iBAAiB,uBAAuB;IACxC,aAAa,mBAAmB;IAChC,qBAAqB,2BAA2B;IAChD,mBAAmB,yBAAyB;IAC5C,YAAY,iBAAiB;IAC7B,WAAW,iBAAiB;CAC/B;AAED,MAAM,MAAM,6BAA6B,GAAG,yBAAyB,CAAC,mCAAmC,CAAC,CAAC;AAE3G;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IAE/C,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,GAAG,CAAC,CAAC,GAAG,6BAA6B,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,iCAAiC,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAK9I;;;OAGG;IACI,QAAQ,CAAC,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAK3F;;;OAGG;IACI,KAAK,CAAC,CAAC,GAAG,6BAA6B,EAAE,IAAI,GAAE,6BAAkC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK9H;;;;OAIG;IAEI,KAAK,CAAC,CAAC,GAAG,0BAA0B,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,GAAG,+BAA+B,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAKjK;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;OAIG;IACI,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;IAO1F;;;OAGG;IACI,aAAa,CAAC,KAAK,EAAE,MAAM,GAAI,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAO3E;;;OAGG;IACI,oBAAoB,CAAC,IAAI,EAAE,yCAAyC,GAAI,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAKpH;;;;OAIG;IACK,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAI,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC,CAAC;IAKxH;;;;;OAKG;IACI,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAK,OAAO,CAAC,wBAAwB,CAAC;CAI7G"}
|
|
@@ -1,53 +1,53 @@
|
|
|
1
|
-
import { SdPlatformSdkApi, SdPlatformSdkRequestConfig } from "../api/SdPlatformSdkApi";
|
|
2
|
-
import { SdPlatformSdkContext } from "../SdPlatformSdkContext";
|
|
3
|
-
import { SdPlatformRequestWebhookChargebeeEvent, SdPlatformRequestWebhookModelMessage, SdPlatformRequestWebhookNotification, SdPlatformResponseNotification } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
import { SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
5
|
-
export interface SdPlatformWebhookBasicAuth {
|
|
6
|
-
username: string;
|
|
7
|
-
password: string;
|
|
8
|
-
}
|
|
9
|
-
export interface SdPlatformWebhookTokenAuth {
|
|
10
|
-
bearer_access_token?: string;
|
|
11
|
-
basic_access_token?: string;
|
|
12
|
-
}
|
|
13
|
-
/**
|
|
14
|
-
* Webhook calls.
|
|
15
|
-
*/
|
|
16
|
-
export declare class SdPlatformWebhookApi {
|
|
17
|
-
protected __context: SdPlatformSdkContext;
|
|
18
|
-
protected __commonPath: string;
|
|
19
|
-
protected __api: SdPlatformSdkApi;
|
|
20
|
-
/**
|
|
21
|
-
* @param { ShapeDiverSDKContext } __context
|
|
22
|
-
*/
|
|
23
|
-
constructor(__context: SdPlatformSdkContext);
|
|
24
|
-
protected __getPath(pathSufix?: null | string): string;
|
|
25
|
-
protected __resolveRequestConfig(options: {
|
|
26
|
-
username?: string;
|
|
27
|
-
password?: string;
|
|
28
|
-
bearer_access_token?: string;
|
|
29
|
-
basic_access_token?: string;
|
|
30
|
-
}): SdPlatformSdkRequestConfig;
|
|
31
|
-
/**
|
|
32
|
-
* Webhook which notifies the platform of chargebee events.
|
|
33
|
-
* @param auth {@link SdPlatformWebhookBasicAuth}
|
|
34
|
-
* @param body {@link SdPlatformRequestWebhookChargebeeEvent}
|
|
35
|
-
* @returns
|
|
36
|
-
*/
|
|
37
|
-
chargebeeEvent(auth: SdPlatformWebhookBasicAuth, body: SdPlatformRequestWebhookChargebeeEvent): Promise<SdPlatformPostResponse<void>>;
|
|
38
|
-
/**
|
|
39
|
-
* Model message webhook call - send a message to the owner of a model.
|
|
40
|
-
* @param auth {@link SdPlatformWebhookTokenAuth}
|
|
41
|
-
* @param body {@link SdPlatformRequestWebhookModelMessage}
|
|
42
|
-
* @returns
|
|
43
|
-
*/
|
|
44
|
-
modelMessage(auth: SdPlatformWebhookTokenAuth, body: SdPlatformRequestWebhookModelMessage): Promise<SdPlatformPostResponse<void>>;
|
|
45
|
-
/**
|
|
46
|
-
* Notification webhook call - create a notification related to a model.
|
|
47
|
-
* @param auth {@link SdPlatformWebhookTokenAuth}
|
|
48
|
-
* @param body {@link SdPlatformRequestWebhookNotification}
|
|
49
|
-
* @returns
|
|
50
|
-
*/
|
|
51
|
-
notification(auth: SdPlatformWebhookTokenAuth, body: SdPlatformRequestWebhookNotification): Promise<SdPlatformPostResponse<SdPlatformResponseNotification>>;
|
|
52
|
-
}
|
|
1
|
+
import { SdPlatformSdkApi, SdPlatformSdkRequestConfig } from "../api/SdPlatformSdkApi";
|
|
2
|
+
import { SdPlatformSdkContext } from "../SdPlatformSdkContext";
|
|
3
|
+
import { SdPlatformRequestWebhookChargebeeEvent, SdPlatformRequestWebhookModelMessage, SdPlatformRequestWebhookNotification, SdPlatformResponseNotification } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
import { SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
5
|
+
export interface SdPlatformWebhookBasicAuth {
|
|
6
|
+
username: string;
|
|
7
|
+
password: string;
|
|
8
|
+
}
|
|
9
|
+
export interface SdPlatformWebhookTokenAuth {
|
|
10
|
+
bearer_access_token?: string;
|
|
11
|
+
basic_access_token?: string;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Webhook calls.
|
|
15
|
+
*/
|
|
16
|
+
export declare class SdPlatformWebhookApi {
|
|
17
|
+
protected __context: SdPlatformSdkContext;
|
|
18
|
+
protected __commonPath: string;
|
|
19
|
+
protected __api: SdPlatformSdkApi;
|
|
20
|
+
/**
|
|
21
|
+
* @param { ShapeDiverSDKContext } __context
|
|
22
|
+
*/
|
|
23
|
+
constructor(__context: SdPlatformSdkContext);
|
|
24
|
+
protected __getPath(pathSufix?: null | string): string;
|
|
25
|
+
protected __resolveRequestConfig(options: {
|
|
26
|
+
username?: string;
|
|
27
|
+
password?: string;
|
|
28
|
+
bearer_access_token?: string;
|
|
29
|
+
basic_access_token?: string;
|
|
30
|
+
}): SdPlatformSdkRequestConfig;
|
|
31
|
+
/**
|
|
32
|
+
* Webhook which notifies the platform of chargebee events.
|
|
33
|
+
* @param auth {@link SdPlatformWebhookBasicAuth}
|
|
34
|
+
* @param body {@link SdPlatformRequestWebhookChargebeeEvent}
|
|
35
|
+
* @returns
|
|
36
|
+
*/
|
|
37
|
+
chargebeeEvent(auth: SdPlatformWebhookBasicAuth, body: SdPlatformRequestWebhookChargebeeEvent): Promise<SdPlatformPostResponse<void>>;
|
|
38
|
+
/**
|
|
39
|
+
* Model message webhook call - send a message to the owner of a model.
|
|
40
|
+
* @param auth {@link SdPlatformWebhookTokenAuth}
|
|
41
|
+
* @param body {@link SdPlatformRequestWebhookModelMessage}
|
|
42
|
+
* @returns
|
|
43
|
+
*/
|
|
44
|
+
modelMessage(auth: SdPlatformWebhookTokenAuth, body: SdPlatformRequestWebhookModelMessage): Promise<SdPlatformPostResponse<void>>;
|
|
45
|
+
/**
|
|
46
|
+
* Notification webhook call - create a notification related to a model.
|
|
47
|
+
* @param auth {@link SdPlatformWebhookTokenAuth}
|
|
48
|
+
* @param body {@link SdPlatformRequestWebhookNotification}
|
|
49
|
+
* @returns
|
|
50
|
+
*/
|
|
51
|
+
notification(auth: SdPlatformWebhookTokenAuth, body: SdPlatformRequestWebhookNotification): Promise<SdPlatformPostResponse<SdPlatformResponseNotification>>;
|
|
52
|
+
}
|
|
53
53
|
//# sourceMappingURL=SdPlatformWebhookApi.d.ts.map
|
|
@@ -1,55 +1,55 @@
|
|
|
1
|
-
import { SdPlatformFilterValue } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
-
/**
|
|
3
|
-
* TODO https://shapediver.atlassian.net/browse/SS-4815
|
|
4
|
-
* document, test, expose somehow in resource API
|
|
5
|
-
*/
|
|
6
|
-
export declare enum FilterOperators {
|
|
7
|
-
Equal = "=",
|
|
8
|
-
Like = "%"
|
|
9
|
-
}
|
|
10
|
-
export declare enum LogicalOperators {
|
|
11
|
-
And = "&",
|
|
12
|
-
Or = "|"
|
|
13
|
-
}
|
|
14
|
-
export interface FilterExpression {
|
|
15
|
-
property: string;
|
|
16
|
-
value: SdPlatformFilterValue;
|
|
17
|
-
filter_operator?: FilterOperators;
|
|
18
|
-
logical_operator?: LogicalOperators;
|
|
19
|
-
join?: FilterExpression;
|
|
20
|
-
}
|
|
21
|
-
/**
|
|
22
|
-
* Interface for filter builder.
|
|
23
|
-
*/
|
|
24
|
-
export interface FilterBuilder {
|
|
25
|
-
/**
|
|
26
|
-
* Starts filter from begining. Essentially replacing all existing expressions.
|
|
27
|
-
* @param expressions
|
|
28
|
-
*/
|
|
29
|
-
start(expressions?: Array<FilterExpression>): FilterBuilder;
|
|
30
|
-
/**
|
|
31
|
-
* Adds filter expression to filter.
|
|
32
|
-
* @param expression
|
|
33
|
-
*/
|
|
34
|
-
attach(expression: FilterExpression): FilterBuilder;
|
|
35
|
-
/**
|
|
36
|
-
* Finish with filter and resolve it to final filter parameter for request.
|
|
37
|
-
*/
|
|
38
|
-
finish(): {
|
|
39
|
-
[filter_expression: string]: SdPlatformFilterValue;
|
|
40
|
-
};
|
|
41
|
-
}
|
|
42
|
-
/**
|
|
43
|
-
* Instance of filter builder.
|
|
44
|
-
*/
|
|
45
|
-
export declare class FilterBuilderInstance implements FilterBuilder {
|
|
46
|
-
private __expressions;
|
|
47
|
-
constructor(__expressions?: Array<FilterExpression>);
|
|
48
|
-
static create(expressions?: FilterExpression[]): FilterBuilder;
|
|
49
|
-
start(expressions?: FilterExpression[]): FilterBuilder;
|
|
50
|
-
attach(expression: FilterExpression): FilterBuilder;
|
|
51
|
-
finish(): {
|
|
52
|
-
[filter_expression: string]: SdPlatformFilterValue;
|
|
53
|
-
};
|
|
54
|
-
}
|
|
1
|
+
import { SdPlatformFilterValue } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
+
/**
|
|
3
|
+
* TODO https://shapediver.atlassian.net/browse/SS-4815
|
|
4
|
+
* document, test, expose somehow in resource API
|
|
5
|
+
*/
|
|
6
|
+
export declare enum FilterOperators {
|
|
7
|
+
Equal = "=",
|
|
8
|
+
Like = "%"
|
|
9
|
+
}
|
|
10
|
+
export declare enum LogicalOperators {
|
|
11
|
+
And = "&",
|
|
12
|
+
Or = "|"
|
|
13
|
+
}
|
|
14
|
+
export interface FilterExpression {
|
|
15
|
+
property: string;
|
|
16
|
+
value: SdPlatformFilterValue;
|
|
17
|
+
filter_operator?: FilterOperators;
|
|
18
|
+
logical_operator?: LogicalOperators;
|
|
19
|
+
join?: FilterExpression;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Interface for filter builder.
|
|
23
|
+
*/
|
|
24
|
+
export interface FilterBuilder {
|
|
25
|
+
/**
|
|
26
|
+
* Starts filter from begining. Essentially replacing all existing expressions.
|
|
27
|
+
* @param expressions
|
|
28
|
+
*/
|
|
29
|
+
start(expressions?: Array<FilterExpression>): FilterBuilder;
|
|
30
|
+
/**
|
|
31
|
+
* Adds filter expression to filter.
|
|
32
|
+
* @param expression
|
|
33
|
+
*/
|
|
34
|
+
attach(expression: FilterExpression): FilterBuilder;
|
|
35
|
+
/**
|
|
36
|
+
* Finish with filter and resolve it to final filter parameter for request.
|
|
37
|
+
*/
|
|
38
|
+
finish(): {
|
|
39
|
+
[filter_expression: string]: SdPlatformFilterValue;
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Instance of filter builder.
|
|
44
|
+
*/
|
|
45
|
+
export declare class FilterBuilderInstance implements FilterBuilder {
|
|
46
|
+
private __expressions;
|
|
47
|
+
constructor(__expressions?: Array<FilterExpression>);
|
|
48
|
+
static create(expressions?: FilterExpression[]): FilterBuilder;
|
|
49
|
+
start(expressions?: FilterExpression[]): FilterBuilder;
|
|
50
|
+
attach(expression: FilterExpression): FilterBuilder;
|
|
51
|
+
finish(): {
|
|
52
|
+
[filter_expression: string]: SdPlatformFilterValue;
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
55
|
//# sourceMappingURL=FilterBuilder.d.ts.map
|
|
@@ -1,43 +1,43 @@
|
|
|
1
|
-
import { SdPlatformSdkApi, SdPlatformSdkRequestConfig } from "../../api/SdPlatformSdkApi";
|
|
2
|
-
import { SdPlatformSdkContext } from "../../SdPlatformSdkContext";
|
|
3
|
-
import { SdPlatformAuthServiceApi } from "../../auth/SdPlatformAuthServiceApi";
|
|
4
|
-
import { RequestId } from "../../api/SdPlatformRequestId";
|
|
5
|
-
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
6
|
-
/**
|
|
7
|
-
* Actions enum.
|
|
8
|
-
*/
|
|
9
|
-
export declare enum Action {
|
|
10
|
-
Post = "post",
|
|
11
|
-
Get = "get",
|
|
12
|
-
Delete = "delete",
|
|
13
|
-
Patch = "patch"
|
|
14
|
-
}
|
|
15
|
-
/**
|
|
16
|
-
* Base ShapeDiver Platform resource API. Implement this for new resources.
|
|
17
|
-
*/
|
|
18
|
-
export declare abstract class ResourcesApi {
|
|
19
|
-
protected __context: SdPlatformSdkContext;
|
|
20
|
-
protected __authApi: SdPlatformAuthServiceApi;
|
|
21
|
-
protected __commonPath: string;
|
|
22
|
-
protected __api: SdPlatformSdkApi;
|
|
23
|
-
constructor(__context: SdPlatformSdkContext, __authApi: SdPlatformAuthServiceApi);
|
|
24
|
-
protected abstract get __resourcePath(): string;
|
|
25
|
-
protected __getPath(pathSufix?: null | string): string;
|
|
26
|
-
protected __resolveRequestConfig(): SdPlatformSdkRequestConfig;
|
|
27
|
-
protected __refreshTokenIfExpired(): Promise<void>;
|
|
28
|
-
protected __schema<T>(requestId: RequestId): Promise<T>;
|
|
29
|
-
/**
|
|
30
|
-
* Base get request
|
|
31
|
-
* @param { string } id - the id of a resource.
|
|
32
|
-
* @param { null|Array<string> } embed - resources to embed.
|
|
33
|
-
*/
|
|
34
|
-
protected __get<T>(requestId: RequestId, id: string, embed?: Array<string>): Promise<SdPlatformGetResponse<T>>;
|
|
35
|
-
protected __query<T, TEmbeddableFields>(requestId: RequestId, body?: SdPlatformQueryParameters<TEmbeddableFields>): Promise<SdPlatformQueryResponse<T>>;
|
|
36
|
-
protected __post<T, TModel>(requestId: RequestId, body: T): Promise<SdPlatformPostResponse<TModel>>;
|
|
37
|
-
protected __patch<T, TModel>(requestId: RequestId, id: string, body: T): Promise<SdPlatformPatchResponse<TModel>>;
|
|
38
|
-
protected __delete(requestId: RequestId, id: string): Promise<SdPlatformDeleteResponse>;
|
|
39
|
-
protected __action<TResponse, TBody>(requestId: RequestId, action: Action, pathSuffix: string, body: TBody, headers?: {
|
|
40
|
-
[id: string]: string;
|
|
41
|
-
}): Promise<TResponse>;
|
|
42
|
-
}
|
|
1
|
+
import { SdPlatformSdkApi, SdPlatformSdkRequestConfig } from "../../api/SdPlatformSdkApi";
|
|
2
|
+
import { SdPlatformSdkContext } from "../../SdPlatformSdkContext";
|
|
3
|
+
import { SdPlatformAuthServiceApi } from "../../auth/SdPlatformAuthServiceApi";
|
|
4
|
+
import { RequestId } from "../../api/SdPlatformRequestId";
|
|
5
|
+
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
6
|
+
/**
|
|
7
|
+
* Actions enum.
|
|
8
|
+
*/
|
|
9
|
+
export declare enum Action {
|
|
10
|
+
Post = "post",
|
|
11
|
+
Get = "get",
|
|
12
|
+
Delete = "delete",
|
|
13
|
+
Patch = "patch"
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Base ShapeDiver Platform resource API. Implement this for new resources.
|
|
17
|
+
*/
|
|
18
|
+
export declare abstract class ResourcesApi {
|
|
19
|
+
protected __context: SdPlatformSdkContext;
|
|
20
|
+
protected __authApi: SdPlatformAuthServiceApi;
|
|
21
|
+
protected __commonPath: string;
|
|
22
|
+
protected __api: SdPlatformSdkApi;
|
|
23
|
+
constructor(__context: SdPlatformSdkContext, __authApi: SdPlatformAuthServiceApi);
|
|
24
|
+
protected abstract get __resourcePath(): string;
|
|
25
|
+
protected __getPath(pathSufix?: null | string): string;
|
|
26
|
+
protected __resolveRequestConfig(): SdPlatformSdkRequestConfig;
|
|
27
|
+
protected __refreshTokenIfExpired(): Promise<void>;
|
|
28
|
+
protected __schema<T>(requestId: RequestId): Promise<T>;
|
|
29
|
+
/**
|
|
30
|
+
* Base get request
|
|
31
|
+
* @param { string } id - the id of a resource.
|
|
32
|
+
* @param { null|Array<string> } embed - resources to embed.
|
|
33
|
+
*/
|
|
34
|
+
protected __get<T>(requestId: RequestId, id: string, embed?: Array<string>): Promise<SdPlatformGetResponse<T>>;
|
|
35
|
+
protected __query<T, TEmbeddableFields>(requestId: RequestId, body?: SdPlatformQueryParameters<TEmbeddableFields>): Promise<SdPlatformQueryResponse<T>>;
|
|
36
|
+
protected __post<T, TModel>(requestId: RequestId, body: T): Promise<SdPlatformPostResponse<TModel>>;
|
|
37
|
+
protected __patch<T, TModel>(requestId: RequestId, id: string, body: T): Promise<SdPlatformPatchResponse<TModel>>;
|
|
38
|
+
protected __delete(requestId: RequestId, id: string): Promise<SdPlatformDeleteResponse>;
|
|
39
|
+
protected __action<TResponse, TBody>(requestId: RequestId, action: Action, pathSuffix: string, body: TBody, headers?: {
|
|
40
|
+
[id: string]: string;
|
|
41
|
+
}): Promise<TResponse>;
|
|
42
|
+
}
|
|
43
43
|
//# sourceMappingURL=ResourcesApi.d.ts.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shapediver/sdk.platform-api-sdk-v1",
|
|
3
|
-
"version": "2.14.
|
|
3
|
+
"version": "2.14.4",
|
|
4
4
|
"description": "SDK to communicate with the Platform API version 1",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"shapediver",
|
|
@@ -36,23 +36,25 @@
|
|
|
36
36
|
"build": "npx webpack",
|
|
37
37
|
"build-dep": "bash ../../scripts/build-dep.sh",
|
|
38
38
|
"build-dev": "bash ../../scripts/build-dev.sh",
|
|
39
|
-
"build-prod": "bash ../../scripts/build-prod.sh"
|
|
39
|
+
"build-prod": "bash ../../scripts/build-prod.sh",
|
|
40
|
+
"pre-publish": "bash ../../scripts/pre-publish.sh",
|
|
41
|
+
"post-publish": "bash ../../scripts/post-publish.sh"
|
|
40
42
|
},
|
|
41
43
|
"dependencies": {
|
|
42
|
-
"@shapediver/api.platform-api-dto-v1": "
|
|
43
|
-
"@types/q": "
|
|
44
|
+
"@shapediver/api.platform-api-dto-v1": "~2.14.10",
|
|
45
|
+
"@types/q": "~1.5.5",
|
|
44
46
|
"axios": "^0.26.1",
|
|
45
|
-
"dotenv": "
|
|
46
|
-
"jwt-decode": "
|
|
47
|
+
"dotenv": "~16.0.3",
|
|
48
|
+
"jwt-decode": "~3.1.2"
|
|
47
49
|
},
|
|
48
50
|
"devDependencies": {
|
|
49
|
-
"@types/node-fetch": "
|
|
50
|
-
"dotenv-webpack": "7.1.
|
|
51
|
-
"jest": "
|
|
51
|
+
"@types/node-fetch": "~2.6.2",
|
|
52
|
+
"dotenv-webpack": "7.1.1",
|
|
53
|
+
"jest": "~27.5.1",
|
|
52
54
|
"lerna": "3.22.1",
|
|
53
|
-
"ts-loader": "
|
|
54
|
-
"typescript": "
|
|
55
|
-
"webpack": "
|
|
55
|
+
"ts-loader": "~8.4.0",
|
|
56
|
+
"typescript": "~4.9.5",
|
|
57
|
+
"webpack": "~4.46.0",
|
|
56
58
|
"webpack-cli": "4.9.2",
|
|
57
59
|
"webpack-dev-server": "4.8.1"
|
|
58
60
|
},
|