@commercelayer/provisioning-sdk 2.0.0-beta.10 → 2.0.0-beta.12

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 (3) hide show
  1. package/lib/index.d.mts +21 -21
  2. package/lib/index.d.ts +21 -21
  3. package/package.json +1 -1
package/lib/index.d.mts CHANGED
@@ -168,10 +168,10 @@ declare class ResourceAdapter {
168
168
  private localConfig;
169
169
  config(config: ResourcesConfig): this;
170
170
  get client(): Readonly<ApiClient>;
171
- retrieve<R extends Resource>(resource: ResourceId | ResourceType, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
172
- list<R extends Resource>(resource: ResourceType, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
171
+ retrieve<R extends Resource>(resource: ResourceId | ResourceType, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
172
+ list<R extends Resource>(resource: ResourceType, params?: QueryParamsList<R>, options?: ResourcesConfig): Promise<ListResponse<R>>;
173
173
  create<C extends ResourceCreate, R extends Resource>(resource: C & ResourceType, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
174
- update<U extends ResourceUpdate, R extends Resource>(resource: U & ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
174
+ update<U extends ResourceUpdate, R extends Resource>(resource: U & ResourceId, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
175
175
  delete(resource: ResourceId, options?: ResourcesConfig): Promise<void>;
176
176
  fetch<R extends Resource>(resource: string | ResourceType, path: string, params?: QueryParams<R>, options?: ResourcesConfig): Promise<R | ListResponse<R>>;
177
177
  action(cmd: Extract<Method, 'POST' | 'PATCH'>, path: string, payload?: any, options?: ResourcesConfig): Promise<void>;
@@ -185,15 +185,15 @@ declare abstract class ApiResourceBase<R extends Resource> {
185
185
  protected relationshipOneToMany<RR extends ResourceRel>(...ids: string[]): RR[];
186
186
  abstract type(): ResourceTypeLock;
187
187
  parse(resource: string): R | R[];
188
- update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
188
+ update(resource: ResourceUpdate, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
189
189
  }
190
190
  declare abstract class ApiResource<R extends Resource> extends ApiResourceBase<R> {
191
- retrieve(id: string | ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
192
- list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
193
- count(filter?: QueryFilter | QueryParamsList, options?: ResourcesConfig): Promise<number>;
191
+ retrieve(id: string | ResourceId, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
192
+ list(params?: QueryParamsList<R>, options?: ResourcesConfig): Promise<ListResponse<R>>;
193
+ count(filter?: QueryFilter | QueryParamsList<R>, options?: ResourcesConfig): Promise<number>;
194
194
  }
195
195
  declare abstract class ApiSingleton<R extends Resource> extends ApiResourceBase<R> {
196
- retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
196
+ retrieve(params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
197
197
  }
198
198
 
199
199
  type VersionType = 'versions';
@@ -319,8 +319,8 @@ interface PermissionUpdate extends ResourceUpdate {
319
319
  }
320
320
  declare class Permissions extends ApiResource<Permission> {
321
321
  static readonly TYPE: PermissionType;
322
- create(resource: PermissionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Permission>;
323
- update(resource: PermissionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Permission>;
322
+ create(resource: PermissionCreate, params?: QueryParamsRetrieve<Permission>, options?: ResourcesConfig): Promise<Permission>;
323
+ update(resource: PermissionUpdate, params?: QueryParamsRetrieve<Permission>, options?: ResourcesConfig): Promise<Permission>;
324
324
  organization(permissionId: string | Permission, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
325
325
  role(permissionId: string | Permission, params?: QueryParamsRetrieve<Role>, options?: ResourcesConfig): Promise<Role>;
326
326
  versions(permissionId: string | Permission, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
@@ -373,8 +373,8 @@ interface RoleUpdate extends ResourceUpdate {
373
373
  }
374
374
  declare class Roles extends ApiResource<Role> {
375
375
  static readonly TYPE: RoleType;
376
- create(resource: RoleCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
377
- update(resource: RoleUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
376
+ create(resource: RoleCreate, params?: QueryParamsRetrieve<Role>, options?: ResourcesConfig): Promise<Role>;
377
+ update(resource: RoleUpdate, params?: QueryParamsRetrieve<Role>, options?: ResourcesConfig): Promise<Role>;
378
378
  organization(roleId: string | Role, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
379
379
  permissions(roleId: string | Role, params?: QueryParamsList<Permission>, options?: ResourcesConfig): Promise<ListResponse<Permission>>;
380
380
  memberships(roleId: string | Role, params?: QueryParamsList<Membership>, options?: ResourcesConfig): Promise<ListResponse<Membership>>;
@@ -436,8 +436,8 @@ interface ApplicationMembershipUpdate extends ResourceUpdate {
436
436
  }
437
437
  declare class ApplicationMemberships extends ApiResource<ApplicationMembership> {
438
438
  static readonly TYPE: ApplicationMembershipType;
439
- create(resource: ApplicationMembershipCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApplicationMembership>;
440
- update(resource: ApplicationMembershipUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApplicationMembership>;
439
+ create(resource: ApplicationMembershipCreate, params?: QueryParamsRetrieve<ApplicationMembership>, options?: ResourcesConfig): Promise<ApplicationMembership>;
440
+ update(resource: ApplicationMembershipUpdate, params?: QueryParamsRetrieve<ApplicationMembership>, options?: ResourcesConfig): Promise<ApplicationMembership>;
441
441
  delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
442
442
  api_credential(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve<ApiCredential>, options?: ResourcesConfig): Promise<ApiCredential>;
443
443
  membership(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve<Membership>, options?: ResourcesConfig): Promise<Membership>;
@@ -511,8 +511,8 @@ interface MembershipUpdate extends ResourceUpdate {
511
511
  }
512
512
  declare class Memberships extends ApiResource<Membership> {
513
513
  static readonly TYPE: MembershipType;
514
- create(resource: MembershipCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Membership>;
515
- update(resource: MembershipUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Membership>;
514
+ create(resource: MembershipCreate, params?: QueryParamsRetrieve<Membership>, options?: ResourcesConfig): Promise<Membership>;
515
+ update(resource: MembershipUpdate, params?: QueryParamsRetrieve<Membership>, options?: ResourcesConfig): Promise<Membership>;
516
516
  delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
517
517
  resend(membershipId: string | Membership, options?: ResourcesConfig): Promise<void>;
518
518
  organization(membershipId: string | Membership, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
@@ -768,8 +768,8 @@ interface OrganizationUpdate extends ResourceUpdate {
768
768
  }
769
769
  declare class Organizations extends ApiResource<Organization> {
770
770
  static readonly TYPE: OrganizationType;
771
- create(resource: OrganizationCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
772
- update(resource: OrganizationUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
771
+ create(resource: OrganizationCreate, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
772
+ update(resource: OrganizationUpdate, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
773
773
  transfer_ownership(organizationId: string | Organization, payload: TransferOwnershipDataType, options?: ResourcesConfig): Promise<void>;
774
774
  memberships(organizationId: string | Organization, params?: QueryParamsList<Membership>, options?: ResourcesConfig): Promise<ListResponse<Membership>>;
775
775
  roles(organizationId: string | Organization, params?: QueryParamsList<Role>, options?: ResourcesConfig): Promise<ListResponse<Role>>;
@@ -905,8 +905,8 @@ interface ApiCredentialUpdate extends ResourceUpdate {
905
905
  }
906
906
  declare class ApiCredentials extends ApiResource<ApiCredential> {
907
907
  static readonly TYPE: ApiCredentialType;
908
- create(resource: ApiCredentialCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApiCredential>;
909
- update(resource: ApiCredentialUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApiCredential>;
908
+ create(resource: ApiCredentialCreate, params?: QueryParamsRetrieve<ApiCredential>, options?: ResourcesConfig): Promise<ApiCredential>;
909
+ update(resource: ApiCredentialUpdate, params?: QueryParamsRetrieve<ApiCredential>, options?: ResourcesConfig): Promise<ApiCredential>;
910
910
  delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
911
911
  organization(apiCredentialId: string | ApiCredential, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
912
912
  role(apiCredentialId: string | ApiCredential, params?: QueryParamsRetrieve<Role>, options?: ResourcesConfig): Promise<Role>;
@@ -972,7 +972,7 @@ interface UserUpdate extends ResourceUpdate {
972
972
  }
973
973
  declare class Users extends ApiSingleton<User> {
974
974
  static readonly TYPE: UserType;
975
- update(resource: UserUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<User>;
975
+ update(resource: UserUpdate, params?: QueryParamsRetrieve<User>, options?: ResourcesConfig): Promise<User>;
976
976
  isUser(resource: any): resource is User;
977
977
  relationship(id: string | ResourceId | null): UserRel;
978
978
  relationshipToMany(...ids: string[]): UserRel[];
package/lib/index.d.ts CHANGED
@@ -168,10 +168,10 @@ declare class ResourceAdapter {
168
168
  private localConfig;
169
169
  config(config: ResourcesConfig): this;
170
170
  get client(): Readonly<ApiClient>;
171
- retrieve<R extends Resource>(resource: ResourceId | ResourceType, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
172
- list<R extends Resource>(resource: ResourceType, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
171
+ retrieve<R extends Resource>(resource: ResourceId | ResourceType, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
172
+ list<R extends Resource>(resource: ResourceType, params?: QueryParamsList<R>, options?: ResourcesConfig): Promise<ListResponse<R>>;
173
173
  create<C extends ResourceCreate, R extends Resource>(resource: C & ResourceType, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
174
- update<U extends ResourceUpdate, R extends Resource>(resource: U & ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
174
+ update<U extends ResourceUpdate, R extends Resource>(resource: U & ResourceId, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
175
175
  delete(resource: ResourceId, options?: ResourcesConfig): Promise<void>;
176
176
  fetch<R extends Resource>(resource: string | ResourceType, path: string, params?: QueryParams<R>, options?: ResourcesConfig): Promise<R | ListResponse<R>>;
177
177
  action(cmd: Extract<Method, 'POST' | 'PATCH'>, path: string, payload?: any, options?: ResourcesConfig): Promise<void>;
@@ -185,15 +185,15 @@ declare abstract class ApiResourceBase<R extends Resource> {
185
185
  protected relationshipOneToMany<RR extends ResourceRel>(...ids: string[]): RR[];
186
186
  abstract type(): ResourceTypeLock;
187
187
  parse(resource: string): R | R[];
188
- update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
188
+ update(resource: ResourceUpdate, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
189
189
  }
190
190
  declare abstract class ApiResource<R extends Resource> extends ApiResourceBase<R> {
191
- retrieve(id: string | ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
192
- list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
193
- count(filter?: QueryFilter | QueryParamsList, options?: ResourcesConfig): Promise<number>;
191
+ retrieve(id: string | ResourceId, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
192
+ list(params?: QueryParamsList<R>, options?: ResourcesConfig): Promise<ListResponse<R>>;
193
+ count(filter?: QueryFilter | QueryParamsList<R>, options?: ResourcesConfig): Promise<number>;
194
194
  }
195
195
  declare abstract class ApiSingleton<R extends Resource> extends ApiResourceBase<R> {
196
- retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
196
+ retrieve(params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
197
197
  }
198
198
 
199
199
  type VersionType = 'versions';
@@ -319,8 +319,8 @@ interface PermissionUpdate extends ResourceUpdate {
319
319
  }
320
320
  declare class Permissions extends ApiResource<Permission> {
321
321
  static readonly TYPE: PermissionType;
322
- create(resource: PermissionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Permission>;
323
- update(resource: PermissionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Permission>;
322
+ create(resource: PermissionCreate, params?: QueryParamsRetrieve<Permission>, options?: ResourcesConfig): Promise<Permission>;
323
+ update(resource: PermissionUpdate, params?: QueryParamsRetrieve<Permission>, options?: ResourcesConfig): Promise<Permission>;
324
324
  organization(permissionId: string | Permission, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
325
325
  role(permissionId: string | Permission, params?: QueryParamsRetrieve<Role>, options?: ResourcesConfig): Promise<Role>;
326
326
  versions(permissionId: string | Permission, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
@@ -373,8 +373,8 @@ interface RoleUpdate extends ResourceUpdate {
373
373
  }
374
374
  declare class Roles extends ApiResource<Role> {
375
375
  static readonly TYPE: RoleType;
376
- create(resource: RoleCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
377
- update(resource: RoleUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
376
+ create(resource: RoleCreate, params?: QueryParamsRetrieve<Role>, options?: ResourcesConfig): Promise<Role>;
377
+ update(resource: RoleUpdate, params?: QueryParamsRetrieve<Role>, options?: ResourcesConfig): Promise<Role>;
378
378
  organization(roleId: string | Role, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
379
379
  permissions(roleId: string | Role, params?: QueryParamsList<Permission>, options?: ResourcesConfig): Promise<ListResponse<Permission>>;
380
380
  memberships(roleId: string | Role, params?: QueryParamsList<Membership>, options?: ResourcesConfig): Promise<ListResponse<Membership>>;
@@ -436,8 +436,8 @@ interface ApplicationMembershipUpdate extends ResourceUpdate {
436
436
  }
437
437
  declare class ApplicationMemberships extends ApiResource<ApplicationMembership> {
438
438
  static readonly TYPE: ApplicationMembershipType;
439
- create(resource: ApplicationMembershipCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApplicationMembership>;
440
- update(resource: ApplicationMembershipUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApplicationMembership>;
439
+ create(resource: ApplicationMembershipCreate, params?: QueryParamsRetrieve<ApplicationMembership>, options?: ResourcesConfig): Promise<ApplicationMembership>;
440
+ update(resource: ApplicationMembershipUpdate, params?: QueryParamsRetrieve<ApplicationMembership>, options?: ResourcesConfig): Promise<ApplicationMembership>;
441
441
  delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
442
442
  api_credential(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve<ApiCredential>, options?: ResourcesConfig): Promise<ApiCredential>;
443
443
  membership(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve<Membership>, options?: ResourcesConfig): Promise<Membership>;
@@ -511,8 +511,8 @@ interface MembershipUpdate extends ResourceUpdate {
511
511
  }
512
512
  declare class Memberships extends ApiResource<Membership> {
513
513
  static readonly TYPE: MembershipType;
514
- create(resource: MembershipCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Membership>;
515
- update(resource: MembershipUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Membership>;
514
+ create(resource: MembershipCreate, params?: QueryParamsRetrieve<Membership>, options?: ResourcesConfig): Promise<Membership>;
515
+ update(resource: MembershipUpdate, params?: QueryParamsRetrieve<Membership>, options?: ResourcesConfig): Promise<Membership>;
516
516
  delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
517
517
  resend(membershipId: string | Membership, options?: ResourcesConfig): Promise<void>;
518
518
  organization(membershipId: string | Membership, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
@@ -768,8 +768,8 @@ interface OrganizationUpdate extends ResourceUpdate {
768
768
  }
769
769
  declare class Organizations extends ApiResource<Organization> {
770
770
  static readonly TYPE: OrganizationType;
771
- create(resource: OrganizationCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
772
- update(resource: OrganizationUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
771
+ create(resource: OrganizationCreate, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
772
+ update(resource: OrganizationUpdate, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
773
773
  transfer_ownership(organizationId: string | Organization, payload: TransferOwnershipDataType, options?: ResourcesConfig): Promise<void>;
774
774
  memberships(organizationId: string | Organization, params?: QueryParamsList<Membership>, options?: ResourcesConfig): Promise<ListResponse<Membership>>;
775
775
  roles(organizationId: string | Organization, params?: QueryParamsList<Role>, options?: ResourcesConfig): Promise<ListResponse<Role>>;
@@ -905,8 +905,8 @@ interface ApiCredentialUpdate extends ResourceUpdate {
905
905
  }
906
906
  declare class ApiCredentials extends ApiResource<ApiCredential> {
907
907
  static readonly TYPE: ApiCredentialType;
908
- create(resource: ApiCredentialCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApiCredential>;
909
- update(resource: ApiCredentialUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApiCredential>;
908
+ create(resource: ApiCredentialCreate, params?: QueryParamsRetrieve<ApiCredential>, options?: ResourcesConfig): Promise<ApiCredential>;
909
+ update(resource: ApiCredentialUpdate, params?: QueryParamsRetrieve<ApiCredential>, options?: ResourcesConfig): Promise<ApiCredential>;
910
910
  delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
911
911
  organization(apiCredentialId: string | ApiCredential, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
912
912
  role(apiCredentialId: string | ApiCredential, params?: QueryParamsRetrieve<Role>, options?: ResourcesConfig): Promise<Role>;
@@ -972,7 +972,7 @@ interface UserUpdate extends ResourceUpdate {
972
972
  }
973
973
  declare class Users extends ApiSingleton<User> {
974
974
  static readonly TYPE: UserType;
975
- update(resource: UserUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<User>;
975
+ update(resource: UserUpdate, params?: QueryParamsRetrieve<User>, options?: ResourcesConfig): Promise<User>;
976
976
  isUser(resource: any): resource is User;
977
977
  relationship(id: string | ResourceId | null): UserRel;
978
978
  relationshipToMany(...ids: string[]): UserRel[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@commercelayer/provisioning-sdk",
3
- "version": "2.0.0-beta.10",
3
+ "version": "2.0.0-beta.12",
4
4
  "main": "lib/index.js",
5
5
  "types": "lib/index.d.ts",
6
6
  "module": "lib/index.mjs",