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

package/lib/index.d.mts

@@ -0,0 +1,1104 @@
+type Fetch = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
+type FetchResponse = any;
+type FetchRequestOptions = RequestInit;
+declare class FetchError extends Error {
+    #private;
+    static isFetchError: (error: any) => error is FetchError;
+    constructor(status: number, statusText: string, body?: any);
+    get errors(): any[] | undefined;
+    get status(): number;
+    get statusText(): string;
+}
+
+type InterceptorEventManager<S extends (RequestInterceptor | ResponseInterceptor), F extends (ErrorInterceptor | ResponseInterceptor)> = {
+    onSuccess?: S;
+    onFailure?: F;
+};
+type RequestEventManager = InterceptorEventManager<RequestInterceptor, ErrorInterceptor>;
+type ResponseEventManager = InterceptorEventManager<ResponseInterceptor, ErrorInterceptor>;
+type ErrorEventManager = InterceptorEventManager<ResponseInterceptor, ResponseInterceptor>;
+type InterceptorManager = {
+    request?: RequestEventManager;
+    response?: ResponseEventManager;
+    rawReader?: ErrorEventManager;
+};
+type RequestObj = {
+    url: URL;
+    options: FetchRequestOptions;
+};
+type RequestInterceptor = (request: RequestObj) => RequestObj | Promise<RequestObj>;
+type ResponseObj = Response;
+type ResponseInterceptor = (response: ResponseObj) => ResponseObj | Promise<ResponseObj>;
+type ApiHeadersList = 'x-ratelimit-limit' | 'x-ratelimit-count' | 'x-ratelimit-period' | 'x-ratelimit-interval' | 'x-ratelimit-remaining';
+type ApiHeaders = {
+    [key in ApiHeadersList]: string | number | boolean;
+};
+type HeadersObj = Record<string, string> | ApiHeaders;
+type ErrorObj = FetchError;
+type ErrorInterceptor = (error: ErrorObj) => ErrorObj | Promise<ErrorObj>;
+type InterceptorType = 'request' | 'response';
+
+type RawResponseReader = {
+    id: number;
+    rawResponse?: any;
+    headers?: HeadersObj;
+    ok: boolean;
+};
+
+type RequestParams = Record<string, string | number | boolean>;
+type RequestHeaders = Record<string, string>;
+type RequestConfig = {
+    timeout?: number;
+    params?: RequestParams;
+    headers?: RequestHeaders;
+    userAgent?: string;
+    fetch?: Fetch;
+};
+type ApiConfig = {
+    domain?: string;
+    accessToken: string;
+};
+type ApiClientInitConfig = ApiConfig & RequestConfig;
+type ApiClientConfig = Partial<ApiClientInitConfig>;
+type Method = 'GET' | 'DELETE' | 'POST' | 'PUT' | 'PATCH';
+declare class ApiClient {
+    #private;
+    static create(options: ApiClientInitConfig): ApiClient;
+    private constructor();
+    get interceptors(): InterceptorManager;
+    get requestHeaders(): RequestHeaders;
+    config(config: ApiClientConfig): this;
+    userAgent(userAgent: string): this;
+    request(method: Method, path: string, body?: any, options?: ApiClientConfig): Promise<FetchResponse>;
+    private customHeaders;
+}
+
+type Nullable<T> = T | null;
+type CreateArrayWithLengthX<LENGTH extends number, ACC extends unknown[] = []> = ACC['length'] extends LENGTH ? ACC : CreateArrayWithLengthX<LENGTH, [...ACC, 1]>;
+type NumericNumberRange<START_ARR extends number[], END extends number, ACC extends number = never> = START_ARR['length'] extends END ? ACC | END : NumericNumberRange<[...START_ARR, 1], END, ACC | START_ARR['length']>;
+type PositiveNumberRange<MAX extends number> = NumericNumberRange<CreateArrayWithLengthX<1>, MAX>;
+type StringKey<T> = Extract<keyof T, string>;
+
+type QueryResType<T extends Resource> = T['type'];
+type QueryInclude = string[];
+type QueryResourceFields<R extends ResourceTypeLock> = keyof ResourceFields[R];
+type QueryArrayFields<R extends Resource> = Array<QueryResourceFields<QueryResType<R>>>;
+type QueryRecordFields = {
+    [key in keyof ResourceFields]?: Array<(QueryResourceFields<key>)>;
+};
+interface QueryParamsRetrieve<R extends Resource = Resource> {
+    include?: QueryInclude;
+    fields?: QueryArrayFields<R> | QueryRecordFields;
+}
+type QuerySortType = 'asc' | 'desc';
+type QueryResourceSortable<R extends Resource> = ResourceSortFields[QueryResType<R>];
+type QueryResourceSortableFields<R extends Resource> = StringKey<QueryResourceSortable<R>>;
+type QueryArraySortable<R extends Resource> = Array<QueryResourceSortableFields<R> | `-${QueryResourceSortableFields<R>}`>;
+type QueryRecordSortable<R extends Resource> = Partial<Record<keyof QueryResourceSortable<R>, QuerySortType>>;
+type QueryFilter = Record<string, string | number | boolean | object | Array<string | number>>;
+type QueryPageNumber = number;
+type QueryPageSize = PositiveNumberRange<25>;
+interface QueryParamsList<R extends Resource = Resource> extends QueryParamsRetrieve<R> {
+    sort?: QueryArraySortable<R> | QueryRecordSortable<R>;
+    filters?: QueryFilter;
+    pageNumber?: QueryPageNumber;
+    pageSize?: QueryPageSize;
+}
+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;
+} & ResourceType;
+type ResourceRel = ResourceId | ResourceNull;
+type Metadata = Record<string, any>;
+interface ResourceType {
+    readonly type: ResourceTypeLock;
+}
+interface ResourceId extends ResourceType {
+    readonly id: string;
+}
+interface ResourceBase {
+    reference?: Nullable<string>;
+    reference_origin?: Nullable<string>;
+    metadata?: Metadata;
+}
+interface Resource extends ResourceBase, ResourceId {
+    readonly created_at: string;
+    readonly updated_at: string;
+}
+interface ResourceCreate extends ResourceBase {
+}
+interface ResourceUpdate extends ResourceBase {
+    readonly id: string;
+}
+type ListMeta = {
+    readonly pageCount: number;
+    readonly recordCount: number;
+    readonly currentPage: number;
+    readonly recordsPerPage: number;
+};
+declare class ListResponse<R> extends Array<R> {
+    readonly meta: ListMeta;
+    constructor(meta: ListMeta, data: R[]);
+    first(): R | undefined;
+    last(): R | undefined;
+    get(index: number): R | undefined;
+    hasNextPage(): boolean;
+    hasPrevPage(): boolean;
+    getRecordCount(): number;
+    getPageCount(): number;
+    get recordCount(): number;
+    get pageCount(): number;
+}
+
+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);
+    private localConfig;
+    config(config: ResourcesConfig): this;
+    get client(): Readonly<ApiClient>;
+    retrieve<R extends Resource>(resource: ResourceId | ResourceType, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
+    list<R extends Resource>(resource: ResourceType, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
+    create<C extends ResourceCreate, R extends Resource>(resource: C & ResourceType, params?: QueryParamsRetrieve<R>, options?: ResourcesConfig): Promise<R>;
+    update<U extends ResourceUpdate, R extends Resource>(resource: U & ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
+    delete(resource: ResourceId, options?: ResourcesConfig): Promise<void>;
+    fetch<R extends Resource>(resource: string | ResourceType, path: string, params?: QueryParams<R>, options?: ResourcesConfig): Promise<R | ListResponse<R>>;
+    action(cmd: Extract<Method, 'POST' | 'PATCH'>, path: string, payload?: any, options?: ResourcesConfig): Promise<void>;
+}
+declare abstract class ApiResourceBase<R extends Resource> {
+    static readonly TYPE: ResourceTypeLock;
+    protected readonly resources: ResourceAdapter;
+    constructor(adapter: ResourceAdapter);
+    abstract relationship(id: string | ResourceId | null): ResourceRel;
+    protected relationshipOneToOne<RR extends ResourceRel>(id: string | ResourceId | null): RR;
+    protected relationshipOneToMany<RR extends ResourceRel>(...ids: string[]): RR[];
+    abstract type(): ResourceTypeLock;
+    parse(resource: string): R | R[];
+    update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
+}
+declare abstract class ApiResource<R extends Resource> extends ApiResourceBase<R> {
+    retrieve(id: string | ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
+    count(filter?: QueryFilter | QueryParamsList, options?: ResourcesConfig): Promise<number>;
+}
+declare abstract class ApiSingleton<R extends Resource> extends ApiResourceBase<R> {
+    retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
+}
+
+type VersionType = 'versions';
+type VersionRel = ResourceRel & {
+    type: VersionType;
+};
+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> {
+    static readonly TYPE: VersionType;
+    isVersion(resource: any): resource is Version;
+    relationship(id: string | ResourceId | null): VersionRel;
+    relationshipToMany(...ids: string[]): VersionRel[];
+    type(): VersionType;
+}
+
+type PermissionType = 'permissions';
+type PermissionRel = ResourceRel & {
+    type: PermissionType;
+};
+type RoleRel$4 = ResourceRel & {
+    type: RoleType;
+};
+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> {
+    static readonly TYPE: PermissionType;
+    create(resource: PermissionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Permission>;
+    update(resource: PermissionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Permission>;
+    organization(permissionId: string | Permission, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
+    role(permissionId: string | Permission, params?: QueryParamsRetrieve<Role>, options?: ResourcesConfig): Promise<Role>;
+    versions(permissionId: string | Permission, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    isPermission(resource: any): resource is Permission;
+    relationship(id: string | ResourceId | null): PermissionRel;
+    relationshipToMany(...ids: string[]): PermissionRel[];
+    type(): PermissionType;
+}
+
+type RoleType = 'roles';
+type RoleRel$3 = ResourceRel & {
+    type: RoleType;
+};
+type OrganizationRel$4 = ResourceRel & {
+    type: OrganizationType;
+};
+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[]>;
+    memberships?: Nullable<Membership[]>;
+    api_credentials?: Nullable<ApiCredential[]>;
+    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> {
+    static readonly TYPE: RoleType;
+    create(resource: RoleCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
+    update(resource: RoleUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Role>;
+    organization(roleId: string | Role, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
+    permissions(roleId: string | Role, params?: QueryParamsList<Permission>, options?: ResourcesConfig): Promise<ListResponse<Permission>>;
+    memberships(roleId: string | Role, params?: QueryParamsList<Membership>, options?: ResourcesConfig): Promise<ListResponse<Membership>>;
+    api_credentials(roleId: string | Role, params?: QueryParamsList<ApiCredential>, options?: ResourcesConfig): Promise<ListResponse<ApiCredential>>;
+    versions(roleId: string | Role, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    isRole(resource: any): resource is Role;
+    relationship(id: string | ResourceId | null): RoleRel$3;
+    relationshipToMany(...ids: string[]): RoleRel$3[];
+    type(): RoleType;
+}
+
+type ApplicationMembershipType = 'application_memberships';
+type ApplicationMembershipRel$1 = ResourceRel & {
+    type: ApplicationMembershipType;
+};
+type ApiCredentialRel$1 = ResourceRel & {
+    type: ApiCredentialType;
+};
+type MembershipRel$1 = ResourceRel & {
+    type: MembershipType;
+};
+type OrganizationRel$3 = ResourceRel & {
+    type: OrganizationType;
+};
+type RoleRel$2 = ResourceRel & {
+    type: RoleType;
+};
+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>;
+    organization?: Nullable<Organization>;
+    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;
+    organization: OrganizationRel$3;
+    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>;
+}
+declare class ApplicationMemberships extends ApiResource<ApplicationMembership> {
+    static readonly TYPE: ApplicationMembershipType;
+    create(resource: ApplicationMembershipCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApplicationMembership>;
+    update(resource: ApplicationMembershipUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApplicationMembership>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    api_credential(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve<ApiCredential>, options?: ResourcesConfig): Promise<ApiCredential>;
+    membership(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve<Membership>, options?: ResourcesConfig): Promise<Membership>;
+    organization(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
+    role(applicationMembershipId: string | ApplicationMembership, params?: QueryParamsRetrieve<Role>, options?: ResourcesConfig): Promise<Role>;
+    isApplicationMembership(resource: any): resource is ApplicationMembership;
+    relationship(id: string | ResourceId | null): ApplicationMembershipRel$1;
+    relationshipToMany(...ids: string[]): ApplicationMembershipRel$1[];
+    type(): ApplicationMembershipType;
+}
+
+type MembershipType = 'memberships';
+type MembershipRel = ResourceRel & {
+    type: MembershipType;
+};
+type OrganizationRel$2 = ResourceRel & {
+    type: OrganizationType;
+};
+type RoleRel$1 = ResourceRel & {
+    type: RoleType;
+};
+type ApplicationMembershipRel = ResourceRel & {
+    type: ApplicationMembershipType;
+};
+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>;
+    application_memberships?: Nullable<ApplicationMembership[]>;
+    versions?: Nullable<Version[]>;
+}
+interface MembershipCreate extends ResourceCreate {
+    /**
+     * The user email..
+     * @example ```"commercelayer@commercelayer.io"```
+     */
+    user_email: string;
+    organization: OrganizationRel$2;
+    role: RoleRel$1;
+    application_memberships?: Nullable<ApplicationMembershipRel[]>;
+}
+interface MembershipUpdate extends ResourceUpdate {
+    role?: Nullable<RoleRel$1>;
+    application_memberships?: Nullable<ApplicationMembershipRel[]>;
+}
+declare class Memberships extends ApiResource<Membership> {
+    static readonly TYPE: MembershipType;
+    create(resource: MembershipCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Membership>;
+    update(resource: MembershipUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Membership>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    resend(membershipId: string | Membership, options?: ResourcesConfig): Promise<void>;
+    organization(membershipId: string | Membership, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
+    role(membershipId: string | Membership, params?: QueryParamsRetrieve<Role>, options?: ResourcesConfig): Promise<Role>;
+    application_memberships(membershipId: string | Membership, params?: QueryParamsList<ApplicationMembership>, options?: ResourcesConfig): Promise<ListResponse<ApplicationMembership>>;
+    versions(membershipId: string | Membership, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    isMembership(resource: any): resource is Membership;
+    relationship(id: string | ResourceId | null): MembershipRel;
+    relationshipToMany(...ids: string[]): MembershipRel[];
+    type(): MembershipType;
+}
+
+type OrganizationType = 'organizations';
+type OrganizationRel$1 = ResourceRel & {
+    type: OrganizationType;
+};
+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[]>;
+    permissions?: Nullable<Permission[]>;
+    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> {
+    static readonly TYPE: OrganizationType;
+    create(resource: OrganizationCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
+    update(resource: OrganizationUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
+    transfer_ownership(organizationId: string | Organization, payload: TransferOwnershipDataType, options?: ResourcesConfig): Promise<void>;
+    memberships(organizationId: string | Organization, params?: QueryParamsList<Membership>, options?: ResourcesConfig): Promise<ListResponse<Membership>>;
+    roles(organizationId: string | Organization, params?: QueryParamsList<Role>, options?: ResourcesConfig): Promise<ListResponse<Role>>;
+    permissions(organizationId: string | Organization, params?: QueryParamsList<Permission>, options?: ResourcesConfig): Promise<ListResponse<Permission>>;
+    api_credentials(organizationId: string | Organization, params?: QueryParamsList<ApiCredential>, options?: ResourcesConfig): Promise<ListResponse<ApiCredential>>;
+    isOrganization(resource: any): resource is Organization;
+    relationship(id: string | ResourceId | null): OrganizationRel$1;
+    relationshipToMany(...ids: string[]): OrganizationRel$1[];
+    type(): OrganizationType;
+}
+
+type TransferOwnershipDataType = {
+    type: 'organizations';
+    id: string;
+    new_owner_email: string;
+};
+
+type ApiCredentialType = 'api_credentials';
+type ApiCredentialRel = ResourceRel & {
+    type: ApiCredentialType;
+};
+type OrganizationRel = ResourceRel & {
+    type: OrganizationType;
+};
+type RoleRel = ResourceRel & {
+    type: RoleType;
+};
+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>;
+}
+declare class ApiCredentials extends ApiResource<ApiCredential> {
+    static readonly TYPE: ApiCredentialType;
+    create(resource: ApiCredentialCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApiCredential>;
+    update(resource: ApiCredentialUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ApiCredential>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    organization(apiCredentialId: string | ApiCredential, params?: QueryParamsRetrieve<Organization>, options?: ResourcesConfig): Promise<Organization>;
+    role(apiCredentialId: string | ApiCredential, params?: QueryParamsRetrieve<Role>, options?: ResourcesConfig): Promise<Role>;
+    isApiCredential(resource: any): resource is ApiCredential;
+    relationship(id: string | ResourceId | null): ApiCredentialRel;
+    relationshipToMany(...ids: string[]): ApiCredentialRel[];
+    type(): ApiCredentialType;
+}
+
+type UserType = 'user';
+type UserRel = ResourceRel & {
+    type: UserType;
+};
+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> {
+    static readonly TYPE: UserType;
+    update(resource: UserUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<User>;
+    isUser(resource: any): resource is User;
+    relationship(id: string | ResourceId | null): UserRel;
+    relationshipToMany(...ids: string[]): UserRel[];
+    type(): UserType;
+}
+
+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;
+    memberships: Membership;
+    organizations: Organization;
+    permissions: Permission;
+    roles: Role;
+    user: User;
+    versions: Version;
+};
+type ResourceSortFields = {
+    api_credentials: ApiCredentialSort;
+    application_memberships: ApplicationMembershipSort;
+    memberships: MembershipSort;
+    organizations: OrganizationSort;
+    permissions: PermissionSort;
+    roles: RoleSort;
+    user: UserSort;
+    versions: VersionSort;
+};
+
+declare enum ErrorType {
+    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 {
+    static NAME: string;
+    static isSdkError(error: any): error is SdkError;
+    type: ErrorType;
+    code?: string;
+    source?: Error;
+    constructor(error: {
+        message: string;
+        type?: ErrorType;
+    });
+}
+declare class ApiError extends SdkError {
+    static NAME: string;
+    static isApiError(error: any): error is ApiError;
+    errors: any[];
+    status?: number;
+    statusText?: string;
+    constructor(error: SdkError);
+    first(): any;
+}
+
+type SdkConfig = {};
+type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
+type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
+declare class CommerceLayerProvisioningClient {
+    #private;
+    readonly openApiSchemaVersion = "1.0.4";
+    constructor(config: CommerceLayerInitConfig);
+    get api_credentials(): ApiCredentials;
+    get application_memberships(): ApplicationMemberships;
+    get memberships(): Memberships;
+    get organizations(): Organizations;
+    get permissions(): Permissions;
+    get roles(): Roles;
+    get user(): Users;
+    get versions(): Versions;
+    private get interceptors();
+    private localConfig;
+    config(config: CommerceLayerConfig): this;
+    resources(): readonly string[];
+    singletons(): readonly string[];
+    isSingleton(resource: ResourceTypeLock): boolean;
+    isApiError(error: any): error is ApiError;
+    addRequestInterceptor(onSuccess?: RequestInterceptor, onFailure?: ErrorInterceptor): number;
+    addResponseInterceptor(onSuccess?: ResponseInterceptor, onFailure?: ErrorInterceptor): number;
+    removeInterceptor(type: InterceptorType, id?: number): void;
+    addRawResponseReader(options?: {
+        headers: boolean;
+    }): RawResponseReader;
+    removeRawResponseReader(reader?: number | RawResponseReader): void;
+}
+declare const CommerceLayerProvisioning: (config: CommerceLayerInitConfig) => CommerceLayerProvisioningClient;
+
+declare const CommerceLayerProvisioningStatic: {
+    resources: (sort?: boolean) => readonly string[];
+    singletons: (sort?: boolean) => readonly string[];
+    isSingleton: (resource: ResourceTypeLock) => boolean;
+    isSdkError: (error: unknown) => error is SdkError;
+    isApiError: (error: unknown) => error is ApiError;
+    init: (config: CommerceLayerInitConfig) => CommerceLayerProvisioningClient;
+    readonly schemaVersion: string;
+};
+
+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 };