@commercelayer/provisioning-sdk 1.0.4 → 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.
Files changed (99) hide show
  1. package/lib/index.d.mts +576 -0
  2. package/lib/index.d.ts +576 -0
  3. package/lib/index.js +1 -0
  4. package/lib/index.mjs +1 -0
  5. package/package.json +18 -19
  6. package/lib/cjs/api.d.ts +0 -43
  7. package/lib/cjs/api.js +0 -45
  8. package/lib/cjs/client.d.ts +0 -42
  9. package/lib/cjs/client.js +0 -149
  10. package/lib/cjs/commercelayer.d.ts +0 -39
  11. package/lib/cjs/commercelayer.js +0 -130
  12. package/lib/cjs/common.d.ts +0 -5
  13. package/lib/cjs/common.js +0 -12
  14. package/lib/cjs/config.d.ts +0 -15
  15. package/lib/cjs/config.js +0 -19
  16. package/lib/cjs/debug.d.ts +0 -3
  17. package/lib/cjs/debug.js +0 -38
  18. package/lib/cjs/error.d.ts +0 -31
  19. package/lib/cjs/error.js +0 -77
  20. package/lib/cjs/index.d.ts +0 -7
  21. package/lib/cjs/index.js +0 -13
  22. package/lib/cjs/interceptor.d.ts +0 -25
  23. package/lib/cjs/interceptor.js +0 -2
  24. package/lib/cjs/jsonapi.d.ts +0 -6
  25. package/lib/cjs/jsonapi.js +0 -94
  26. package/lib/cjs/model.d.ts +0 -11
  27. package/lib/cjs/model.js +0 -3
  28. package/lib/cjs/query.d.ts +0 -17
  29. package/lib/cjs/query.js +0 -52
  30. package/lib/cjs/resource.d.ts +0 -86
  31. package/lib/cjs/resource.js +0 -194
  32. package/lib/cjs/resources/api_credentials.d.ts +0 -59
  33. package/lib/cjs/resources/api_credentials.js +0 -33
  34. package/lib/cjs/resources/application_memberships.d.ts +0 -57
  35. package/lib/cjs/resources/application_memberships.js +0 -41
  36. package/lib/cjs/resources/memberships.d.ts +0 -58
  37. package/lib/cjs/resources/memberships.js +0 -45
  38. package/lib/cjs/resources/organizations.d.ts +0 -84
  39. package/lib/cjs/resources/organizations.js +0 -42
  40. package/lib/cjs/resources/permissions.d.ts +0 -52
  41. package/lib/cjs/resources/permissions.js +0 -34
  42. package/lib/cjs/resources/roles.d.ts +0 -47
  43. package/lib/cjs/resources/roles.js +0 -42
  44. package/lib/cjs/resources/user.d.ts +0 -29
  45. package/lib/cjs/resources/user.js +0 -20
  46. package/lib/cjs/resources/versions.d.ts +0 -22
  47. package/lib/cjs/resources/versions.js +0 -16
  48. package/lib/cjs/static.d.ts +0 -12
  49. package/lib/cjs/static.js +0 -51
  50. package/lib/cjs/util.d.ts +0 -9
  51. package/lib/cjs/util.js +0 -16
  52. package/lib/esm/api.d.ts +0 -43
  53. package/lib/esm/api.js +0 -31
  54. package/lib/esm/client.d.ts +0 -42
  55. package/lib/esm/client.js +0 -144
  56. package/lib/esm/commercelayer.d.ts +0 -39
  57. package/lib/esm/commercelayer.js +0 -101
  58. package/lib/esm/common.d.ts +0 -5
  59. package/lib/esm/common.js +0 -8
  60. package/lib/esm/config.d.ts +0 -15
  61. package/lib/esm/config.js +0 -17
  62. package/lib/esm/debug.d.ts +0 -3
  63. package/lib/esm/debug.js +0 -36
  64. package/lib/esm/error.d.ts +0 -31
  65. package/lib/esm/error.js +0 -69
  66. package/lib/esm/index.d.ts +0 -7
  67. package/lib/esm/index.js +0 -4
  68. package/lib/esm/interceptor.d.ts +0 -25
  69. package/lib/esm/interceptor.js +0 -1
  70. package/lib/esm/jsonapi.d.ts +0 -6
  71. package/lib/esm/jsonapi.js +0 -87
  72. package/lib/esm/model.d.ts +0 -11
  73. package/lib/esm/model.js +0 -2
  74. package/lib/esm/query.d.ts +0 -17
  75. package/lib/esm/query.js +0 -45
  76. package/lib/esm/resource.d.ts +0 -86
  77. package/lib/esm/resource.js +0 -187
  78. package/lib/esm/resources/api_credentials.d.ts +0 -59
  79. package/lib/esm/resources/api_credentials.js +0 -31
  80. package/lib/esm/resources/application_memberships.d.ts +0 -57
  81. package/lib/esm/resources/application_memberships.js +0 -39
  82. package/lib/esm/resources/memberships.d.ts +0 -58
  83. package/lib/esm/resources/memberships.js +0 -43
  84. package/lib/esm/resources/organizations.d.ts +0 -84
  85. package/lib/esm/resources/organizations.js +0 -40
  86. package/lib/esm/resources/permissions.d.ts +0 -52
  87. package/lib/esm/resources/permissions.js +0 -32
  88. package/lib/esm/resources/roles.d.ts +0 -47
  89. package/lib/esm/resources/roles.js +0 -40
  90. package/lib/esm/resources/user.d.ts +0 -29
  91. package/lib/esm/resources/user.js +0 -18
  92. package/lib/esm/resources/versions.d.ts +0 -22
  93. package/lib/esm/resources/versions.js +0 -14
  94. package/lib/esm/static.d.ts +0 -12
  95. package/lib/esm/static.js +0 -25
  96. package/lib/esm/util.d.ts +0 -9
  97. package/lib/esm/util.js +0 -37
  98. package/lib/tsconfig.esm.tsbuildinfo +0 -1
  99. package/lib/tsconfig.tsbuildinfo +0 -1
@@ -1,33 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const resource_1 = require("../resource");
4
- class ApiCredentials extends resource_1.ApiResource {
5
- async create(resource, params, options) {
6
- return this.resources.create({ ...resource, type: ApiCredentials.TYPE }, params, options);
7
- }
8
- async update(resource, params, options) {
9
- return this.resources.update({ ...resource, type: ApiCredentials.TYPE }, params, options);
10
- }
11
- async delete(id, options) {
12
- await this.resources.delete((typeof id === 'string') ? { id, type: ApiCredentials.TYPE } : id, options);
13
- }
14
- async organization(apiCredentialId, params, options) {
15
- const _apiCredentialId = apiCredentialId.id || apiCredentialId;
16
- return this.resources.fetch({ type: 'organizations' }, `api_credentials/${_apiCredentialId}/organization`, params, options);
17
- }
18
- async role(apiCredentialId, params, options) {
19
- const _apiCredentialId = apiCredentialId.id || apiCredentialId;
20
- return this.resources.fetch({ type: 'roles' }, `api_credentials/${_apiCredentialId}/role`, params, options);
21
- }
22
- isApiCredential(resource) {
23
- return resource.type && (resource.type === ApiCredentials.TYPE);
24
- }
25
- relationship(id) {
26
- return ((id === null) || (typeof id === 'string')) ? { id, type: ApiCredentials.TYPE } : { id: id.id, type: ApiCredentials.TYPE };
27
- }
28
- type() {
29
- return ApiCredentials.TYPE;
30
- }
31
- }
32
- ApiCredentials.TYPE = 'api_credentials';
33
- exports.default = ApiCredentials;
@@ -1,57 +0,0 @@
1
- import { ApiResource } from '../resource';
2
- import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
3
- import type { QueryParamsRetrieve } from '../query';
4
- import type { ApiCredential, ApiCredentialType } from './api_credentials';
5
- import type { Membership, MembershipType } from './memberships';
6
- import type { Organization, OrganizationType } from './organizations';
7
- import type { Role, RoleType } from './roles';
8
- type ApplicationMembershipType = 'application_memberships';
9
- type ApplicationMembershipRel = ResourceRel & {
10
- type: ApplicationMembershipType;
11
- };
12
- type ApiCredentialRel = ResourceRel & {
13
- type: ApiCredentialType;
14
- };
15
- type MembershipRel = ResourceRel & {
16
- type: MembershipType;
17
- };
18
- type OrganizationRel = ResourceRel & {
19
- type: OrganizationType;
20
- };
21
- type RoleRel = ResourceRel & {
22
- type: RoleType;
23
- };
24
- interface ApplicationMembership extends Resource {
25
- readonly type: ApplicationMembershipType;
26
- filters?: Record<string, any> | null;
27
- api_credential?: ApiCredential | null;
28
- membership?: Membership | null;
29
- organization?: Organization | null;
30
- role?: Role | null;
31
- }
32
- interface ApplicationMembershipCreate extends ResourceCreate {
33
- filters?: Record<string, any> | null;
34
- api_credential: ApiCredentialRel;
35
- membership: MembershipRel;
36
- organization: OrganizationRel;
37
- role: RoleRel;
38
- }
39
- interface ApplicationMembershipUpdate extends ResourceUpdate {
40
- filters?: Record<string, any> | null;
41
- role?: RoleRel | null;
42
- }
43
- declare class ApplicationMemberships extends ApiResource<ApplicationMembership> {
44
- static readonly TYPE: ApplicationMembershipType;
45
- create(resource: ApplicationMembershipCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApplicationMembership>;
46
- update(resource: ApplicationMembershipUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApplicationMembership>;
47
- delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
48
- api_credential(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApiCredential>;
49
- membership(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Membership>;
50
- organization(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
51
- role(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
52
- isApplicationMembership(resource: any): resource is ApplicationMembership;
53
- relationship(id: string | ResourceId | null): ApplicationMembershipRel;
54
- type(): ApplicationMembershipType;
55
- }
56
- export default ApplicationMemberships;
57
- export type { ApplicationMembership, ApplicationMembershipCreate, ApplicationMembershipUpdate, ApplicationMembershipType };
@@ -1,41 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const resource_1 = require("../resource");
4
- class ApplicationMemberships extends resource_1.ApiResource {
5
- async create(resource, params, options) {
6
- return this.resources.create({ ...resource, type: ApplicationMemberships.TYPE }, params, options);
7
- }
8
- async update(resource, params, options) {
9
- return this.resources.update({ ...resource, type: ApplicationMemberships.TYPE }, params, options);
10
- }
11
- async delete(id, options) {
12
- await this.resources.delete((typeof id === 'string') ? { id, type: ApplicationMemberships.TYPE } : id, options);
13
- }
14
- async api_credential(applicationMembershipId, params, options) {
15
- const _applicationMembershipId = applicationMembershipId.id || applicationMembershipId;
16
- return this.resources.fetch({ type: 'api_credentials' }, `application_memberships/${_applicationMembershipId}/api_credential`, params, options);
17
- }
18
- async membership(applicationMembershipId, params, options) {
19
- const _applicationMembershipId = applicationMembershipId.id || applicationMembershipId;
20
- return this.resources.fetch({ type: 'memberships' }, `application_memberships/${_applicationMembershipId}/membership`, params, options);
21
- }
22
- async organization(applicationMembershipId, params, options) {
23
- const _applicationMembershipId = applicationMembershipId.id || applicationMembershipId;
24
- return this.resources.fetch({ type: 'organizations' }, `application_memberships/${_applicationMembershipId}/organization`, params, options);
25
- }
26
- async role(applicationMembershipId, params, options) {
27
- const _applicationMembershipId = applicationMembershipId.id || applicationMembershipId;
28
- return this.resources.fetch({ type: 'roles' }, `application_memberships/${_applicationMembershipId}/role`, params, options);
29
- }
30
- isApplicationMembership(resource) {
31
- return resource.type && (resource.type === ApplicationMemberships.TYPE);
32
- }
33
- relationship(id) {
34
- return ((id === null) || (typeof id === 'string')) ? { id, type: ApplicationMemberships.TYPE } : { id: id.id, type: ApplicationMemberships.TYPE };
35
- }
36
- type() {
37
- return ApplicationMemberships.TYPE;
38
- }
39
- }
40
- ApplicationMemberships.TYPE = 'application_memberships';
41
- exports.default = ApplicationMemberships;
@@ -1,58 +0,0 @@
1
- import { ApiResource } from '../resource';
2
- import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
3
- import type { QueryParamsRetrieve, QueryParamsList } from '../query';
4
- import type { Organization, OrganizationType } from './organizations';
5
- import type { Role, RoleType } from './roles';
6
- import type { ApplicationMembership, ApplicationMembershipType } from './application_memberships';
7
- import type { Version } from './versions';
8
- type MembershipType = 'memberships';
9
- type MembershipRel = ResourceRel & {
10
- type: MembershipType;
11
- };
12
- type OrganizationRel = ResourceRel & {
13
- type: OrganizationType;
14
- };
15
- type RoleRel = ResourceRel & {
16
- type: RoleType;
17
- };
18
- type ApplicationMembershipRel = ResourceRel & {
19
- type: ApplicationMembershipType;
20
- };
21
- interface Membership extends Resource {
22
- readonly type: MembershipType;
23
- user_email: string;
24
- user_first_name: string;
25
- user_last_name: string;
26
- status: 'pending' | 'active';
27
- owner: boolean;
28
- organization?: Organization | null;
29
- role?: Role | null;
30
- application_memberships?: ApplicationMembership[] | null;
31
- versions?: Version[] | null;
32
- }
33
- interface MembershipCreate extends ResourceCreate {
34
- user_email: string;
35
- organization: OrganizationRel;
36
- role: RoleRel;
37
- application_memberships?: ApplicationMembershipRel[] | null;
38
- }
39
- interface MembershipUpdate extends ResourceUpdate {
40
- role?: RoleRel | null;
41
- application_memberships?: ApplicationMembershipRel[] | null;
42
- }
43
- declare class Memberships extends ApiResource<Membership> {
44
- static readonly TYPE: MembershipType;
45
- create(resource: MembershipCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Membership>;
46
- update(resource: MembershipUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Membership>;
47
- delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
48
- resend(membershipId: string | Membership, options?: ResourcesConfig): Promise<void>;
49
- organization(membershipId: string | Membership, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
50
- role(membershipId: string | Membership, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
51
- application_memberships(membershipId: string | Membership, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ApplicationMembership>>;
52
- versions(membershipId: string | Membership, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
53
- isMembership(resource: any): resource is Membership;
54
- relationship(id: string | ResourceId | null): MembershipRel;
55
- type(): MembershipType;
56
- }
57
- export default Memberships;
58
- export type { Membership, MembershipCreate, MembershipUpdate, MembershipType };
@@ -1,45 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const resource_1 = require("../resource");
4
- class Memberships extends resource_1.ApiResource {
5
- async create(resource, params, options) {
6
- return this.resources.create({ ...resource, type: Memberships.TYPE }, params, options);
7
- }
8
- async update(resource, params, options) {
9
- return this.resources.update({ ...resource, type: Memberships.TYPE }, params, options);
10
- }
11
- async delete(id, options) {
12
- await this.resources.delete((typeof id === 'string') ? { id, type: Memberships.TYPE } : id, options);
13
- }
14
- async resend(membershipId, options) {
15
- const _membershipId = membershipId.id || membershipId;
16
- await this.resources.action('post', `memberships/${_membershipId}/resend`, {}, options);
17
- }
18
- async organization(membershipId, params, options) {
19
- const _membershipId = membershipId.id || membershipId;
20
- return this.resources.fetch({ type: 'organizations' }, `memberships/${_membershipId}/organization`, params, options);
21
- }
22
- async role(membershipId, params, options) {
23
- const _membershipId = membershipId.id || membershipId;
24
- return this.resources.fetch({ type: 'roles' }, `memberships/${_membershipId}/role`, params, options);
25
- }
26
- async application_memberships(membershipId, params, options) {
27
- const _membershipId = membershipId.id || membershipId;
28
- return this.resources.fetch({ type: 'application_memberships' }, `memberships/${_membershipId}/application_memberships`, params, options);
29
- }
30
- async versions(membershipId, params, options) {
31
- const _membershipId = membershipId.id || membershipId;
32
- return this.resources.fetch({ type: 'versions' }, `memberships/${_membershipId}/versions`, params, options);
33
- }
34
- isMembership(resource) {
35
- return resource.type && (resource.type === Memberships.TYPE);
36
- }
37
- relationship(id) {
38
- return ((id === null) || (typeof id === 'string')) ? { id, type: Memberships.TYPE } : { id: id.id, type: Memberships.TYPE };
39
- }
40
- type() {
41
- return Memberships.TYPE;
42
- }
43
- }
44
- Memberships.TYPE = 'memberships';
45
- exports.default = Memberships;
@@ -1,84 +0,0 @@
1
- import { ApiResource } from '../resource';
2
- import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
3
- import type { QueryParamsRetrieve, QueryParamsList } from '../query';
4
- import type { Membership } from './memberships';
5
- import type { Role } from './roles';
6
- import type { Permission } from './permissions';
7
- import type { ApiCredential } from './api_credentials';
8
- type OrganizationType = 'organizations';
9
- type OrganizationRel = ResourceRel & {
10
- type: OrganizationType;
11
- };
12
- interface Organization extends Resource {
13
- readonly type: OrganizationType;
14
- name: string;
15
- slug: string;
16
- domain: string;
17
- support_phone?: string | null;
18
- support_email?: string | null;
19
- logo_url?: string | null;
20
- favicon_url?: string | null;
21
- primary_color?: string | null;
22
- contrast_color?: string | null;
23
- gtm_id?: string | null;
24
- gtm_id_test?: string | null;
25
- discount_disabled?: boolean | null;
26
- account_disabled?: boolean | null;
27
- acceptance_disabled?: boolean | null;
28
- max_concurrent_promotions: number;
29
- max_concurrent_imports: number;
30
- region?: string | null;
31
- can_switch_live: boolean;
32
- subscription_info: Record<string, any>;
33
- memberships?: Membership[] | null;
34
- roles?: Role[] | null;
35
- permissions?: Permission[] | null;
36
- api_credentials?: ApiCredential[] | null;
37
- }
38
- interface OrganizationCreate extends ResourceCreate {
39
- name: string;
40
- support_phone?: string | null;
41
- support_email?: string | null;
42
- logo_url?: string | null;
43
- favicon_url?: string | null;
44
- primary_color?: string | null;
45
- contrast_color?: string | null;
46
- gtm_id?: string | null;
47
- gtm_id_test?: string | null;
48
- discount_disabled?: boolean | null;
49
- account_disabled?: boolean | null;
50
- acceptance_disabled?: boolean | null;
51
- region?: string | null;
52
- }
53
- interface OrganizationUpdate extends ResourceUpdate {
54
- name?: string | null;
55
- support_phone?: string | null;
56
- support_email?: string | null;
57
- logo_url?: string | null;
58
- favicon_url?: string | null;
59
- primary_color?: string | null;
60
- contrast_color?: string | null;
61
- gtm_id?: string | null;
62
- gtm_id_test?: string | null;
63
- discount_disabled?: boolean | null;
64
- account_disabled?: boolean | null;
65
- acceptance_disabled?: boolean | null;
66
- }
67
- declare class Organizations extends ApiResource<Organization> {
68
- static readonly TYPE: OrganizationType;
69
- create(resource: OrganizationCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
70
- update(resource: OrganizationUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
71
- transfer_ownership(organizationId: string | Organization, payload: TransferOwnershipDataType, options?: ResourcesConfig): Promise<void>;
72
- memberships(organizationId: string | Organization, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Membership>>;
73
- roles(organizationId: string | Organization, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Role>>;
74
- permissions(organizationId: string | Organization, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Permission>>;
75
- api_credentials(organizationId: string | Organization, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ApiCredential>>;
76
- isOrganization(resource: any): resource is Organization;
77
- relationship(id: string | ResourceId | null): OrganizationRel;
78
- type(): OrganizationType;
79
- }
80
- export default Organizations;
81
- export type { Organization, OrganizationCreate, OrganizationUpdate, OrganizationType };
82
- export type TransferOwnershipDataType = {
83
- new_owner_email: string;
84
- };
@@ -1,42 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const resource_1 = require("../resource");
4
- class Organizations extends resource_1.ApiResource {
5
- async create(resource, params, options) {
6
- return this.resources.create({ ...resource, type: Organizations.TYPE }, params, options);
7
- }
8
- async update(resource, params, options) {
9
- return this.resources.update({ ...resource, type: Organizations.TYPE }, params, options);
10
- }
11
- async transfer_ownership(organizationId, payload, options) {
12
- const _organizationId = organizationId.id || organizationId;
13
- await this.resources.action('patch', `organizations/${_organizationId}/transfer_ownership`, { ...payload }, options);
14
- }
15
- async memberships(organizationId, params, options) {
16
- const _organizationId = organizationId.id || organizationId;
17
- return this.resources.fetch({ type: 'memberships' }, `organizations/${_organizationId}/memberships`, params, options);
18
- }
19
- async roles(organizationId, params, options) {
20
- const _organizationId = organizationId.id || organizationId;
21
- return this.resources.fetch({ type: 'roles' }, `organizations/${_organizationId}/roles`, params, options);
22
- }
23
- async permissions(organizationId, params, options) {
24
- const _organizationId = organizationId.id || organizationId;
25
- return this.resources.fetch({ type: 'permissions' }, `organizations/${_organizationId}/permissions`, params, options);
26
- }
27
- async api_credentials(organizationId, params, options) {
28
- const _organizationId = organizationId.id || organizationId;
29
- return this.resources.fetch({ type: 'api_credentials' }, `organizations/${_organizationId}/api_credentials`, params, options);
30
- }
31
- isOrganization(resource) {
32
- return resource.type && (resource.type === Organizations.TYPE);
33
- }
34
- relationship(id) {
35
- return ((id === null) || (typeof id === 'string')) ? { id, type: Organizations.TYPE } : { id: id.id, type: Organizations.TYPE };
36
- }
37
- type() {
38
- return Organizations.TYPE;
39
- }
40
- }
41
- Organizations.TYPE = 'organizations';
42
- exports.default = Organizations;
@@ -1,52 +0,0 @@
1
- import { ApiResource } from '../resource';
2
- import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
3
- import type { QueryParamsRetrieve, QueryParamsList } from '../query';
4
- import type { Organization } from './organizations';
5
- import type { Role, RoleType } from './roles';
6
- import type { Version } from './versions';
7
- type PermissionType = 'permissions';
8
- type PermissionRel = ResourceRel & {
9
- type: PermissionType;
10
- };
11
- type RoleRel = ResourceRel & {
12
- type: RoleType;
13
- };
14
- interface Permission extends Resource {
15
- readonly type: PermissionType;
16
- can_create: boolean;
17
- can_read: boolean;
18
- can_update: boolean;
19
- can_destroy: boolean;
20
- subject: string;
21
- restrictions: Record<string, any>;
22
- organization?: Organization | null;
23
- role?: Role | null;
24
- versions?: Version[] | null;
25
- }
26
- interface PermissionCreate extends ResourceCreate {
27
- can_create: boolean;
28
- can_read: boolean;
29
- can_update: boolean;
30
- can_destroy: boolean;
31
- subject: string;
32
- role: RoleRel;
33
- }
34
- interface PermissionUpdate extends ResourceUpdate {
35
- can_create?: boolean | null;
36
- can_read?: boolean | null;
37
- can_update?: boolean | null;
38
- can_destroy?: boolean | null;
39
- }
40
- declare class Permissions extends ApiResource<Permission> {
41
- static readonly TYPE: PermissionType;
42
- create(resource: PermissionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Permission>;
43
- update(resource: PermissionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Permission>;
44
- organization(permissionId: string | Permission, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
45
- role(permissionId: string | Permission, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
46
- versions(permissionId: string | Permission, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
47
- isPermission(resource: any): resource is Permission;
48
- relationship(id: string | ResourceId | null): PermissionRel;
49
- type(): PermissionType;
50
- }
51
- export default Permissions;
52
- export type { Permission, PermissionCreate, PermissionUpdate, PermissionType };
@@ -1,34 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const resource_1 = require("../resource");
4
- class Permissions extends resource_1.ApiResource {
5
- async create(resource, params, options) {
6
- return this.resources.create({ ...resource, type: Permissions.TYPE }, params, options);
7
- }
8
- async update(resource, params, options) {
9
- return this.resources.update({ ...resource, type: Permissions.TYPE }, params, options);
10
- }
11
- async organization(permissionId, params, options) {
12
- const _permissionId = permissionId.id || permissionId;
13
- return this.resources.fetch({ type: 'organizations' }, `permissions/${_permissionId}/organization`, params, options);
14
- }
15
- async role(permissionId, params, options) {
16
- const _permissionId = permissionId.id || permissionId;
17
- return this.resources.fetch({ type: 'roles' }, `permissions/${_permissionId}/role`, params, options);
18
- }
19
- async versions(permissionId, params, options) {
20
- const _permissionId = permissionId.id || permissionId;
21
- return this.resources.fetch({ type: 'versions' }, `permissions/${_permissionId}/versions`, params, options);
22
- }
23
- isPermission(resource) {
24
- return resource.type && (resource.type === Permissions.TYPE);
25
- }
26
- relationship(id) {
27
- return ((id === null) || (typeof id === 'string')) ? { id, type: Permissions.TYPE } : { id: id.id, type: Permissions.TYPE };
28
- }
29
- type() {
30
- return Permissions.TYPE;
31
- }
32
- }
33
- Permissions.TYPE = 'permissions';
34
- exports.default = Permissions;
@@ -1,47 +0,0 @@
1
- import { ApiResource } from '../resource';
2
- import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
3
- import type { QueryParamsRetrieve, QueryParamsList } from '../query';
4
- import type { Organization, OrganizationType } from './organizations';
5
- import type { Permission } from './permissions';
6
- import type { Membership } from './memberships';
7
- import type { ApiCredential } from './api_credentials';
8
- import type { Version } from './versions';
9
- type RoleType = 'roles';
10
- type RoleRel = ResourceRel & {
11
- type: RoleType;
12
- };
13
- type OrganizationRel = ResourceRel & {
14
- type: OrganizationType;
15
- };
16
- interface Role extends Resource {
17
- readonly type: RoleType;
18
- name: string;
19
- kind: string;
20
- organization?: Organization | null;
21
- permissions?: Permission[] | null;
22
- memberships?: Membership[] | null;
23
- api_credentials?: ApiCredential[] | null;
24
- versions?: Version[] | null;
25
- }
26
- interface RoleCreate extends ResourceCreate {
27
- name: string;
28
- organization: OrganizationRel;
29
- }
30
- interface RoleUpdate extends ResourceUpdate {
31
- name?: string | null;
32
- }
33
- declare class Roles extends ApiResource<Role> {
34
- static readonly TYPE: RoleType;
35
- create(resource: RoleCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
36
- update(resource: RoleUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
37
- organization(roleId: string | Role, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
38
- permissions(roleId: string | Role, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Permission>>;
39
- memberships(roleId: string | Role, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Membership>>;
40
- api_credentials(roleId: string | Role, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ApiCredential>>;
41
- versions(roleId: string | Role, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
42
- isRole(resource: any): resource is Role;
43
- relationship(id: string | ResourceId | null): RoleRel;
44
- type(): RoleType;
45
- }
46
- export default Roles;
47
- export type { Role, RoleCreate, RoleUpdate, RoleType };
@@ -1,42 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const resource_1 = require("../resource");
4
- class Roles extends resource_1.ApiResource {
5
- async create(resource, params, options) {
6
- return this.resources.create({ ...resource, type: Roles.TYPE }, params, options);
7
- }
8
- async update(resource, params, options) {
9
- return this.resources.update({ ...resource, type: Roles.TYPE }, params, options);
10
- }
11
- async organization(roleId, params, options) {
12
- const _roleId = roleId.id || roleId;
13
- return this.resources.fetch({ type: 'organizations' }, `roles/${_roleId}/organization`, params, options);
14
- }
15
- async permissions(roleId, params, options) {
16
- const _roleId = roleId.id || roleId;
17
- return this.resources.fetch({ type: 'permissions' }, `roles/${_roleId}/permissions`, params, options);
18
- }
19
- async memberships(roleId, params, options) {
20
- const _roleId = roleId.id || roleId;
21
- return this.resources.fetch({ type: 'memberships' }, `roles/${_roleId}/memberships`, params, options);
22
- }
23
- async api_credentials(roleId, params, options) {
24
- const _roleId = roleId.id || roleId;
25
- return this.resources.fetch({ type: 'api_credentials' }, `roles/${_roleId}/api_credentials`, params, options);
26
- }
27
- async versions(roleId, params, options) {
28
- const _roleId = roleId.id || roleId;
29
- return this.resources.fetch({ type: 'versions' }, `roles/${_roleId}/versions`, params, options);
30
- }
31
- isRole(resource) {
32
- return resource.type && (resource.type === Roles.TYPE);
33
- }
34
- relationship(id) {
35
- return ((id === null) || (typeof id === 'string')) ? { id, type: Roles.TYPE } : { id: id.id, type: Roles.TYPE };
36
- }
37
- type() {
38
- return Roles.TYPE;
39
- }
40
- }
41
- Roles.TYPE = 'roles';
42
- exports.default = Roles;
@@ -1,29 +0,0 @@
1
- import { ApiSingleton } from '../resource';
2
- import type { Resource, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
3
- import type { QueryParamsRetrieve } from '../query';
4
- type UserType = 'user';
5
- type UserRel = ResourceRel & {
6
- type: UserType;
7
- };
8
- interface User extends Resource {
9
- readonly type: UserType;
10
- email: string;
11
- first_name: string;
12
- last_name: string;
13
- time_zone?: string | null;
14
- }
15
- interface UserUpdate extends ResourceUpdate {
16
- email?: string | null;
17
- first_name?: string | null;
18
- last_name?: string | null;
19
- time_zone?: string | null;
20
- }
21
- declare class Users extends ApiSingleton<User> {
22
- static readonly TYPE: UserType;
23
- update(resource: UserUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<User>;
24
- isUser(resource: any): resource is User;
25
- relationship(id: string | ResourceId | null): UserRel;
26
- type(): UserType;
27
- }
28
- export default Users;
29
- export type { User, UserUpdate, UserType };
@@ -1,20 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const resource_1 = require("../resource");
4
- class Users extends resource_1.ApiSingleton {
5
- async update(resource, params, options) {
6
- const res = await this.retrieve(params, options); // JsonAPI requires id in the request body
7
- return this.resources.update({ ...resource, id: res.id, type: Users.TYPE }, params, options);
8
- }
9
- isUser(resource) {
10
- return resource.type && (resource.type === Users.TYPE);
11
- }
12
- relationship(id) {
13
- return ((id === null) || (typeof id === 'string')) ? { id, type: Users.TYPE } : { id: id.id, type: Users.TYPE };
14
- }
15
- type() {
16
- return Users.TYPE;
17
- }
18
- }
19
- Users.TYPE = 'user';
20
- exports.default = Users;
@@ -1,22 +0,0 @@
1
- import { ApiResource } from '../resource';
2
- import type { Resource, ResourceId, ResourceRel } from '../resource';
3
- type VersionType = 'versions';
4
- type VersionRel = ResourceRel & {
5
- type: VersionType;
6
- };
7
- interface Version extends Resource {
8
- readonly type: VersionType;
9
- resource_type: string;
10
- resource_id: string;
11
- event: string;
12
- changes: Record<string, any>;
13
- who: Record<string, any>;
14
- }
15
- declare class Versions extends ApiResource<Version> {
16
- static readonly TYPE: VersionType;
17
- isVersion(resource: any): resource is Version;
18
- relationship(id: string | ResourceId | null): VersionRel;
19
- type(): VersionType;
20
- }
21
- export default Versions;
22
- export type { Version, VersionType };
@@ -1,16 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const resource_1 = require("../resource");
4
- class Versions extends resource_1.ApiResource {
5
- isVersion(resource) {
6
- return resource.type && (resource.type === Versions.TYPE);
7
- }
8
- relationship(id) {
9
- return ((id === null) || (typeof id === 'string')) ? { id, type: Versions.TYPE } : { id: id.id, type: Versions.TYPE };
10
- }
11
- type() {
12
- return Versions.TYPE;
13
- }
14
- }
15
- Versions.TYPE = 'versions';
16
- exports.default = Versions;
@@ -1,12 +0,0 @@
1
- import * as api from './api';
2
- import { SdkError, ApiError } from './error';
3
- import type { CommerceLayerProvisioningClient, CommerceLayerInitConfig } from './commercelayer';
4
- export declare const CommerceLayerProvisioningStatic: {
5
- resources: (sort?: boolean) => readonly string[];
6
- singletons: (sort?: boolean) => readonly string[];
7
- isSingleton: (resource: api.ResourceTypeLock) => boolean;
8
- isSdkError: (error: unknown) => error is SdkError;
9
- isApiError: (error: unknown) => error is ApiError;
10
- init: (config: CommerceLayerInitConfig) => CommerceLayerProvisioningClient;
11
- readonly schemaVersion: string;
12
- };