@commercelayer/provisioning-sdk 1.0.5 → 1.1.0
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/lib/index.d.mts +576 -0
- package/lib/index.d.ts +576 -0
- package/lib/index.js +1 -0
- package/lib/index.mjs +1 -0
- package/package.json +14 -15
- package/lib/cjs/api.d.ts +0 -43
- package/lib/cjs/api.js +0 -45
- package/lib/cjs/client.d.ts +0 -42
- package/lib/cjs/client.js +0 -149
- package/lib/cjs/commercelayer.d.ts +0 -39
- package/lib/cjs/commercelayer.js +0 -130
- package/lib/cjs/common.d.ts +0 -5
- package/lib/cjs/common.js +0 -12
- package/lib/cjs/config.d.ts +0 -15
- package/lib/cjs/config.js +0 -19
- package/lib/cjs/debug.d.ts +0 -3
- package/lib/cjs/debug.js +0 -38
- package/lib/cjs/error.d.ts +0 -31
- package/lib/cjs/error.js +0 -77
- package/lib/cjs/index.d.ts +0 -7
- package/lib/cjs/index.js +0 -13
- package/lib/cjs/interceptor.d.ts +0 -25
- package/lib/cjs/interceptor.js +0 -2
- package/lib/cjs/jsonapi.d.ts +0 -6
- package/lib/cjs/jsonapi.js +0 -94
- package/lib/cjs/model.d.ts +0 -11
- package/lib/cjs/model.js +0 -3
- package/lib/cjs/query.d.ts +0 -17
- package/lib/cjs/query.js +0 -52
- package/lib/cjs/resource.d.ts +0 -86
- package/lib/cjs/resource.js +0 -194
- package/lib/cjs/resources/api_credentials.d.ts +0 -59
- package/lib/cjs/resources/api_credentials.js +0 -33
- package/lib/cjs/resources/application_memberships.d.ts +0 -57
- package/lib/cjs/resources/application_memberships.js +0 -41
- package/lib/cjs/resources/memberships.d.ts +0 -58
- package/lib/cjs/resources/memberships.js +0 -45
- package/lib/cjs/resources/organizations.d.ts +0 -84
- package/lib/cjs/resources/organizations.js +0 -42
- package/lib/cjs/resources/permissions.d.ts +0 -52
- package/lib/cjs/resources/permissions.js +0 -34
- package/lib/cjs/resources/roles.d.ts +0 -47
- package/lib/cjs/resources/roles.js +0 -42
- package/lib/cjs/resources/user.d.ts +0 -29
- package/lib/cjs/resources/user.js +0 -20
- package/lib/cjs/resources/versions.d.ts +0 -22
- package/lib/cjs/resources/versions.js +0 -16
- package/lib/cjs/static.d.ts +0 -12
- package/lib/cjs/static.js +0 -51
- package/lib/cjs/util.d.ts +0 -9
- package/lib/cjs/util.js +0 -16
- package/lib/esm/api.d.ts +0 -43
- package/lib/esm/api.js +0 -31
- package/lib/esm/client.d.ts +0 -42
- package/lib/esm/client.js +0 -144
- package/lib/esm/commercelayer.d.ts +0 -39
- package/lib/esm/commercelayer.js +0 -101
- package/lib/esm/common.d.ts +0 -5
- package/lib/esm/common.js +0 -8
- package/lib/esm/config.d.ts +0 -15
- package/lib/esm/config.js +0 -17
- package/lib/esm/debug.d.ts +0 -3
- package/lib/esm/debug.js +0 -36
- package/lib/esm/error.d.ts +0 -31
- package/lib/esm/error.js +0 -69
- package/lib/esm/index.d.ts +0 -7
- package/lib/esm/index.js +0 -4
- package/lib/esm/interceptor.d.ts +0 -25
- package/lib/esm/interceptor.js +0 -1
- package/lib/esm/jsonapi.d.ts +0 -6
- package/lib/esm/jsonapi.js +0 -87
- package/lib/esm/model.d.ts +0 -11
- package/lib/esm/model.js +0 -2
- package/lib/esm/query.d.ts +0 -17
- package/lib/esm/query.js +0 -45
- package/lib/esm/resource.d.ts +0 -86
- package/lib/esm/resource.js +0 -187
- package/lib/esm/resources/api_credentials.d.ts +0 -59
- package/lib/esm/resources/api_credentials.js +0 -31
- package/lib/esm/resources/application_memberships.d.ts +0 -57
- package/lib/esm/resources/application_memberships.js +0 -39
- package/lib/esm/resources/memberships.d.ts +0 -58
- package/lib/esm/resources/memberships.js +0 -43
- package/lib/esm/resources/organizations.d.ts +0 -84
- package/lib/esm/resources/organizations.js +0 -40
- package/lib/esm/resources/permissions.d.ts +0 -52
- package/lib/esm/resources/permissions.js +0 -32
- package/lib/esm/resources/roles.d.ts +0 -47
- package/lib/esm/resources/roles.js +0 -40
- package/lib/esm/resources/user.d.ts +0 -29
- package/lib/esm/resources/user.js +0 -18
- package/lib/esm/resources/versions.d.ts +0 -22
- package/lib/esm/resources/versions.js +0 -14
- package/lib/esm/static.d.ts +0 -12
- package/lib/esm/static.js +0 -25
- package/lib/esm/util.d.ts +0 -9
- package/lib/esm/util.js +0 -37
- package/lib/tsconfig.esm.tsbuildinfo +0 -1
- package/lib/tsconfig.tsbuildinfo +0 -1
package/lib/index.d.mts
ADDED
|
@@ -0,0 +1,576 @@
|
|
|
1
|
+
import { AxiosRequestConfig, AxiosResponse, AxiosResponseHeaders, RawAxiosResponseHeaders, AxiosError, AxiosInterceptorManager, AxiosProxyConfig, AxiosAdapter } from 'axios';
|
|
2
|
+
import { Agent } from 'http';
|
|
3
|
+
import { Agent as Agent$1 } from 'https';
|
|
4
|
+
|
|
5
|
+
type InterceptorManager = {
|
|
6
|
+
request: AxiosInterceptorManager<AxiosRequestConfig>;
|
|
7
|
+
response: AxiosInterceptorManager<any>;
|
|
8
|
+
};
|
|
9
|
+
type RequestObj = AxiosRequestConfig;
|
|
10
|
+
type RequestInterceptor = (request: RequestObj) => RequestObj | Promise<RequestObj>;
|
|
11
|
+
type ResponseObj = AxiosResponse;
|
|
12
|
+
type ResponseInterceptor = (response: ResponseObj) => ResponseObj;
|
|
13
|
+
type ApiHeadersList = 'x-ratelimit-limit' | 'x-ratelimit-count' | 'x-ratelimit-period' | 'x-ratelimit-interval' | 'x-ratelimit-remaining';
|
|
14
|
+
type ApiHeaders = {
|
|
15
|
+
[key in ApiHeadersList]: string | number | boolean;
|
|
16
|
+
};
|
|
17
|
+
type HeadersObj = (AxiosResponseHeaders | RawAxiosResponseHeaders) & ApiHeaders;
|
|
18
|
+
type ErrorObj = AxiosError;
|
|
19
|
+
type ErrorInterceptor = (error: ErrorObj) => ErrorObj;
|
|
20
|
+
type InterceptorType = 'request' | 'response';
|
|
21
|
+
|
|
22
|
+
type RawResponseReader = {
|
|
23
|
+
id: number | undefined;
|
|
24
|
+
rawResponse: ResponseObj | undefined;
|
|
25
|
+
headers: HeadersObj | undefined;
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
type ProxyConfig = AxiosProxyConfig | false;
|
|
29
|
+
type Adapter = AxiosAdapter;
|
|
30
|
+
type RequestParams = Record<string, string | number | boolean>;
|
|
31
|
+
type RequestHeaders = Record<string, string>;
|
|
32
|
+
type RequestConfig = {
|
|
33
|
+
timeout?: number;
|
|
34
|
+
params?: RequestParams;
|
|
35
|
+
httpAgent?: Agent;
|
|
36
|
+
httpsAgent?: Agent$1;
|
|
37
|
+
proxy?: ProxyConfig;
|
|
38
|
+
headers?: RequestHeaders;
|
|
39
|
+
};
|
|
40
|
+
type RequestConfigExtra = {
|
|
41
|
+
adapter?: Adapter;
|
|
42
|
+
userAgent?: string;
|
|
43
|
+
};
|
|
44
|
+
type ApiConfig = {
|
|
45
|
+
domain?: string;
|
|
46
|
+
accessToken: string;
|
|
47
|
+
};
|
|
48
|
+
type ApiClientInitConfig = ApiConfig & RequestConfig & RequestConfigExtra;
|
|
49
|
+
|
|
50
|
+
type QueryFilter = Record<string, string | number | boolean>;
|
|
51
|
+
interface QueryParamsRetrieve {
|
|
52
|
+
include?: string[];
|
|
53
|
+
fields?: string[] | Record<string, string[]>;
|
|
54
|
+
}
|
|
55
|
+
interface QueryParamsList extends QueryParamsRetrieve {
|
|
56
|
+
sort?: string[] | Record<string, 'asc' | 'desc'>;
|
|
57
|
+
filters?: QueryFilter;
|
|
58
|
+
pageNumber?: number;
|
|
59
|
+
pageSize?: number;
|
|
60
|
+
}
|
|
61
|
+
type QueryParams = QueryParamsRetrieve | QueryParamsList;
|
|
62
|
+
|
|
63
|
+
type ResourceNull = {
|
|
64
|
+
id: null;
|
|
65
|
+
} & ResourceType;
|
|
66
|
+
type ResourceRel = ResourceId | ResourceNull;
|
|
67
|
+
type Metadata = Record<string, any>;
|
|
68
|
+
interface ResourceType {
|
|
69
|
+
readonly type: ResourceTypeLock;
|
|
70
|
+
}
|
|
71
|
+
interface ResourceId extends ResourceType {
|
|
72
|
+
readonly id: string;
|
|
73
|
+
}
|
|
74
|
+
interface ResourceBase {
|
|
75
|
+
reference?: string | null;
|
|
76
|
+
reference_origin?: string | null;
|
|
77
|
+
metadata?: Metadata;
|
|
78
|
+
}
|
|
79
|
+
interface Resource extends ResourceBase, ResourceId {
|
|
80
|
+
readonly created_at: string;
|
|
81
|
+
readonly updated_at: string;
|
|
82
|
+
}
|
|
83
|
+
interface ResourceCreate extends ResourceBase {
|
|
84
|
+
}
|
|
85
|
+
interface ResourceUpdate extends ResourceBase {
|
|
86
|
+
readonly id: string;
|
|
87
|
+
}
|
|
88
|
+
type ListMeta = {
|
|
89
|
+
readonly pageCount: number;
|
|
90
|
+
readonly recordCount: number;
|
|
91
|
+
readonly currentPage: number;
|
|
92
|
+
readonly recordsPerPage: number;
|
|
93
|
+
};
|
|
94
|
+
declare class ListResponse<R> extends Array<R> {
|
|
95
|
+
readonly meta: ListMeta;
|
|
96
|
+
constructor(meta: ListMeta, data: R[]);
|
|
97
|
+
first(): R | undefined;
|
|
98
|
+
last(): R | undefined;
|
|
99
|
+
get(index: number): R | undefined;
|
|
100
|
+
hasNextPage(): boolean;
|
|
101
|
+
hasPrevPage(): boolean;
|
|
102
|
+
getRecordCount(): number;
|
|
103
|
+
getPageCount(): number;
|
|
104
|
+
get recordCount(): number;
|
|
105
|
+
get pageCount(): number;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
type ResourceAdapterConfig = {};
|
|
109
|
+
type ResourcesInitConfig = ResourceAdapterConfig & ApiClientInitConfig;
|
|
110
|
+
type ResourcesConfig = Partial<ResourcesInitConfig>;
|
|
111
|
+
declare class ResourceAdapter {
|
|
112
|
+
#private;
|
|
113
|
+
constructor(config: ResourcesInitConfig);
|
|
114
|
+
get interceptors(): InterceptorManager;
|
|
115
|
+
private localConfig;
|
|
116
|
+
config(config: ResourcesConfig): this;
|
|
117
|
+
retrieve<R extends Resource>(resource: ResourceId | ResourceType, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
|
|
118
|
+
list<R extends Resource>(resource: ResourceType, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
|
|
119
|
+
create<C extends ResourceCreate, R extends Resource>(resource: C & ResourceType, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
|
|
120
|
+
update<U extends ResourceUpdate, R extends Resource>(resource: U & ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
|
|
121
|
+
delete(resource: ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
122
|
+
fetch<R extends Resource>(resource: string | ResourceType, path: string, params?: QueryParams, options?: ResourcesConfig): Promise<R | ListResponse<R>>;
|
|
123
|
+
action(cmd: 'post' | 'patch', path: string, payload?: any, options?: ResourcesConfig): Promise<void>;
|
|
124
|
+
}
|
|
125
|
+
declare abstract class ApiResourceBase<R extends Resource> {
|
|
126
|
+
static readonly TYPE: ResourceTypeLock;
|
|
127
|
+
protected readonly resources: ResourceAdapter;
|
|
128
|
+
constructor(adapter: ResourceAdapter);
|
|
129
|
+
abstract relationship(id: string | ResourceId | null): ResourceRel;
|
|
130
|
+
abstract type(): ResourceTypeLock;
|
|
131
|
+
parse(resource: string): R | R[];
|
|
132
|
+
update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
|
|
133
|
+
}
|
|
134
|
+
declare abstract class ApiResource<R extends Resource> extends ApiResourceBase<R> {
|
|
135
|
+
retrieve(id: string | ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
|
|
136
|
+
list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
|
|
137
|
+
count(filter?: QueryFilter | QueryParamsList, options?: ResourcesConfig): Promise<number>;
|
|
138
|
+
}
|
|
139
|
+
declare abstract class ApiSingleton<R extends Resource> extends ApiResourceBase<R> {
|
|
140
|
+
retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
type VersionType = 'versions';
|
|
144
|
+
type VersionRel = ResourceRel & {
|
|
145
|
+
type: VersionType;
|
|
146
|
+
};
|
|
147
|
+
interface Version extends Resource {
|
|
148
|
+
readonly type: VersionType;
|
|
149
|
+
resource_type: string;
|
|
150
|
+
resource_id: string;
|
|
151
|
+
event: string;
|
|
152
|
+
changes: Record<string, any>;
|
|
153
|
+
who: Record<string, any>;
|
|
154
|
+
}
|
|
155
|
+
declare class Versions extends ApiResource<Version> {
|
|
156
|
+
static readonly TYPE: VersionType;
|
|
157
|
+
isVersion(resource: any): resource is Version;
|
|
158
|
+
relationship(id: string | ResourceId | null): VersionRel;
|
|
159
|
+
type(): VersionType;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
type PermissionType = 'permissions';
|
|
163
|
+
type PermissionRel = ResourceRel & {
|
|
164
|
+
type: PermissionType;
|
|
165
|
+
};
|
|
166
|
+
type RoleRel$4 = ResourceRel & {
|
|
167
|
+
type: RoleType;
|
|
168
|
+
};
|
|
169
|
+
interface Permission extends Resource {
|
|
170
|
+
readonly type: PermissionType;
|
|
171
|
+
can_create: boolean;
|
|
172
|
+
can_read: boolean;
|
|
173
|
+
can_update: boolean;
|
|
174
|
+
can_destroy: boolean;
|
|
175
|
+
subject: string;
|
|
176
|
+
restrictions: Record<string, any>;
|
|
177
|
+
organization?: Organization | null;
|
|
178
|
+
role?: Role | null;
|
|
179
|
+
versions?: Version[] | null;
|
|
180
|
+
}
|
|
181
|
+
interface PermissionCreate extends ResourceCreate {
|
|
182
|
+
can_create: boolean;
|
|
183
|
+
can_read: boolean;
|
|
184
|
+
can_update: boolean;
|
|
185
|
+
can_destroy: boolean;
|
|
186
|
+
subject: string;
|
|
187
|
+
role: RoleRel$4;
|
|
188
|
+
}
|
|
189
|
+
interface PermissionUpdate extends ResourceUpdate {
|
|
190
|
+
can_create?: boolean | null;
|
|
191
|
+
can_read?: boolean | null;
|
|
192
|
+
can_update?: boolean | null;
|
|
193
|
+
can_destroy?: boolean | null;
|
|
194
|
+
}
|
|
195
|
+
declare class Permissions extends ApiResource<Permission> {
|
|
196
|
+
static readonly TYPE: PermissionType;
|
|
197
|
+
create(resource: PermissionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Permission>;
|
|
198
|
+
update(resource: PermissionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Permission>;
|
|
199
|
+
organization(permissionId: string | Permission, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
|
|
200
|
+
role(permissionId: string | Permission, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
|
|
201
|
+
versions(permissionId: string | Permission, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
202
|
+
isPermission(resource: any): resource is Permission;
|
|
203
|
+
relationship(id: string | ResourceId | null): PermissionRel;
|
|
204
|
+
type(): PermissionType;
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
type RoleType = 'roles';
|
|
208
|
+
type RoleRel$3 = ResourceRel & {
|
|
209
|
+
type: RoleType;
|
|
210
|
+
};
|
|
211
|
+
type OrganizationRel$4 = ResourceRel & {
|
|
212
|
+
type: OrganizationType;
|
|
213
|
+
};
|
|
214
|
+
interface Role extends Resource {
|
|
215
|
+
readonly type: RoleType;
|
|
216
|
+
name: string;
|
|
217
|
+
kind: string;
|
|
218
|
+
organization?: Organization | null;
|
|
219
|
+
permissions?: Permission[] | null;
|
|
220
|
+
memberships?: Membership[] | null;
|
|
221
|
+
api_credentials?: ApiCredential[] | null;
|
|
222
|
+
versions?: Version[] | null;
|
|
223
|
+
}
|
|
224
|
+
interface RoleCreate extends ResourceCreate {
|
|
225
|
+
name: string;
|
|
226
|
+
organization: OrganizationRel$4;
|
|
227
|
+
}
|
|
228
|
+
interface RoleUpdate extends ResourceUpdate {
|
|
229
|
+
name?: string | null;
|
|
230
|
+
}
|
|
231
|
+
declare class Roles extends ApiResource<Role> {
|
|
232
|
+
static readonly TYPE: RoleType;
|
|
233
|
+
create(resource: RoleCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
|
|
234
|
+
update(resource: RoleUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
|
|
235
|
+
organization(roleId: string | Role, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
|
|
236
|
+
permissions(roleId: string | Role, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Permission>>;
|
|
237
|
+
memberships(roleId: string | Role, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Membership>>;
|
|
238
|
+
api_credentials(roleId: string | Role, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ApiCredential>>;
|
|
239
|
+
versions(roleId: string | Role, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
240
|
+
isRole(resource: any): resource is Role;
|
|
241
|
+
relationship(id: string | ResourceId | null): RoleRel$3;
|
|
242
|
+
type(): RoleType;
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
type ApplicationMembershipType = 'application_memberships';
|
|
246
|
+
type ApplicationMembershipRel$1 = ResourceRel & {
|
|
247
|
+
type: ApplicationMembershipType;
|
|
248
|
+
};
|
|
249
|
+
type ApiCredentialRel$1 = ResourceRel & {
|
|
250
|
+
type: ApiCredentialType;
|
|
251
|
+
};
|
|
252
|
+
type MembershipRel$1 = ResourceRel & {
|
|
253
|
+
type: MembershipType;
|
|
254
|
+
};
|
|
255
|
+
type OrganizationRel$3 = ResourceRel & {
|
|
256
|
+
type: OrganizationType;
|
|
257
|
+
};
|
|
258
|
+
type RoleRel$2 = ResourceRel & {
|
|
259
|
+
type: RoleType;
|
|
260
|
+
};
|
|
261
|
+
interface ApplicationMembership extends Resource {
|
|
262
|
+
readonly type: ApplicationMembershipType;
|
|
263
|
+
filters?: Record<string, any> | null;
|
|
264
|
+
api_credential?: ApiCredential | null;
|
|
265
|
+
membership?: Membership | null;
|
|
266
|
+
organization?: Organization | null;
|
|
267
|
+
role?: Role | null;
|
|
268
|
+
}
|
|
269
|
+
interface ApplicationMembershipCreate extends ResourceCreate {
|
|
270
|
+
filters?: Record<string, any> | null;
|
|
271
|
+
api_credential: ApiCredentialRel$1;
|
|
272
|
+
membership: MembershipRel$1;
|
|
273
|
+
organization: OrganizationRel$3;
|
|
274
|
+
role: RoleRel$2;
|
|
275
|
+
}
|
|
276
|
+
interface ApplicationMembershipUpdate extends ResourceUpdate {
|
|
277
|
+
filters?: Record<string, any> | null;
|
|
278
|
+
role?: RoleRel$2 | null;
|
|
279
|
+
}
|
|
280
|
+
declare class ApplicationMemberships extends ApiResource<ApplicationMembership> {
|
|
281
|
+
static readonly TYPE: ApplicationMembershipType;
|
|
282
|
+
create(resource: ApplicationMembershipCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApplicationMembership>;
|
|
283
|
+
update(resource: ApplicationMembershipUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApplicationMembership>;
|
|
284
|
+
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
285
|
+
api_credential(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApiCredential>;
|
|
286
|
+
membership(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Membership>;
|
|
287
|
+
organization(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
|
|
288
|
+
role(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
|
|
289
|
+
isApplicationMembership(resource: any): resource is ApplicationMembership;
|
|
290
|
+
relationship(id: string | ResourceId | null): ApplicationMembershipRel$1;
|
|
291
|
+
type(): ApplicationMembershipType;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
type MembershipType = 'memberships';
|
|
295
|
+
type MembershipRel = ResourceRel & {
|
|
296
|
+
type: MembershipType;
|
|
297
|
+
};
|
|
298
|
+
type OrganizationRel$2 = ResourceRel & {
|
|
299
|
+
type: OrganizationType;
|
|
300
|
+
};
|
|
301
|
+
type RoleRel$1 = ResourceRel & {
|
|
302
|
+
type: RoleType;
|
|
303
|
+
};
|
|
304
|
+
type ApplicationMembershipRel = ResourceRel & {
|
|
305
|
+
type: ApplicationMembershipType;
|
|
306
|
+
};
|
|
307
|
+
interface Membership extends Resource {
|
|
308
|
+
readonly type: MembershipType;
|
|
309
|
+
user_email: string;
|
|
310
|
+
user_first_name: string;
|
|
311
|
+
user_last_name: string;
|
|
312
|
+
status: 'pending' | 'active';
|
|
313
|
+
owner: boolean;
|
|
314
|
+
organization?: Organization | null;
|
|
315
|
+
role?: Role | null;
|
|
316
|
+
application_memberships?: ApplicationMembership[] | null;
|
|
317
|
+
versions?: Version[] | null;
|
|
318
|
+
}
|
|
319
|
+
interface MembershipCreate extends ResourceCreate {
|
|
320
|
+
user_email: string;
|
|
321
|
+
organization: OrganizationRel$2;
|
|
322
|
+
role: RoleRel$1;
|
|
323
|
+
application_memberships?: ApplicationMembershipRel[] | null;
|
|
324
|
+
}
|
|
325
|
+
interface MembershipUpdate extends ResourceUpdate {
|
|
326
|
+
role?: RoleRel$1 | null;
|
|
327
|
+
application_memberships?: ApplicationMembershipRel[] | null;
|
|
328
|
+
}
|
|
329
|
+
declare class Memberships extends ApiResource<Membership> {
|
|
330
|
+
static readonly TYPE: MembershipType;
|
|
331
|
+
create(resource: MembershipCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Membership>;
|
|
332
|
+
update(resource: MembershipUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Membership>;
|
|
333
|
+
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
334
|
+
resend(membershipId: string | Membership, options?: ResourcesConfig): Promise<void>;
|
|
335
|
+
organization(membershipId: string | Membership, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
|
|
336
|
+
role(membershipId: string | Membership, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
|
|
337
|
+
application_memberships(membershipId: string | Membership, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ApplicationMembership>>;
|
|
338
|
+
versions(membershipId: string | Membership, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
|
|
339
|
+
isMembership(resource: any): resource is Membership;
|
|
340
|
+
relationship(id: string | ResourceId | null): MembershipRel;
|
|
341
|
+
type(): MembershipType;
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
type OrganizationType = 'organizations';
|
|
345
|
+
type OrganizationRel$1 = ResourceRel & {
|
|
346
|
+
type: OrganizationType;
|
|
347
|
+
};
|
|
348
|
+
interface Organization extends Resource {
|
|
349
|
+
readonly type: OrganizationType;
|
|
350
|
+
name: string;
|
|
351
|
+
slug: string;
|
|
352
|
+
domain: string;
|
|
353
|
+
config?: Record<string, any> | null;
|
|
354
|
+
support_phone?: string | null;
|
|
355
|
+
support_email?: string | null;
|
|
356
|
+
logo_url?: string | null;
|
|
357
|
+
favicon_url?: string | null;
|
|
358
|
+
primary_color?: string | null;
|
|
359
|
+
contrast_color?: string | null;
|
|
360
|
+
gtm_id?: string | null;
|
|
361
|
+
gtm_id_test?: string | null;
|
|
362
|
+
discount_disabled?: boolean | null;
|
|
363
|
+
account_disabled?: boolean | null;
|
|
364
|
+
acceptance_disabled?: boolean | null;
|
|
365
|
+
max_concurrent_promotions: number;
|
|
366
|
+
max_concurrent_imports: number;
|
|
367
|
+
region?: string | null;
|
|
368
|
+
can_switch_live: boolean;
|
|
369
|
+
subscription_info: Record<string, any>;
|
|
370
|
+
memberships?: Membership[] | null;
|
|
371
|
+
roles?: Role[] | null;
|
|
372
|
+
permissions?: Permission[] | null;
|
|
373
|
+
api_credentials?: ApiCredential[] | null;
|
|
374
|
+
}
|
|
375
|
+
interface OrganizationCreate extends ResourceCreate {
|
|
376
|
+
name: string;
|
|
377
|
+
config?: Record<string, any> | null;
|
|
378
|
+
support_phone?: string | null;
|
|
379
|
+
support_email?: string | null;
|
|
380
|
+
logo_url?: string | null;
|
|
381
|
+
favicon_url?: string | null;
|
|
382
|
+
primary_color?: string | null;
|
|
383
|
+
contrast_color?: string | null;
|
|
384
|
+
gtm_id?: string | null;
|
|
385
|
+
gtm_id_test?: string | null;
|
|
386
|
+
discount_disabled?: boolean | null;
|
|
387
|
+
account_disabled?: boolean | null;
|
|
388
|
+
acceptance_disabled?: boolean | null;
|
|
389
|
+
region?: string | null;
|
|
390
|
+
}
|
|
391
|
+
interface OrganizationUpdate extends ResourceUpdate {
|
|
392
|
+
name?: string | null;
|
|
393
|
+
config?: Record<string, any> | null;
|
|
394
|
+
support_phone?: string | null;
|
|
395
|
+
support_email?: string | null;
|
|
396
|
+
logo_url?: string | null;
|
|
397
|
+
favicon_url?: string | null;
|
|
398
|
+
primary_color?: string | null;
|
|
399
|
+
contrast_color?: string | null;
|
|
400
|
+
gtm_id?: string | null;
|
|
401
|
+
gtm_id_test?: string | null;
|
|
402
|
+
discount_disabled?: boolean | null;
|
|
403
|
+
account_disabled?: boolean | null;
|
|
404
|
+
acceptance_disabled?: boolean | null;
|
|
405
|
+
}
|
|
406
|
+
declare class Organizations extends ApiResource<Organization> {
|
|
407
|
+
static readonly TYPE: OrganizationType;
|
|
408
|
+
create(resource: OrganizationCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
|
|
409
|
+
update(resource: OrganizationUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
|
|
410
|
+
transfer_ownership(organizationId: string | Organization, payload: TransferOwnershipDataType, options?: ResourcesConfig): Promise<void>;
|
|
411
|
+
memberships(organizationId: string | Organization, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Membership>>;
|
|
412
|
+
roles(organizationId: string | Organization, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Role>>;
|
|
413
|
+
permissions(organizationId: string | Organization, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Permission>>;
|
|
414
|
+
api_credentials(organizationId: string | Organization, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ApiCredential>>;
|
|
415
|
+
isOrganization(resource: any): resource is Organization;
|
|
416
|
+
relationship(id: string | ResourceId | null): OrganizationRel$1;
|
|
417
|
+
type(): OrganizationType;
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
type TransferOwnershipDataType = {
|
|
421
|
+
new_owner_email: string;
|
|
422
|
+
};
|
|
423
|
+
|
|
424
|
+
type ApiCredentialType = 'api_credentials';
|
|
425
|
+
type ApiCredentialRel = ResourceRel & {
|
|
426
|
+
type: ApiCredentialType;
|
|
427
|
+
};
|
|
428
|
+
type OrganizationRel = ResourceRel & {
|
|
429
|
+
type: OrganizationType;
|
|
430
|
+
};
|
|
431
|
+
type RoleRel = ResourceRel & {
|
|
432
|
+
type: RoleType;
|
|
433
|
+
};
|
|
434
|
+
interface ApiCredential extends Resource {
|
|
435
|
+
readonly type: ApiCredentialType;
|
|
436
|
+
name: string;
|
|
437
|
+
kind: string;
|
|
438
|
+
confidential: boolean;
|
|
439
|
+
redirect_uri?: string | null;
|
|
440
|
+
client_id: string;
|
|
441
|
+
client_secret: string;
|
|
442
|
+
scopes: string;
|
|
443
|
+
expires_in?: number | null;
|
|
444
|
+
mode?: string | null;
|
|
445
|
+
custom?: boolean | null;
|
|
446
|
+
organization?: Organization | null;
|
|
447
|
+
role?: Role | null;
|
|
448
|
+
}
|
|
449
|
+
interface ApiCredentialCreate extends ResourceCreate {
|
|
450
|
+
name: string;
|
|
451
|
+
kind: string;
|
|
452
|
+
redirect_uri?: string | null;
|
|
453
|
+
expires_in?: number | null;
|
|
454
|
+
mode?: string | null;
|
|
455
|
+
custom?: boolean | null;
|
|
456
|
+
organization: OrganizationRel;
|
|
457
|
+
role?: RoleRel | null;
|
|
458
|
+
}
|
|
459
|
+
interface ApiCredentialUpdate extends ResourceUpdate {
|
|
460
|
+
name?: string | null;
|
|
461
|
+
redirect_uri?: string | null;
|
|
462
|
+
expires_in?: number | null;
|
|
463
|
+
role?: RoleRel | null;
|
|
464
|
+
}
|
|
465
|
+
declare class ApiCredentials extends ApiResource<ApiCredential> {
|
|
466
|
+
static readonly TYPE: ApiCredentialType;
|
|
467
|
+
create(resource: ApiCredentialCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApiCredential>;
|
|
468
|
+
update(resource: ApiCredentialUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApiCredential>;
|
|
469
|
+
delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
|
|
470
|
+
organization(apiCredentialId: string | ApiCredential, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
|
|
471
|
+
role(apiCredentialId: string | ApiCredential, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
|
|
472
|
+
isApiCredential(resource: any): resource is ApiCredential;
|
|
473
|
+
relationship(id: string | ResourceId | null): ApiCredentialRel;
|
|
474
|
+
type(): ApiCredentialType;
|
|
475
|
+
}
|
|
476
|
+
|
|
477
|
+
type UserType = 'user';
|
|
478
|
+
type UserRel = ResourceRel & {
|
|
479
|
+
type: UserType;
|
|
480
|
+
};
|
|
481
|
+
interface User extends Resource {
|
|
482
|
+
readonly type: UserType;
|
|
483
|
+
email: string;
|
|
484
|
+
first_name: string;
|
|
485
|
+
last_name: string;
|
|
486
|
+
time_zone?: string | null;
|
|
487
|
+
otp_required_for_login: boolean;
|
|
488
|
+
}
|
|
489
|
+
interface UserUpdate extends ResourceUpdate {
|
|
490
|
+
email?: string | null;
|
|
491
|
+
first_name?: string | null;
|
|
492
|
+
last_name?: string | null;
|
|
493
|
+
time_zone?: string | null;
|
|
494
|
+
}
|
|
495
|
+
declare class Users extends ApiSingleton<User> {
|
|
496
|
+
static readonly TYPE: UserType;
|
|
497
|
+
update(resource: UserUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<User>;
|
|
498
|
+
isUser(resource: any): resource is User;
|
|
499
|
+
relationship(id: string | ResourceId | null): UserRel;
|
|
500
|
+
type(): UserType;
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
type ResourceTypeLock = 'api_credentials' | 'application_memberships' | 'memberships' | 'organizations' | 'permissions' | 'roles' | 'user' | 'versions';
|
|
504
|
+
|
|
505
|
+
declare enum ErrorType {
|
|
506
|
+
CLIENT = "client",
|
|
507
|
+
REQUEST = "request",
|
|
508
|
+
RESPONSE = "response",
|
|
509
|
+
CANCEL = "cancel",
|
|
510
|
+
PARSE = "parse",
|
|
511
|
+
GENERIC = "generic"
|
|
512
|
+
}
|
|
513
|
+
declare class SdkError extends Error {
|
|
514
|
+
static NAME: string;
|
|
515
|
+
static isSdkError(error: any): error is SdkError;
|
|
516
|
+
type: ErrorType;
|
|
517
|
+
code?: string;
|
|
518
|
+
source?: Error;
|
|
519
|
+
request?: any;
|
|
520
|
+
constructor(error: {
|
|
521
|
+
message: string;
|
|
522
|
+
type?: ErrorType;
|
|
523
|
+
});
|
|
524
|
+
}
|
|
525
|
+
declare class ApiError extends SdkError {
|
|
526
|
+
static NAME: string;
|
|
527
|
+
static isApiError(error: any): error is ApiError;
|
|
528
|
+
errors: any[];
|
|
529
|
+
status?: number;
|
|
530
|
+
statusText?: string;
|
|
531
|
+
constructor(error: SdkError);
|
|
532
|
+
first(): any;
|
|
533
|
+
}
|
|
534
|
+
|
|
535
|
+
type SdkConfig = {};
|
|
536
|
+
type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
|
|
537
|
+
type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
|
|
538
|
+
declare class CommerceLayerProvisioningClient {
|
|
539
|
+
#private;
|
|
540
|
+
readonly openApiSchemaVersion = "1.0.4";
|
|
541
|
+
api_credentials: ApiCredentials;
|
|
542
|
+
application_memberships: ApplicationMemberships;
|
|
543
|
+
memberships: Memberships;
|
|
544
|
+
organizations: Organizations;
|
|
545
|
+
permissions: Permissions;
|
|
546
|
+
roles: Roles;
|
|
547
|
+
user: Users;
|
|
548
|
+
versions: Versions;
|
|
549
|
+
constructor(config: CommerceLayerInitConfig);
|
|
550
|
+
private localConfig;
|
|
551
|
+
config(config: CommerceLayerConfig): this;
|
|
552
|
+
resources(): readonly string[];
|
|
553
|
+
singletons(): readonly string[];
|
|
554
|
+
isSingleton(resource: ResourceTypeLock): boolean;
|
|
555
|
+
isApiError(error: any): error is ApiError;
|
|
556
|
+
addRequestInterceptor(onFulfilled?: RequestInterceptor, onRejected?: ErrorInterceptor): number;
|
|
557
|
+
addResponseInterceptor(onFulfilled?: ResponseInterceptor, onRejected?: ErrorInterceptor): number;
|
|
558
|
+
removeInterceptor(type: InterceptorType, id: number): void;
|
|
559
|
+
addRawResponseReader(options?: {
|
|
560
|
+
headers: boolean;
|
|
561
|
+
}): RawResponseReader;
|
|
562
|
+
removeRawResponseReader(reader: number | RawResponseReader): void;
|
|
563
|
+
}
|
|
564
|
+
declare const CommerceLayerProvisioning: (config: CommerceLayerInitConfig) => CommerceLayerProvisioningClient;
|
|
565
|
+
|
|
566
|
+
declare const CommerceLayerProvisioningStatic: {
|
|
567
|
+
resources: (sort?: boolean) => readonly string[];
|
|
568
|
+
singletons: (sort?: boolean) => readonly string[];
|
|
569
|
+
isSingleton: (resource: ResourceTypeLock) => boolean;
|
|
570
|
+
isSdkError: (error: unknown) => error is SdkError;
|
|
571
|
+
isApiError: (error: unknown) => error is ApiError;
|
|
572
|
+
init: (config: CommerceLayerInitConfig) => CommerceLayerProvisioningClient;
|
|
573
|
+
readonly schemaVersion: string;
|
|
574
|
+
};
|
|
575
|
+
|
|
576
|
+
export { type ApiCredential, type ApiCredentialCreate, type ApiCredentialUpdate, ApiError, type ApplicationMembership, type ApplicationMembershipCreate, type ApplicationMembershipUpdate, CommerceLayerProvisioning, CommerceLayerProvisioningClient, CommerceLayerProvisioningStatic, type ErrorObj, ErrorType, type HeadersObj, type Membership, type MembershipCreate, type MembershipUpdate, type Organization, type OrganizationCreate, type OrganizationUpdate, type Permission, type PermissionCreate, type PermissionUpdate, type QueryParams, type QueryParamsList, type QueryParamsRetrieve, type RequestObj, type ResponseObj, type Role, type RoleCreate, type RoleUpdate, SdkError, type User, type UserUpdate, type Version, CommerceLayerProvisioning as default };
|