@commercelayer/provisioning-sdk 3.0.0-beta.2 → 3.0.0

package/README.md

@@ -18,6 +18,7 @@ A JavaScript Library wrapper that makes it quick and easy to interact with the [
 - [Authentication](#authentication)
 - [Import](#import)
 - [Options](#options)
+- [API version](#api-version)
 - [SDK usage](#sdk-usage)
 - [Overriding credentials](#overriding-credentials)
 - [Handling validation errors](#handling-validation-errors)
@@ -58,8 +59,9 @@ You can use the ES6 default import with the SDK like so:
 ```javascript
 import CommerceLayerProvisioning from '@commercelayer/provisioning-sdk'
 
-const cl = CommerceLayer({
-  accessToken: 'your-access-token'
+const clp = CommerceLayerProvisioning({
+  accessToken: 'your-access-token',
+  apiVersion: '2026-05'
 })
 ```
 
@@ -70,6 +72,7 @@ When instantiating a new SDK client you can pass some options to initialize it:
 ```javascript
 {
   accessToken: string         // A valid API access token
+  apiVersion: ApiVersion      // The API version to target, e.g. '2026-05' — required, see API version below
   timeout?: number            // A custom request timout (<= 15 secs [default])
   headers?: RequestHeaders    // Custom request headers
   userAgent?: string          // Custom user-agent useful in certaing contexts but often not allowed by browsers
@@ -84,15 +87,31 @@ Same options can be changed after SDK initialization or passed at runtime while
   const options = { ... }
 
   // Instantiate the client using desired options
-  const clp = CommerceLayer(options)
+  const clp = CommerceLayerProvisioning(options)
 
   // Change configuration after client cteation
   clp.config(options)
 
   // Use runtime configuration without persisting settings
-  clp.customers.organizations({}, options)
+  clp.organizations.list({}, options)
 ```
 
+### API version
+
+The Provisioning API is versioned, and every request targets a single version. `apiVersion` is therefore **required** when creating a client, and becomes part of each request URL — `/api/2026-05/organizations`.
+
+Only the versions this release of the SDK was generated for are accepted; any other value is a type error. Both are exported:
+
+```javascript
+import { API_SCHEMA_VERSION, API_SUPPORTED_VERSIONS } from '@commercelayer/provisioning-sdk'
+
+API_SUPPORTED_VERSIONS // ['2026-05'] — the versions you can target
+API_SCHEMA_VERSION     // '2026-05' — the version the types describe
+```
+
+> [!IMPORTANT]
+> Upgrading from 2.x: `apiVersion` is new and required, so every `CommerceLayerProvisioning(...)` call needs it.
+
 ## SDK usage
 
 The JavaScript Provisioning SDK is a wrapper around Commerce Layer Provisioning API which means you would still be making API requests but with a different syntax. For now, we don't have comprehensive SDK documentation for every single resource our API supports, hence you will need to rely on our comprehensive [Provisioning API Reference](https://docs.commercelayer.io/provisioning/v/api-reference-p) as you go about using this SDK. So for example, if you want to create a role, take a look at the [Role object](https://docs.commercelayer.io/provisioning/v/api-reference-p/role/object) or the [Create a role](https://docs.commercelayer.io/provisioning/v/api-reference-p/roles/create) documentation to see the required attributes and/or relationships. The same goes for every other supported resource.

package/lib/{api-C_E9e1ea.d.ts → api-CnrR2t1g.d.ts}

@@ -108,9 +108,24 @@ interface ResourceBase {
     reference_origin?: string | null;
     metadata?: Metadata;
 }
+/**
+ * The JSON:API `meta` member of a resource object — server-supplied facts about
+ * the resource rather than fields of it. Not to be confused with `metadata`,
+ * which is a user-writable attribute.
+ *
+ * Distinct from the document-level `meta` of a list response, which is what
+ * `ListMeta` reflects.
+ */
+type ResourceMeta = {
+    /** The API version the resource was created with, when the API reports it. */
+    readonly created_with_version?: string;
+    readonly [key: string]: unknown;
+};
 interface Resource extends ResourceBase, ResourceId {
     readonly created_at: string;
     readonly updated_at: string;
+    /** Present only when the API returns a `meta` member for this resource. */
+    readonly meta?: ResourceMeta;
 }
 interface ResourceCreate extends ResourceBase {
 }
@@ -233,27 +248,27 @@ interface Version extends Resource {
      * The type of the versioned resource.
      * @example ```"roles"```
      */
-    resource_type?: string | null;
+    resource_type: string;
     /**
      * The versioned resource ID.
      * @example ```"PzdJhdLdYV"```
      */
-    resource_id?: string | null;
+    resource_id: string;
     /**
      * The event which generates the version.
      * @example ```"update"```
      */
-    event?: string | null;
+    event: string;
     /**
      * The object changes payload.
      * @example ```{"name":["previous","new"]}```
      */
-    changes?: Record<string, any> | null;
+    changes: Record<string, any>;
     /**
      * Information about who triggered the change, only showed when it's from a JWT token.
      * @example ```{"application":{"id":"DNOPYiZYpn","kind":"integration","public":true}}```
      */
-    who?: Record<string, any> | null;
+    who: Record<string, any>;
 }
 declare class Versions extends ApiResource<Version> {
     static readonly TYPE: VersionType;
@@ -387,7 +402,7 @@ interface Role extends Resource {
      * The kind of role, one of: `custom`, `admin`, `read_only`.
      * @example ```"custom"```
      */
-    kind?: string | null;
+    kind: string;
     organization?: Organization | null;
     permissions?: Permission[] | null;
     memberships?: Membership[] | null;
@@ -464,12 +479,12 @@ interface Membership extends Resource {
      * The user first name.
      * @example ```"John"```
      */
-    user_first_name?: string | null;
+    user_first_name: string;
     /**
      * The user last name.
      * @example ```"Doe"```
      */
-    user_last_name?: string | null;
+    user_last_name: string;
     /**
      * The memberships status. One of `pending` (default), `active`.
      * @example ```"pending"```
@@ -479,12 +494,12 @@ interface Membership extends Resource {
      * Indicates if the user it's the owner of the organization.
      * @example ```true```
      */
-    owner?: boolean | null;
+    owner: boolean;
     /**
      * Reflects the organization's access scope, either test_access or all_access.
      * @example ```true```
      */
-    test_enabled?: boolean | null;
+    test_enabled: boolean;
     /**
      * The access scope for applications. One of `live_access` (default), `test_access`, `all_access`.
      * @example ```"live_access"```
@@ -561,12 +576,12 @@ interface Organization extends Resource {
      * The organization's slug name.
      * @example ```"the-blue-brand"```
      */
-    slug?: string | null;
+    slug: string;
     /**
      * The organization's domain.
      * @example ```"the-blue-brand.commercelayer.io"```
      */
-    domain?: string | null;
+    domain: string;
     /**
      * The organization's support phone.
      * @example ```"+01 30800857"```
@@ -615,12 +630,12 @@ interface Organization extends Resource {
     /**
      * Indicates if the organization can switch to live mode.
      */
-    can_switch_live?: boolean | null;
+    can_switch_live: boolean;
     /**
      * Information about the current subscription such as the plan type, limits, and subscription totals counter.
      * @example ```{"plan_type":"growth","limits":{"markets":5,"skus":10000,"organizations":2,"memberships":5},"totals":{"organizations":1,"markets":0,"memberships":2,"skus":0}}```
      */
-    subscription_info?: Record<string, any> | null;
+    subscription_info: Record<string, any>;
     /**
      * The organization's configuration.
      * @example ```{"mfe":{"language":"it-IT","default":{"links":{"cart":"https://cart.example.com/:order_id?accessToken=:access_token","checkout":"https://checkout.example.com/:order_id?accessToken=:access_token","identity":"https://example.com/login","microstore":"https://example.com/microstore/?accessToken=:access_token","my_account":"https://example.com/my-custom-account?accessToken=:access_token"},"checkout":{"optional_billing_info":false,"thankyou_page":"https://example.com/thanks/:lang/:order_id","billing_countries":[{"value":"ES","label":"Espana"},{"value":"IT","label":"Italia"},{"value":"US","label":"Unites States of America"}],"shipping_countries":[{"value":"ES","label":"Espana"},{"value":"IT","label":"Italia"},{"value":"US","label":"Unites States of America"}],"billing_states":{"FR":[{"value":"PA","label":"Paris"},{"value":"LY","label":"Lyon"},{"value":"NI","label":"Nice"},{"value":"MA","label":"Marseille"},{"value":"BO","label":"Bordeaux"}]},"shipping_states":{"FR":[{"value":"PA","label":"Paris"},{"value":"LY","label":"Lyon"},{"value":"NI","label":"Nice"},{"value":"MA","label":"Marseille"},{"value":"BO","label":"Bordeaux"}]},"default_country":"US"},"urls":{"privacy":"https://example.com/privacy/:lang","terms":"https://example.com/terms/:lang"}},"market:id:ZKcv13rT":{"links":{"cart":"https://example.com/custom-cart/:order_id?accessToken=:access_token"},"checkout":{"thankyou_page":"https://example.com/thanks/:order_id"}}},"well-known":{"shopping":{"catalog_mcp_url":"https://catalog-mcp.example.com/mcp","client_id":"abc123example","locale_scopes":{"it-IT":{"id":"ZKcv13rT"},"en-US":{"id":"ZKcv13rT"}},"ui":{"domain":"","csp":{"resourceDomains":["https://data.commercelayer.app","https://cdn.brand.com"],"baseUriDomains":[],"connectDomains":[],"frameDomains":[]}}}}}```
@@ -752,6 +767,11 @@ interface Organization extends Resource {
      * @example ```40```
      */
     gift_cards_max_code_length?: number | null;
+    /**
+     * Enables automatic restoration of the gift card balance when an order is cancelled or reopened for editing, default is {GIFT_CARDS_AUTO_RESTORE}.
+     * @example ```true```
+     */
+    gift_cards_auto_restore?: boolean | null;
     /**
      * The maximum number of concurrent cleanups allowed for your organization, default is {CLEANUPS_MAX_CONCURRENT_COUNT}.
      * @example ```10```
@@ -850,6 +870,10 @@ interface Organization extends Resource {
      * Enables the creation of the authorization when the gateway event is received, even if there is no reference on Commerce Layer.
      */
     payment_gateways_transaction_on_event?: boolean | null;
+    /**
+     * Enables blocking a new refund (or compensation) on a capture while an earlier async refund on the same capture is still unresolved.
+     */
+    refunds_check_for_pending?: boolean | null;
     memberships?: Membership[] | null;
     roles?: Role[] | null;
     permissions?: Permission[] | null;
@@ -1007,7 +1031,7 @@ interface MembershipProfile extends Resource {
      * Reflects the organization's access scope, either test_access or all_access.
      * @example ```true```
      */
-    test_enabled?: boolean | null;
+    test_enabled: boolean;
     /**
      * The access scope for applications. One of `live_access` (default), `test_access`, `all_access`.
      * @example ```"live_access"```
@@ -1151,12 +1175,12 @@ interface User extends Resource {
      */
     email: string;
     /**
-     * The user first name.
+     * The user first name. Maximum 100 characters. HTML is stripped.
      * @example ```"John"```
      */
     first_name: string;
     /**
-     * The user last name.
+     * The user last name. Maximum 100 characters. HTML is stripped.
      * @example ```"Doe"```
      */
     last_name: string;
@@ -1169,7 +1193,7 @@ interface User extends Resource {
      * The user 2FA setting.
      * @example ```true```
      */
-    otp_required_for_login?: boolean | null;
+    otp_required_for_login: boolean;
 }
 interface UserUpdate extends SingletonUpdate {
     /**
@@ -1178,12 +1202,12 @@ interface UserUpdate extends SingletonUpdate {
      */
     email?: string | null;
     /**
-     * The user first name.
+     * The user first name. Maximum 100 characters. HTML is stripped.
      * @example ```"John"```
      */
     first_name?: string | null;
     /**
-     * The user last name.
+     * The user last name. Maximum 100 characters. HTML is stripped.
      * @example ```"Doe"```
      */
     last_name?: string | null;
@@ -1265,7 +1289,7 @@ interface IdentityProvider extends Resource {
      * The TXT record value used to check the domain.
      * @example ```"cl-verification=a6CDk5v"```
      */
-    txt_record?: string | null;
+    txt_record: string;
     /**
      * The organization identifier for authorize params.
      * @example ```"org_76gsfs5gd"```
@@ -1539,7 +1563,7 @@ interface ApiCredential extends Resource {
      * Indicates if the API credential it's confidential.
      * @example ```true```
      */
-    confidential?: boolean | null;
+    confidential: boolean;
     /**
      * The API credential redirect URI.
      * @example ```"https://bluebrand.com/img/logo.svg"```
@@ -1549,17 +1573,17 @@ interface ApiCredential extends Resource {
      * The API credential unique ID.
      * @example ```"xxxx-yyyy-zzzz"```
      */
-    client_id?: string | null;
+    client_id: string;
     /**
      * The API credential unique secret.
      * @example ```"xxxx-yyyy-zzzz"```
      */
-    client_secret?: string | null;
+    client_secret: string;
     /**
      * The API credential scopes.
      * @example ```"market:all market:9 market:122 market:6 stock_location:6 stock_location:33"```
      */
-    scopes?: string | null;
+    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```
@@ -1642,4 +1666,4 @@ declare class ApiCredentials extends ApiResource<ApiCredential> {
 }
 declare const instance: ApiCredentials;
 
-export { type QueryFilter as $, type ApiCredential as A, type MembershipProfileSort as B, type CreatableResource as C, type DeletableResource as D, type ErrorObj as E, type MembershipProfileUpdate as F, MembershipProfiles as G, type HeadersObj as H, type IdentityProvider as I, type MembershipSort as J, type MembershipUpdate as K, type ListMeta as L, type Membership as M, Memberships as N, type Metadata as O, type Organization as P, type OrganizationCreate as Q, type ResourceFields as R, type OrganizationSort as S, type OrganizationUpdate as T, Organizations as U, type Permission as V, type PermissionCreate as W, type PermissionSort as X, type PermissionUpdate as Y, Permissions as Z, type QueryFields as _, type ResourceSortFields as a, creatableResources as a$, type QueryInclude as a0, type QueryPageCursor as a1, type QueryPageNumber as a2, type QueryPageSize as a3, type QueryParams as a4, type QueryParamsList as a5, type QueryParamsRetrieve as a6, type QuerySort as a7, type RequestObj as a8, type Resource as a9, Versions as aA, resourceList as aB, singletonList as aC, ResourceAdapter as aD, type RequestInterceptor as aE, type ErrorInterceptor as aF, type ResponseInterceptor as aG, type InterceptorType as aH, type RawResponseReader as aI, type VersionType as aJ, instance$9 as aK, type PermissionType as aL, instance$8 as aM, type RoleType as aN, instance$7 as aO, type MembershipType as aP, instance$6 as aQ, type OrganizationType as aR, instance$5 as aS, type MembershipProfileType as aT, instance$4 as aU, type ApplicationMembershipType as aV, instance$3 as aW, type UserType as aX, instance$2 as aY, type IdentityProviderType as aZ, instance$1 as a_, type ResourceCreate as aa, type ResourceFilter as ab, type ResourceId as ac, type ResourceRel as ad, type ResourceSort as ae, type ResourceType as af, type ResourceUpdate as ag, type ResourcesConfig as ah, type ResourcesInitConfig as ai, type ResponseObj as aj, type RetrievableResource as ak, type RetrievableResourceType as al, type Role as am, type RoleCreate as an, type RoleSort as ao, type RoleUpdate as ap, Roles as aq, type SingletonUpdate as ar, type UpdatableResource as as, type UpdatableResourceType as at, type User as au, type UserSort as av, type UserUpdate as aw, Users as ax, type Version as ay, type VersionSort as az, type ResourceTypeLock as b, deletableResources as b0, getSingletons as b1, isCreatable as b2, isDeletable as b3, isSingleton as b4, isUpdatable as b5, updatableResources as b6, type ApiCredentialType as b7, instance as b8, type ApiCredentialCreate as c, type ApiCredentialSort as d, type ApiCredentialUpdate as e, ApiCredentials as f, getResources as g, ApiResource as h, ApiSingleton as i, type ApplicationMembership as j, type ApplicationMembershipCreate as k, type ApplicationMembershipSort as l, type ApplicationMembershipUpdate as m, ApplicationMemberships as n, type CreatableResourceType as o, type DeletableResourceType as p, type IdentityProviderCreate as q, type IdentityProviderSort as r, type IdentityProviderUpdate as s, IdentityProviders as t, ListResponse as u, type ListableResource as v, type ListableResourceType as w, type MembershipCreate as x, type MembershipProfile as y, type MembershipProfileCreate as z };
+export { type QueryFilter as $, type ApiCredential as A, type MembershipProfileSort as B, type CreatableResource as C, type DeletableResource as D, type ErrorObj as E, type MembershipProfileUpdate as F, MembershipProfiles as G, type HeadersObj as H, type IdentityProvider as I, type MembershipSort as J, type MembershipUpdate as K, type ListMeta as L, type Membership as M, Memberships as N, type Metadata as O, type Organization as P, type OrganizationCreate as Q, type ResourceFields as R, type OrganizationSort as S, type OrganizationUpdate as T, Organizations as U, type Permission as V, type PermissionCreate as W, type PermissionSort as X, type PermissionUpdate as Y, Permissions as Z, type QueryFields as _, type ResourceSortFields as a, instance$1 as a$, type QueryInclude as a0, type QueryPageCursor as a1, type QueryPageNumber as a2, type QueryPageSize as a3, type QueryParams as a4, type QueryParamsList as a5, type QueryParamsRetrieve as a6, type QuerySort as a7, type RequestObj as a8, type Resource as a9, type VersionSort as aA, Versions as aB, resourceList as aC, singletonList as aD, ResourceAdapter as aE, type RequestInterceptor as aF, type ErrorInterceptor as aG, type ResponseInterceptor as aH, type InterceptorType as aI, type RawResponseReader as aJ, type VersionType as aK, instance$9 as aL, type PermissionType as aM, instance$8 as aN, type RoleType as aO, instance$7 as aP, type MembershipType as aQ, instance$6 as aR, type OrganizationType as aS, instance$5 as aT, type MembershipProfileType as aU, instance$4 as aV, type ApplicationMembershipType as aW, instance$3 as aX, type UserType as aY, instance$2 as aZ, type IdentityProviderType as a_, type ResourceCreate as aa, type ResourceFilter as ab, type ResourceId as ac, type ResourceMeta as ad, type ResourceRel as ae, type ResourceSort as af, type ResourceType as ag, type ResourceUpdate as ah, type ResourcesConfig as ai, type ResourcesInitConfig as aj, type ResponseObj as ak, type RetrievableResource as al, type RetrievableResourceType as am, type Role as an, type RoleCreate as ao, type RoleSort as ap, type RoleUpdate as aq, Roles as ar, type SingletonUpdate as as, type UpdatableResource as at, type UpdatableResourceType as au, type User as av, type UserSort as aw, type UserUpdate as ax, Users as ay, type Version as az, type ResourceTypeLock as b, creatableResources as b0, deletableResources as b1, getSingletons as b2, isCreatable as b3, isDeletable as b4, isSingleton as b5, isUpdatable as b6, updatableResources as b7, type ApiCredentialType as b8, instance as b9, type ApiCredentialCreate as c, type ApiCredentialSort as d, type ApiCredentialUpdate as e, ApiCredentials as f, getResources as g, ApiResource as h, ApiSingleton as i, type ApplicationMembership as j, type ApplicationMembershipCreate as k, type ApplicationMembershipSort as l, type ApplicationMembershipUpdate as m, ApplicationMemberships as n, type CreatableResourceType as o, type DeletableResourceType as p, type IdentityProviderCreate as q, type IdentityProviderSort as r, type IdentityProviderUpdate as s, IdentityProviders as t, ListResponse as u, type ListableResource as v, type ListableResourceType as w, type MembershipCreate as x, type MembershipProfile as y, type MembershipProfileCreate as z };

package/lib/{api-C4jp_9vb.d.cts → api-R3mMNn87.d.cts}

@@ -108,9 +108,24 @@ interface ResourceBase {
     reference_origin?: string | null;
     metadata?: Metadata;
 }
+/**
+ * The JSON:API `meta` member of a resource object — server-supplied facts about
+ * the resource rather than fields of it. Not to be confused with `metadata`,
+ * which is a user-writable attribute.
+ *
+ * Distinct from the document-level `meta` of a list response, which is what
+ * `ListMeta` reflects.
+ */
+type ResourceMeta = {
+    /** The API version the resource was created with, when the API reports it. */
+    readonly created_with_version?: string;
+    readonly [key: string]: unknown;
+};
 interface Resource extends ResourceBase, ResourceId {
     readonly created_at: string;
     readonly updated_at: string;
+    /** Present only when the API returns a `meta` member for this resource. */
+    readonly meta?: ResourceMeta;
 }
 interface ResourceCreate extends ResourceBase {
 }
@@ -233,27 +248,27 @@ interface Version extends Resource {
      * The type of the versioned resource.
      * @example ```"roles"```
      */
-    resource_type?: string | null;
+    resource_type: string;
     /**
      * The versioned resource ID.
      * @example ```"PzdJhdLdYV"```
      */
-    resource_id?: string | null;
+    resource_id: string;
     /**
      * The event which generates the version.
      * @example ```"update"```
      */
-    event?: string | null;
+    event: string;
     /**
      * The object changes payload.
      * @example ```{"name":["previous","new"]}```
      */
-    changes?: Record<string, any> | null;
+    changes: Record<string, any>;
     /**
      * Information about who triggered the change, only showed when it's from a JWT token.
      * @example ```{"application":{"id":"DNOPYiZYpn","kind":"integration","public":true}}```
      */
-    who?: Record<string, any> | null;
+    who: Record<string, any>;
 }
 declare class Versions extends ApiResource<Version> {
     static readonly TYPE: VersionType;
@@ -387,7 +402,7 @@ interface Role extends Resource {
      * The kind of role, one of: `custom`, `admin`, `read_only`.
      * @example ```"custom"```
      */
-    kind?: string | null;
+    kind: string;
     organization?: Organization | null;
     permissions?: Permission[] | null;
     memberships?: Membership[] | null;
@@ -464,12 +479,12 @@ interface Membership extends Resource {
      * The user first name.
      * @example ```"John"```
      */
-    user_first_name?: string | null;
+    user_first_name: string;
     /**
      * The user last name.
      * @example ```"Doe"```
      */
-    user_last_name?: string | null;
+    user_last_name: string;
     /**
      * The memberships status. One of `pending` (default), `active`.
      * @example ```"pending"```
@@ -479,12 +494,12 @@ interface Membership extends Resource {
      * Indicates if the user it's the owner of the organization.
      * @example ```true```
      */
-    owner?: boolean | null;
+    owner: boolean;
     /**
      * Reflects the organization's access scope, either test_access or all_access.
      * @example ```true```
      */
-    test_enabled?: boolean | null;
+    test_enabled: boolean;
     /**
      * The access scope for applications. One of `live_access` (default), `test_access`, `all_access`.
      * @example ```"live_access"```
@@ -561,12 +576,12 @@ interface Organization extends Resource {
      * The organization's slug name.
      * @example ```"the-blue-brand"```
      */
-    slug?: string | null;
+    slug: string;
     /**
      * The organization's domain.
      * @example ```"the-blue-brand.commercelayer.io"```
      */
-    domain?: string | null;
+    domain: string;
     /**
      * The organization's support phone.
      * @example ```"+01 30800857"```
@@ -615,12 +630,12 @@ interface Organization extends Resource {
     /**
      * Indicates if the organization can switch to live mode.
      */
-    can_switch_live?: boolean | null;
+    can_switch_live: boolean;
     /**
      * Information about the current subscription such as the plan type, limits, and subscription totals counter.
      * @example ```{"plan_type":"growth","limits":{"markets":5,"skus":10000,"organizations":2,"memberships":5},"totals":{"organizations":1,"markets":0,"memberships":2,"skus":0}}```
      */
-    subscription_info?: Record<string, any> | null;
+    subscription_info: Record<string, any>;
     /**
      * The organization's configuration.
      * @example ```{"mfe":{"language":"it-IT","default":{"links":{"cart":"https://cart.example.com/:order_id?accessToken=:access_token","checkout":"https://checkout.example.com/:order_id?accessToken=:access_token","identity":"https://example.com/login","microstore":"https://example.com/microstore/?accessToken=:access_token","my_account":"https://example.com/my-custom-account?accessToken=:access_token"},"checkout":{"optional_billing_info":false,"thankyou_page":"https://example.com/thanks/:lang/:order_id","billing_countries":[{"value":"ES","label":"Espana"},{"value":"IT","label":"Italia"},{"value":"US","label":"Unites States of America"}],"shipping_countries":[{"value":"ES","label":"Espana"},{"value":"IT","label":"Italia"},{"value":"US","label":"Unites States of America"}],"billing_states":{"FR":[{"value":"PA","label":"Paris"},{"value":"LY","label":"Lyon"},{"value":"NI","label":"Nice"},{"value":"MA","label":"Marseille"},{"value":"BO","label":"Bordeaux"}]},"shipping_states":{"FR":[{"value":"PA","label":"Paris"},{"value":"LY","label":"Lyon"},{"value":"NI","label":"Nice"},{"value":"MA","label":"Marseille"},{"value":"BO","label":"Bordeaux"}]},"default_country":"US"},"urls":{"privacy":"https://example.com/privacy/:lang","terms":"https://example.com/terms/:lang"}},"market:id:ZKcv13rT":{"links":{"cart":"https://example.com/custom-cart/:order_id?accessToken=:access_token"},"checkout":{"thankyou_page":"https://example.com/thanks/:order_id"}}},"well-known":{"shopping":{"catalog_mcp_url":"https://catalog-mcp.example.com/mcp","client_id":"abc123example","locale_scopes":{"it-IT":{"id":"ZKcv13rT"},"en-US":{"id":"ZKcv13rT"}},"ui":{"domain":"","csp":{"resourceDomains":["https://data.commercelayer.app","https://cdn.brand.com"],"baseUriDomains":[],"connectDomains":[],"frameDomains":[]}}}}}```
@@ -752,6 +767,11 @@ interface Organization extends Resource {
      * @example ```40```
      */
     gift_cards_max_code_length?: number | null;
+    /**
+     * Enables automatic restoration of the gift card balance when an order is cancelled or reopened for editing, default is {GIFT_CARDS_AUTO_RESTORE}.
+     * @example ```true```
+     */
+    gift_cards_auto_restore?: boolean | null;
     /**
      * The maximum number of concurrent cleanups allowed for your organization, default is {CLEANUPS_MAX_CONCURRENT_COUNT}.
      * @example ```10```
@@ -850,6 +870,10 @@ interface Organization extends Resource {
      * Enables the creation of the authorization when the gateway event is received, even if there is no reference on Commerce Layer.
      */
     payment_gateways_transaction_on_event?: boolean | null;
+    /**
+     * Enables blocking a new refund (or compensation) on a capture while an earlier async refund on the same capture is still unresolved.
+     */
+    refunds_check_for_pending?: boolean | null;
     memberships?: Membership[] | null;
     roles?: Role[] | null;
     permissions?: Permission[] | null;
@@ -1007,7 +1031,7 @@ interface MembershipProfile extends Resource {
      * Reflects the organization's access scope, either test_access or all_access.
      * @example ```true```
      */
-    test_enabled?: boolean | null;
+    test_enabled: boolean;
     /**
      * The access scope for applications. One of `live_access` (default), `test_access`, `all_access`.
      * @example ```"live_access"```
@@ -1151,12 +1175,12 @@ interface User extends Resource {
      */
     email: string;
     /**
-     * The user first name.
+     * The user first name. Maximum 100 characters. HTML is stripped.
      * @example ```"John"```
      */
     first_name: string;
     /**
-     * The user last name.
+     * The user last name. Maximum 100 characters. HTML is stripped.
      * @example ```"Doe"```
      */
     last_name: string;
@@ -1169,7 +1193,7 @@ interface User extends Resource {
      * The user 2FA setting.
      * @example ```true```
      */
-    otp_required_for_login?: boolean | null;
+    otp_required_for_login: boolean;
 }
 interface UserUpdate extends SingletonUpdate {
     /**
@@ -1178,12 +1202,12 @@ interface UserUpdate extends SingletonUpdate {
      */
     email?: string | null;
     /**
-     * The user first name.
+     * The user first name. Maximum 100 characters. HTML is stripped.
      * @example ```"John"```
      */
     first_name?: string | null;
     /**
-     * The user last name.
+     * The user last name. Maximum 100 characters. HTML is stripped.
      * @example ```"Doe"```
      */
     last_name?: string | null;
@@ -1265,7 +1289,7 @@ interface IdentityProvider extends Resource {
      * The TXT record value used to check the domain.
      * @example ```"cl-verification=a6CDk5v"```
      */
-    txt_record?: string | null;
+    txt_record: string;
     /**
      * The organization identifier for authorize params.
      * @example ```"org_76gsfs5gd"```
@@ -1539,7 +1563,7 @@ interface ApiCredential extends Resource {
      * Indicates if the API credential it's confidential.
      * @example ```true```
      */
-    confidential?: boolean | null;
+    confidential: boolean;
     /**
      * The API credential redirect URI.
      * @example ```"https://bluebrand.com/img/logo.svg"```
@@ -1549,17 +1573,17 @@ interface ApiCredential extends Resource {
      * The API credential unique ID.
      * @example ```"xxxx-yyyy-zzzz"```
      */
-    client_id?: string | null;
+    client_id: string;
     /**
      * The API credential unique secret.
      * @example ```"xxxx-yyyy-zzzz"```
      */
-    client_secret?: string | null;
+    client_secret: string;
     /**
      * The API credential scopes.
      * @example ```"market:all market:9 market:122 market:6 stock_location:6 stock_location:33"```
      */
-    scopes?: string | null;
+    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```
@@ -1642,4 +1666,4 @@ declare class ApiCredentials extends ApiResource<ApiCredential> {
 }
 declare const instance: ApiCredentials;
 
-export { type QueryFilter as $, type ApiCredential as A, type MembershipProfileSort as B, type CreatableResource as C, type DeletableResource as D, type ErrorObj as E, type MembershipProfileUpdate as F, MembershipProfiles as G, type HeadersObj as H, type IdentityProvider as I, type MembershipSort as J, type MembershipUpdate as K, type ListMeta as L, type Membership as M, Memberships as N, type Metadata as O, type Organization as P, type OrganizationCreate as Q, type ResourceFields as R, type OrganizationSort as S, type OrganizationUpdate as T, Organizations as U, type Permission as V, type PermissionCreate as W, type PermissionSort as X, type PermissionUpdate as Y, Permissions as Z, type QueryFields as _, type ResourceSortFields as a, creatableResources as a$, type QueryInclude as a0, type QueryPageCursor as a1, type QueryPageNumber as a2, type QueryPageSize as a3, type QueryParams as a4, type QueryParamsList as a5, type QueryParamsRetrieve as a6, type QuerySort as a7, type RequestObj as a8, type Resource as a9, Versions as aA, resourceList as aB, singletonList as aC, ResourceAdapter as aD, type RequestInterceptor as aE, type ErrorInterceptor as aF, type ResponseInterceptor as aG, type InterceptorType as aH, type RawResponseReader as aI, type VersionType as aJ, instance$9 as aK, type PermissionType as aL, instance$8 as aM, type RoleType as aN, instance$7 as aO, type MembershipType as aP, instance$6 as aQ, type OrganizationType as aR, instance$5 as aS, type MembershipProfileType as aT, instance$4 as aU, type ApplicationMembershipType as aV, instance$3 as aW, type UserType as aX, instance$2 as aY, type IdentityProviderType as aZ, instance$1 as a_, type ResourceCreate as aa, type ResourceFilter as ab, type ResourceId as ac, type ResourceRel as ad, type ResourceSort as ae, type ResourceType as af, type ResourceUpdate as ag, type ResourcesConfig as ah, type ResourcesInitConfig as ai, type ResponseObj as aj, type RetrievableResource as ak, type RetrievableResourceType as al, type Role as am, type RoleCreate as an, type RoleSort as ao, type RoleUpdate as ap, Roles as aq, type SingletonUpdate as ar, type UpdatableResource as as, type UpdatableResourceType as at, type User as au, type UserSort as av, type UserUpdate as aw, Users as ax, type Version as ay, type VersionSort as az, type ResourceTypeLock as b, deletableResources as b0, getSingletons as b1, isCreatable as b2, isDeletable as b3, isSingleton as b4, isUpdatable as b5, updatableResources as b6, type ApiCredentialType as b7, instance as b8, type ApiCredentialCreate as c, type ApiCredentialSort as d, type ApiCredentialUpdate as e, ApiCredentials as f, getResources as g, ApiResource as h, ApiSingleton as i, type ApplicationMembership as j, type ApplicationMembershipCreate as k, type ApplicationMembershipSort as l, type ApplicationMembershipUpdate as m, ApplicationMemberships as n, type CreatableResourceType as o, type DeletableResourceType as p, type IdentityProviderCreate as q, type IdentityProviderSort as r, type IdentityProviderUpdate as s, IdentityProviders as t, ListResponse as u, type ListableResource as v, type ListableResourceType as w, type MembershipCreate as x, type MembershipProfile as y, type MembershipProfileCreate as z };
+export { type QueryFilter as $, type ApiCredential as A, type MembershipProfileSort as B, type CreatableResource as C, type DeletableResource as D, type ErrorObj as E, type MembershipProfileUpdate as F, MembershipProfiles as G, type HeadersObj as H, type IdentityProvider as I, type MembershipSort as J, type MembershipUpdate as K, type ListMeta as L, type Membership as M, Memberships as N, type Metadata as O, type Organization as P, type OrganizationCreate as Q, type ResourceFields as R, type OrganizationSort as S, type OrganizationUpdate as T, Organizations as U, type Permission as V, type PermissionCreate as W, type PermissionSort as X, type PermissionUpdate as Y, Permissions as Z, type QueryFields as _, type ResourceSortFields as a, instance$1 as a$, type QueryInclude as a0, type QueryPageCursor as a1, type QueryPageNumber as a2, type QueryPageSize as a3, type QueryParams as a4, type QueryParamsList as a5, type QueryParamsRetrieve as a6, type QuerySort as a7, type RequestObj as a8, type Resource as a9, type VersionSort as aA, Versions as aB, resourceList as aC, singletonList as aD, ResourceAdapter as aE, type RequestInterceptor as aF, type ErrorInterceptor as aG, type ResponseInterceptor as aH, type InterceptorType as aI, type RawResponseReader as aJ, type VersionType as aK, instance$9 as aL, type PermissionType as aM, instance$8 as aN, type RoleType as aO, instance$7 as aP, type MembershipType as aQ, instance$6 as aR, type OrganizationType as aS, instance$5 as aT, type MembershipProfileType as aU, instance$4 as aV, type ApplicationMembershipType as aW, instance$3 as aX, type UserType as aY, instance$2 as aZ, type IdentityProviderType as a_, type ResourceCreate as aa, type ResourceFilter as ab, type ResourceId as ac, type ResourceMeta as ad, type ResourceRel as ae, type ResourceSort as af, type ResourceType as ag, type ResourceUpdate as ah, type ResourcesConfig as ai, type ResourcesInitConfig as aj, type ResponseObj as ak, type RetrievableResource as al, type RetrievableResourceType as am, type Role as an, type RoleCreate as ao, type RoleSort as ap, type RoleUpdate as aq, Roles as ar, type SingletonUpdate as as, type UpdatableResource as at, type UpdatableResourceType as au, type User as av, type UserSort as aw, type UserUpdate as ax, Users as ay, type Version as az, type ResourceTypeLock as b, creatableResources as b0, deletableResources as b1, getSingletons as b2, isCreatable as b3, isDeletable as b4, isSingleton as b5, isUpdatable as b6, updatableResources as b7, type ApiCredentialType as b8, instance as b9, type ApiCredentialCreate as c, type ApiCredentialSort as d, type ApiCredentialUpdate as e, ApiCredentials as f, getResources as g, ApiResource as h, ApiSingleton as i, type ApplicationMembership as j, type ApplicationMembershipCreate as k, type ApplicationMembershipSort as l, type ApplicationMembershipUpdate as m, ApplicationMemberships as n, type CreatableResourceType as o, type DeletableResourceType as p, type IdentityProviderCreate as q, type IdentityProviderSort as r, type IdentityProviderUpdate as s, IdentityProviders as t, ListResponse as u, type ListableResource as v, type ListableResourceType as w, type MembershipCreate as x, type MembershipProfile as y, type MembershipProfileCreate as z };