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

package/lib/index.d.mts

@@ -1,7 +1,5 @@
-import { DocWithData } from 'jsonapi-typescript';
-
 type Fetch = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
-type FetchResponse = DocWithData;
+type FetchResponse = any;
 type FetchRequestOptions = RequestInit;
 declare class FetchError extends Error {
     #private;
@@ -106,7 +104,12 @@ interface QueryParamsList<R extends Resource = Resource> extends QueryParamsRetr
     pageNumber?: QueryPageNumber;
     pageSize?: QueryPageSize;
 }
-type QueryParams<R extends Resource> = QueryParamsRetrieve<R> | QueryParamsList<R>;
+type QueryParams<R extends Resource = Resource> = QueryParamsRetrieve<R> | QueryParamsList<R>;
+
+declare const isParamsList: <R extends Resource>(params: any) => params is QueryParamsList<R>;
+type QueryStringParams = Record<string, string>;
+declare const generateQueryStringParams: <R extends Resource>(params: QueryParams<R> | undefined, res: string | ResourceType) => QueryStringParams;
+declare const generateSearchString: (params?: QueryStringParams, questionMark?: boolean) => string;
 
 type ResourceNull = {
     id: null;
@@ -154,9 +157,11 @@ declare class ListResponse<R> extends Array<R> {
 }
 
 type ResourceSort = Pick<Resource, 'id' | 'reference' | 'reference_origin' | 'created_at' | 'updated_at'>;
+type ResourceFilter = Pick<Resource, 'id' | 'reference' | 'reference_origin' | 'metadata' | 'created_at' | 'updated_at'>;
 type ResourceAdapterConfig = {};
 type ResourcesInitConfig = ResourceAdapterConfig & ApiClientInitConfig;
 type ResourcesConfig = Partial<ResourcesInitConfig>;
+declare const apiResourceAdapter: (config: ResourcesInitConfig) => ResourceAdapter;
 declare class ResourceAdapter {
     #private;
     constructor(config: ResourcesInitConfig);
@@ -198,10 +203,30 @@ type VersionRel = ResourceRel & {
 type VersionSort = Pick<Version, 'id'> & ResourceSort;
 interface Version extends Resource {
     readonly type: VersionType;
+    /**
+     * The type of the versioned resource..
+     * @example ```"roles"```
+     */
     resource_type: string;
+    /**
+     * The versioned resource ID..
+     * @example ```"PzdJhdLdYV"```
+     */
     resource_id: string;
+    /**
+     * The event which generates the version..
+     * @example ```"update"```
+     */
     event: string;
+    /**
+     * The object changes payload..
+     * @example ```"[object Object]"```
+     */
     changes: Record<string, any>;
+    /**
+     * Information about who triggered the change, only showed when it's from a JWT token..
+     * @example ```"[object Object]"```
+     */
     who: Record<string, any>;
 }
 declare class Versions extends ApiResource<Version> {
@@ -222,28 +247,74 @@ type RoleRel$4 = ResourceRel & {
 type PermissionSort = Pick<Permission, 'id'> & ResourceSort;
 interface Permission extends Resource {
     readonly type: PermissionType;
+    /**
+     * Determines if the permission have access to create rights..
+     */
     can_create: boolean;
+    /**
+     * Determines if the permission have access to read rights..
+     */
     can_read: boolean;
+    /**
+     * Determines if the permission have access to update rights..
+     */
     can_update: boolean;
+    /**
+     * Determines if the permission have access to destroy rights..
+     */
     can_destroy: boolean;
+    /**
+     * The resource where this permission is applied..
+     */
     subject: string;
+    /**
+     * An object that contains additional restrictions..
+     * @example ```"[object Object]"```
+     */
     restrictions: Record<string, any>;
     organization?: Nullable<Organization>;
     role?: Nullable<Role>;
     versions?: Nullable<Version[]>;
 }
 interface PermissionCreate extends ResourceCreate {
+    /**
+     * Determines if the permission have access to create rights..
+     */
     can_create: boolean;
+    /**
+     * Determines if the permission have access to read rights..
+     */
     can_read: boolean;
+    /**
+     * Determines if the permission have access to update rights..
+     */
     can_update: boolean;
+    /**
+     * Determines if the permission have access to destroy rights..
+     */
     can_destroy: boolean;
+    /**
+     * The resource where this permission is applied..
+     */
     subject: string;
     role: RoleRel$4;
 }
 interface PermissionUpdate extends ResourceUpdate {
+    /**
+     * Determines if the permission have access to create rights..
+     */
     can_create?: Nullable<boolean>;
+    /**
+     * Determines if the permission have access to read rights..
+     */
     can_read?: Nullable<boolean>;
+    /**
+     * Determines if the permission have access to update rights..
+     */
     can_update?: Nullable<boolean>;
+    /**
+     * Determines if the permission have access to destroy rights..
+     */
     can_destroy?: Nullable<boolean>;
 }
 declare class Permissions extends ApiResource<Permission> {
@@ -269,7 +340,15 @@ type OrganizationRel$4 = ResourceRel & {
 type RoleSort = Pick<Role, 'id'> & ResourceSort;
 interface Role extends Resource {
     readonly type: RoleType;
+    /**
+     * The role name..
+     * @example ```"Custom role"```
+     */
     name: string;
+    /**
+     * The kind of role, one of: `custom`, `admin`, `read_only`.
+     * @example ```"custom"```
+     */
     kind: string;
     organization?: Nullable<Organization>;
     permissions?: Nullable<Permission[]>;
@@ -278,10 +357,18 @@ interface Role extends Resource {
     versions?: Nullable<Version[]>;
 }
 interface RoleCreate extends ResourceCreate {
+    /**
+     * The role name..
+     * @example ```"Custom role"```
+     */
     name: string;
     organization: OrganizationRel$4;
 }
 interface RoleUpdate extends ResourceUpdate {
+    /**
+     * The role name..
+     * @example ```"Custom role"```
+     */
     name?: Nullable<string>;
 }
 declare class Roles extends ApiResource<Role> {
@@ -318,6 +405,10 @@ type RoleRel$2 = ResourceRel & {
 type ApplicationMembershipSort = Pick<ApplicationMembership, 'id'> & ResourceSort;
 interface ApplicationMembership extends Resource {
     readonly type: ApplicationMembershipType;
+    /**
+     * Set of key-value pairs that contains restrictions and scopes of the application membership..
+     * @example ```"[object Object]"```
+     */
     filters?: Nullable<Record<string, any>>;
     api_credential?: Nullable<ApiCredential>;
     membership?: Nullable<Membership>;
@@ -325,6 +416,10 @@ interface ApplicationMembership extends Resource {
     role?: Nullable<Role>;
 }
 interface ApplicationMembershipCreate extends ResourceCreate {
+    /**
+     * Set of key-value pairs that contains restrictions and scopes of the application membership..
+     * @example ```"[object Object]"```
+     */
     filters?: Nullable<Record<string, any>>;
     api_credential: ApiCredentialRel$1;
     membership: MembershipRel$1;
@@ -332,6 +427,10 @@ interface ApplicationMembershipCreate extends ResourceCreate {
     role: RoleRel$2;
 }
 interface ApplicationMembershipUpdate extends ResourceUpdate {
+    /**
+     * Set of key-value pairs that contains restrictions and scopes of the application membership..
+     * @example ```"[object Object]"```
+     */
     filters?: Nullable<Record<string, any>>;
     role?: Nullable<RoleRel$2>;
 }
@@ -363,13 +462,33 @@ type RoleRel$1 = ResourceRel & {
 type ApplicationMembershipRel = ResourceRel & {
     type: ApplicationMembershipType;
 };
-type MembershipSort = Pick<Membership, 'id'> & ResourceSort;
+type MembershipSort = Pick<Membership, 'id' | 'status'> & ResourceSort;
 interface Membership extends Resource {
     readonly type: MembershipType;
+    /**
+     * The user email..
+     * @example ```"commercelayer@commercelayer.io"```
+     */
     user_email: string;
+    /**
+     * The user first name..
+     * @example ```"John"```
+     */
     user_first_name: string;
+    /**
+     * The user last name..
+     * @example ```"Doe"```
+     */
     user_last_name: string;
+    /**
+     * The memberships status. One of `pending` (default), `active`..
+     * @example ```"pending"```
+     */
     status: 'pending' | 'active';
+    /**
+     * Indicates if the user it's the owner of the organization..
+     * @example ```"true"```
+     */
     owner: boolean;
     organization?: Nullable<Organization>;
     role?: Nullable<Role>;
@@ -377,6 +496,10 @@ interface Membership extends Resource {
     versions?: Nullable<Version[]>;
 }
 interface MembershipCreate extends ResourceCreate {
+    /**
+     * The user email..
+     * @example ```"commercelayer@commercelayer.io"```
+     */
     user_email: string;
     organization: OrganizationRel$2;
     role: RoleRel$1;
@@ -409,25 +532,101 @@ type OrganizationRel$1 = ResourceRel & {
 type OrganizationSort = Pick<Organization, 'id'> & ResourceSort;
 interface Organization extends Resource {
     readonly type: OrganizationType;
+    /**
+     * The organization's internal name..
+     * @example ```"The Blue Brand"```
+     */
     name: string;
+    /**
+     * The organization's slug name..
+     * @example ```"the-blue-brand"```
+     */
     slug: string;
+    /**
+     * The organization's domain..
+     * @example ```"the-blue-brand.commercelayer.io"```
+     */
     domain: string;
+    /**
+     * The organization's configuration..
+     * @example ```"[object Object]"```
+     */
     config?: Nullable<Record<string, any>>;
+    /**
+     * The organization's support phone..
+     * @example ```"+01 30800857"```
+     */
     support_phone?: Nullable<string>;
+    /**
+     * The organization's support email..
+     * @example ```"support@bluebrand.com"```
+     */
     support_email?: Nullable<string>;
+    /**
+     * The URL to the organization's logo..
+     * @example ```"https://bluebrand.com/img/logo.svg"```
+     */
     logo_url?: Nullable<string>;
+    /**
+     * The URL to the organization's favicon..
+     * @example ```"https://bluebrand.com/img/favicon.ico"```
+     */
     favicon_url?: Nullable<string>;
+    /**
+     * The organization's primary color. Format is HEX (starts with `#` and it's followed by six letters and/or numbers)..
+     * @example ```"#C8984E"```
+     */
     primary_color?: Nullable<string>;
+    /**
+     * The organization's contrast color. Format is HEX (starts with `#` and it's followed by six letters and/or numbers)..
+     * @example ```"#FFFFCC"```
+     */
     contrast_color?: Nullable<string>;
+    /**
+     * The organization's Google Tag Manager ID..
+     * @example ```"GTM-5FJXX6"```
+     */
     gtm_id?: Nullable<string>;
+    /**
+     * The organization's Google Tag Manager ID for test..
+     * @example ```"GTM-5FJXX7"```
+     */
     gtm_id_test?: Nullable<string>;
+    /**
+     * Indicates if organization has discount disabled..
+     */
     discount_disabled?: Nullable<boolean>;
+    /**
+     * Indicates if organization has account disabled..
+     */
     account_disabled?: Nullable<boolean>;
+    /**
+     * Indicates if organization has acceptance disabled..
+     */
     acceptance_disabled?: Nullable<boolean>;
+    /**
+     * The maximum number of active concurrent promotions allowed for your organization..
+     * @example ```"10"```
+     */
     max_concurrent_promotions: number;
+    /**
+     * The maximum number of concurrent imports allowed for your organization..
+     * @example ```"30"```
+     */
     max_concurrent_imports: number;
+    /**
+     * The region where the organization it's located, default value it's `eu-west-1`..
+     * @example ```"eu-west-1"```
+     */
     region?: Nullable<string>;
+    /**
+     * Indicates if the organization can switch to live mode..
+     */
     can_switch_live: boolean;
+    /**
+     * Information about the current subscription such as the plan type, limits and subscription totals counter..
+     * @example ```"[object Object]"```
+     */
     subscription_info: Record<string, any>;
     memberships?: Nullable<Membership[]>;
     roles?: Nullable<Role[]>;
@@ -435,34 +634,136 @@ interface Organization extends Resource {
     api_credentials?: Nullable<ApiCredential[]>;
 }
 interface OrganizationCreate extends ResourceCreate {
+    /**
+     * The organization's internal name..
+     * @example ```"The Blue Brand"```
+     */
     name: string;
+    /**
+     * The organization's configuration..
+     * @example ```"[object Object]"```
+     */
     config?: Nullable<Record<string, any>>;
+    /**
+     * The organization's support phone..
+     * @example ```"+01 30800857"```
+     */
     support_phone?: Nullable<string>;
+    /**
+     * The organization's support email..
+     * @example ```"support@bluebrand.com"```
+     */
     support_email?: Nullable<string>;
+    /**
+     * The URL to the organization's logo..
+     * @example ```"https://bluebrand.com/img/logo.svg"```
+     */
     logo_url?: Nullable<string>;
+    /**
+     * The URL to the organization's favicon..
+     * @example ```"https://bluebrand.com/img/favicon.ico"```
+     */
     favicon_url?: Nullable<string>;
+    /**
+     * The organization's primary color. Format is HEX (starts with `#` and it's followed by six letters and/or numbers)..
+     * @example ```"#C8984E"```
+     */
     primary_color?: Nullable<string>;
+    /**
+     * The organization's contrast color. Format is HEX (starts with `#` and it's followed by six letters and/or numbers)..
+     * @example ```"#FFFFCC"```
+     */
     contrast_color?: Nullable<string>;
+    /**
+     * The organization's Google Tag Manager ID..
+     * @example ```"GTM-5FJXX6"```
+     */
     gtm_id?: Nullable<string>;
+    /**
+     * The organization's Google Tag Manager ID for test..
+     * @example ```"GTM-5FJXX7"```
+     */
     gtm_id_test?: Nullable<string>;
+    /**
+     * Indicates if organization has discount disabled..
+     */
     discount_disabled?: Nullable<boolean>;
+    /**
+     * Indicates if organization has account disabled..
+     */
     account_disabled?: Nullable<boolean>;
+    /**
+     * Indicates if organization has acceptance disabled..
+     */
     acceptance_disabled?: Nullable<boolean>;
+    /**
+     * The region where the organization it's located, default value it's `eu-west-1`..
+     * @example ```"eu-west-1"```
+     */
     region?: Nullable<string>;
 }
 interface OrganizationUpdate extends ResourceUpdate {
+    /**
+     * The organization's internal name..
+     * @example ```"The Blue Brand"```
+     */
     name?: Nullable<string>;
+    /**
+     * The organization's configuration..
+     * @example ```"[object Object]"```
+     */
     config?: Nullable<Record<string, any>>;
+    /**
+     * The organization's support phone..
+     * @example ```"+01 30800857"```
+     */
     support_phone?: Nullable<string>;
+    /**
+     * The organization's support email..
+     * @example ```"support@bluebrand.com"```
+     */
     support_email?: Nullable<string>;
+    /**
+     * The URL to the organization's logo..
+     * @example ```"https://bluebrand.com/img/logo.svg"```
+     */
     logo_url?: Nullable<string>;
+    /**
+     * The URL to the organization's favicon..
+     * @example ```"https://bluebrand.com/img/favicon.ico"```
+     */
     favicon_url?: Nullable<string>;
+    /**
+     * The organization's primary color. Format is HEX (starts with `#` and it's followed by six letters and/or numbers)..
+     * @example ```"#C8984E"```
+     */
     primary_color?: Nullable<string>;
+    /**
+     * The organization's contrast color. Format is HEX (starts with `#` and it's followed by six letters and/or numbers)..
+     * @example ```"#FFFFCC"```
+     */
     contrast_color?: Nullable<string>;
+    /**
+     * The organization's Google Tag Manager ID..
+     * @example ```"GTM-5FJXX6"```
+     */
     gtm_id?: Nullable<string>;
+    /**
+     * The organization's Google Tag Manager ID for test..
+     * @example ```"GTM-5FJXX7"```
+     */
     gtm_id_test?: Nullable<string>;
+    /**
+     * Indicates if organization has discount disabled..
+     */
     discount_disabled?: Nullable<boolean>;
+    /**
+     * Indicates if organization has account disabled..
+     */
     account_disabled?: Nullable<boolean>;
+    /**
+     * Indicates if organization has acceptance disabled..
+     */
     acceptance_disabled?: Nullable<boolean>;
 }
 declare class Organizations extends ApiResource<Organization> {
@@ -499,32 +800,106 @@ type RoleRel = ResourceRel & {
 type ApiCredentialSort = Pick<ApiCredential, 'id' | 'mode'> & ResourceSort;
 interface ApiCredential extends Resource {
     readonly type: ApiCredentialType;
+    /**
+     * The API credential internal name..
+     * @example ```"My app"```
+     */
     name: string;
+    /**
+     * The API credential kind, can be one of: `webapp`, `sales_channel`, `integration` or the kind of app you want to fork (e.g. `orders`, `imports`, etc.)..
+     * @example ```"sales_channel"```
+     */
     kind: string;
+    /**
+     * Indicates if the API credential it's confidential..
+     * @example ```"true"```
+     */
     confidential: boolean;
+    /**
+     * The API credential redirect URI..
+     * @example ```"https://bluebrand.com/img/logo.svg"```
+     */
     redirect_uri?: Nullable<string>;
+    /**
+     * The API credential unique ID..
+     * @example ```"xxxx-yyyy-zzzz"```
+     */
     client_id: string;
+    /**
+     * The API credential unique secret..
+     * @example ```"xxxx-yyyy-zzzz"```
+     */
     client_secret: string;
+    /**
+     * The API credential scopes..
+     * @example ```"market:all market:9 market:122 market:6 stock_location:6 stock_location:33"```
+     */
     scopes: string;
+    /**
+     * The lifetime of the access token in seconds (min. `7200`, max. `31536000`. Default is `14400` for Sales channels and `7200` for other client types)..
+     * @example ```"7200"```
+     */
     expires_in?: Nullable<number>;
+    /**
+     * Indicates the environment the resource belongs to (one of `test` or `live`)..
+     * @example ```"test"```
+     */
     mode?: Nullable<string>;
+    /**
+     * Indicates if the API credential is used to create a custom app (e.g. fork a hosted app)..
+     */
     custom?: Nullable<boolean>;
     organization?: Nullable<Organization>;
     role?: Nullable<Role>;
 }
 interface ApiCredentialCreate extends ResourceCreate {
+    /**
+     * The API credential internal name..
+     * @example ```"My app"```
+     */
     name: string;
+    /**
+     * The API credential kind, can be one of: `webapp`, `sales_channel`, `integration` or the kind of app you want to fork (e.g. `orders`, `imports`, etc.)..
+     * @example ```"sales_channel"```
+     */
     kind: string;
+    /**
+     * The API credential redirect URI..
+     * @example ```"https://bluebrand.com/img/logo.svg"```
+     */
     redirect_uri?: Nullable<string>;
+    /**
+     * The lifetime of the access token in seconds (min. `7200`, max. `31536000`. Default is `14400` for Sales channels and `7200` for other client types)..
+     * @example ```"7200"```
+     */
     expires_in?: Nullable<number>;
+    /**
+     * Indicates the environment the resource belongs to (one of `test` or `live`)..
+     * @example ```"test"```
+     */
     mode?: Nullable<string>;
+    /**
+     * Indicates if the API credential is used to create a custom app (e.g. fork a hosted app)..
+     */
     custom?: Nullable<boolean>;
     organization: OrganizationRel;
     role?: Nullable<RoleRel>;
 }
 interface ApiCredentialUpdate extends ResourceUpdate {
+    /**
+     * The API credential internal name..
+     * @example ```"My app"```
+     */
     name?: Nullable<string>;
+    /**
+     * The API credential redirect URI..
+     * @example ```"https://bluebrand.com/img/logo.svg"```
+     */
     redirect_uri?: Nullable<string>;
+    /**
+     * The lifetime of the access token in seconds (min. `7200`, max. `31536000`. Default is `14400` for Sales channels and `7200` for other client types)..
+     * @example ```"7200"```
+     */
     expires_in?: Nullable<number>;
     role?: Nullable<RoleRel>;
 }
@@ -548,16 +923,51 @@ type UserRel = ResourceRel & {
 type UserSort = Pick<User, 'id'> & ResourceSort;
 interface User extends Resource {
     readonly type: UserType;
+    /**
+     * The user email..
+     * @example ```"user@commercelayer.io"```
+     */
     email: string;
+    /**
+     * The user first name..
+     * @example ```"John"```
+     */
     first_name: string;
+    /**
+     * The user last name..
+     * @example ```"Doe"```
+     */
     last_name: string;
+    /**
+     * The user preferred timezone..
+     * @example ```"UTC"```
+     */
     time_zone?: Nullable<string>;
+    /**
+     * The user 2FA setting..
+     */
     otp_required_for_login: boolean;
 }
 interface UserUpdate extends ResourceUpdate {
+    /**
+     * The user email..
+     * @example ```"user@commercelayer.io"```
+     */
     email?: Nullable<string>;
+    /**
+     * The user first name..
+     * @example ```"John"```
+     */
     first_name?: Nullable<string>;
+    /**
+     * The user last name..
+     * @example ```"Doe"```
+     */
     last_name?: Nullable<string>;
+    /**
+     * The user preferred timezone..
+     * @example ```"UTC"```
+     */
     time_zone?: Nullable<string>;
 }
 declare class Users extends ApiSingleton<User> {
@@ -570,6 +980,35 @@ declare class Users extends ApiSingleton<User> {
 }
 
 type ResourceTypeLock = 'api_credentials' | 'application_memberships' | 'memberships' | 'organizations' | 'permissions' | 'roles' | 'user' | 'versions';
+declare const resourceList: readonly ["api_credentials", "application_memberships", "memberships", "organizations", "permissions", "roles", "user", "versions"];
+declare const singletonList: readonly ["user"];
+type RetrievableResourceType = ResourceTypeLock;
+type RetrievableResource = Resource & {
+    type: RetrievableResourceType;
+};
+type ListableResourceType = Exclude<ResourceTypeLock, 'user'>;
+type ListableResource = Resource & {
+    type: ListableResourceType;
+};
+type CreatableResourceType = 'api_credentials' | 'application_memberships' | 'memberships' | 'organizations' | 'permissions' | 'roles';
+type CreatableResource = Resource & {
+    type: CreatableResourceType;
+};
+type UpdatableResourceType = 'api_credentials' | 'application_memberships' | 'memberships' | 'organizations' | 'permissions' | 'roles';
+type UpdatableResource = Resource & {
+    type: UpdatableResourceType;
+};
+type DeletableResourceType = 'api_credentials' | 'application_memberships' | 'memberships';
+type DeletableResource = Resource & {
+    type: DeletableResourceType;
+};
+type VersionableResourceType = 'memberships' | 'permissions' | 'roles';
+type VersionableResource = Resource & {
+    type: VersionableResourceType;
+    versions?: Array<ResourceRel & {
+        type: VersionType;
+    }> | null;
+};
 type ResourceFields = {
     api_credentials: ApiCredential;
     application_memberships: ApplicationMembership;
@@ -592,11 +1031,11 @@ type ResourceSortFields = {
 };
 
 declare enum ErrorType {
-    CLIENT = "client",
-    REQUEST = "request",
-    RESPONSE = "response",
-    CANCEL = "cancel",
-    PARSE = "parse",
+    CLIENT = "client",// Generic Client error
+    REQUEST = "request",// Error preparing API request
+    RESPONSE = "response",// Error response from API
+    CANCEL = "cancel",// Forced request abort using interceptor
+    PARSE = "parse",// Error parsing API resource
     TIMEOUT = "timeout"
 }
 declare class SdkError extends Error {
@@ -662,4 +1101,4 @@ declare const CommerceLayerProvisioningStatic: {
     readonly schemaVersion: string;
 };
 
-export { type ApiCredential, type ApiCredentialCreate, type ApiCredentialSort, type ApiCredentialUpdate, ApiError, type ApplicationMembership, type ApplicationMembershipCreate, type ApplicationMembershipSort, type ApplicationMembershipUpdate, CommerceLayerProvisioning, CommerceLayerProvisioningClient, CommerceLayerProvisioningStatic, type ErrorObj, ErrorType, type HeadersObj, type Membership, type MembershipCreate, type MembershipSort, type MembershipUpdate, type Organization, type OrganizationCreate, type OrganizationSort, type OrganizationUpdate, type Permission, type PermissionCreate, type PermissionSort, type PermissionUpdate, type QueryParams, type QueryParamsList, type QueryParamsRetrieve, type RequestObj, type ResponseObj, type Role, type RoleCreate, type RoleSort, type RoleUpdate, SdkError, type User, type UserSort, type UserUpdate, type Version, type VersionSort, CommerceLayerProvisioning as default };
+export { type ApiCredential, type ApiCredentialCreate, type ApiCredentialSort, type ApiCredentialUpdate, ApiCredentials, ApiError, ApiResource, ApiSingleton, type ApplicationMembership, type ApplicationMembershipCreate, type ApplicationMembershipSort, type ApplicationMembershipUpdate, ApplicationMemberships, CommerceLayerProvisioning, CommerceLayerProvisioningClient, CommerceLayerProvisioningStatic, type CreatableResource, type CreatableResourceType, type DeletableResource, type DeletableResourceType, type ErrorObj, ErrorType, type HeadersObj, type ListMeta, ListResponse, type ListableResource, type ListableResourceType, type Membership, type MembershipCreate, type MembershipSort, type MembershipUpdate, Memberships, type Metadata, type Organization, type OrganizationCreate, type OrganizationSort, type OrganizationUpdate, Organizations, type Permission, type PermissionCreate, type PermissionSort, type PermissionUpdate, Permissions, type QueryFilter, type QueryPageSize, type QueryParams, type QueryParamsList, type QueryParamsRetrieve, type RequestObj, type Resource, type ResourceCreate, type ResourceFields, type ResourceFilter, type ResourceId, type ResourceRel, type ResourceSort, type ResourceSortFields, type ResourceType, type ResourceTypeLock, type ResourceUpdate, type ResourcesConfig, type ResourcesInitConfig, type ResponseObj, type RetrievableResource, type RetrievableResourceType, type Role, type RoleCreate, type RoleSort, type RoleUpdate, Roles, SdkError, type UpdatableResource, type UpdatableResourceType, type User, type UserSort, type UserUpdate, Users, type Version, type VersionSort, type VersionableResource, type VersionableResourceType, Versions, apiResourceAdapter, CommerceLayerProvisioning as default, generateQueryStringParams, generateSearchString, isParamsList, resourceList, singletonList };