chore(types): claify province code format in TSDocs (#12283)

packages/core/types/src/cart/common.ts

@@ -260,7 +260,7 @@ export interface CartAddressDTO {
   country_code?: string
 
   /**
-   * The province/state of the address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
    */
   province?: string
 

packages/core/types/src/cart/mutations.ts

@@ -48,7 +48,7 @@ export interface UpsertAddressDTO {
   country_code?: string
 
   /**
-   * The province of the address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
    */
   province?: string
 

packages/core/types/src/cart/workflows.ts

@@ -197,7 +197,7 @@ export interface CreateCartAddressDTO {
   country_code?: string
 
   /**
-   * The province or state of the address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state of the address.
    */
   province?: string
 

packages/core/types/src/customer/common.ts

@@ -67,7 +67,7 @@ export interface CustomerAddressDTO {
   country_code?: string
 
   /**
-   * The province of the customer address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the customer address.
    */
   province?: string
 
@@ -173,7 +173,7 @@ export interface FilterableCustomerAddressProps
   country_code?: string | OperatorMap<string>
 
   /**
-   * Filter addresses by province.
+   * Filter addresses by lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
    */
   province?: string | OperatorMap<string>
 

packages/core/types/src/customer/mutations.ts

@@ -60,7 +60,7 @@ export interface CreateCustomerAddressDTO {
   country_code?: string | null
 
   /**
-   * The province.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the address.
    */
   province?: string | null
 
@@ -145,7 +145,7 @@ export interface UpdateCustomerAddressDTO {
   country_code?: string | null
 
   /**
-   * The province.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the address.
    */
   province?: string | null
 

packages/core/types/src/fulfillment/common/address.ts

@@ -48,7 +48,7 @@ export interface FulfillmentAddressDTO {
   country_code: string | null
 
   /**
-   * The province of the address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the address.
    */
   province: string | null
 

packages/core/types/src/fulfillment/common/geo-zone.ts

@@ -25,7 +25,7 @@ export interface GeoZoneDTO {
   country_code: string
 
   /**
-   * The province code of the geo zone.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
    */
   province_code: string | null
 
@@ -81,7 +81,7 @@ export interface FilterableGeoZoneProps
   country_code?: string | string[]
 
   /**
-   * Filter the geo zones by their province code.
+   * Filter the geo zones by their lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
    */
   province_code?: string | string[]
 

packages/core/types/src/fulfillment/common/order.ts

@@ -438,7 +438,7 @@ interface FulfillmentOrderAddressDTO {
   country_code?: string
 
   /**
-   * The province/state of the address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
    */
   province?: string
 

packages/core/types/src/fulfillment/common/shipping-option.ts

@@ -192,7 +192,7 @@ export interface FilterableShippingOptionForContextProps
     country_code?: string
 
     /**
-     * The province code.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
      */
     province_code?: string
 

packages/core/types/src/fulfillment/mutations/fulfillment-address.ts

@@ -43,7 +43,7 @@ export interface CreateFulfillmentAddressDTO {
   country_code?: string | null
 
   /**
-   * The province of the fulfillment address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the fulfillment address.
    */
   province?: string | null
 

packages/core/types/src/fulfillment/mutations/geo-zone.ts

@@ -47,7 +47,7 @@ export interface CreateProvinceGeoZoneDTO extends CreateGeoZoneBaseDTO {
   type: "province"
 
   /**
-   * The province code of the geo zone.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
    */
   province_code: string
 }
@@ -63,7 +63,7 @@ export interface CreateCityGeoZoneDTO extends CreateGeoZoneBaseDTO {
   type: "city"
 
   /**
-   * The province code of the geo zone.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
    */
   province_code: string
 
@@ -84,7 +84,7 @@ export interface CreateZipGeoZoneDTO extends CreateGeoZoneBaseDTO {
   type: "zip"
 
   /**
-   * The province code of the geo zone.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
    */
   province_code: string
 
@@ -140,7 +140,7 @@ export interface UpdateProvinceGeoZoneDTO extends UpdateGeoZoneBaseDTO {
   type: "province"
 
   /**
-   * The province code of the geo zone.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
    */
   province_code: string
 }
@@ -156,7 +156,7 @@ export interface UpdateCityGeoZoneDTO extends UpdateGeoZoneBaseDTO {
   type: "city"
 
   /**
-   * The province code of the geo zone.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
    */
   province_code?: string
 
@@ -177,7 +177,7 @@ export interface UpdateZipGeoZoneDTO extends UpdateGeoZoneBaseDTO {
   type: "zip"
 
   /**
-   * The province code of the geo zone.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
    */
   province_code?: string
 

packages/core/types/src/fulfillment/service.ts

@@ -863,7 +863,7 @@ export interface IFulfillmentModuleService extends IModuleService {
    *     {
    *       type: "city",
    *       service_zone_id: "serzo_321",
-   *       province_code: "VT",
+   *       province_code: "us-vt",
    *       city: "Vermont",
    *       country_code: "us",
    *     },
@@ -912,7 +912,7 @@ export interface IFulfillmentModuleService extends IModuleService {
    *     {
    *       id: "fgz_321",
    *       type: "city",
-   *       province_code: "VT",
+   *       province_code: "us-vt",
    *     },
    *   ])
    */

packages/core/types/src/http/cart/common.ts

@@ -253,7 +253,7 @@ export interface BaseCartAddress {
   country_code?: string
 
   /**
-   * The province/state of the address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
    */
   province?: string
 

packages/core/types/src/http/cart/store/payloads.ts

@@ -158,7 +158,7 @@ export interface StoreAddAddress {
   country_code?: string
 
   /**
-   * The province/state of the address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
    */
   province?: string
 

packages/core/types/src/http/customer/common.ts

@@ -63,7 +63,7 @@ export interface BaseCustomerAddress {
    */
   country_code: string | null
   /**
-   * The address's province.
+   * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
    */
   province: string | null
   /**
@@ -234,7 +234,7 @@ export interface BaseCustomerAddressFilters
    */
   country_code?: string[] | string
   /**
-   * Filter by province(s).
+   * Filter by lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code(s).
    */
   province?: string[] | string
   /**
@@ -330,7 +330,7 @@ export interface BaseCreateCustomerAddress {
    */
   country_code?: string
   /**
-   * The address's province.
+   * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
    */
   province?: string
   /**
@@ -392,7 +392,7 @@ export interface BaseUpdateCustomerAddress {
    */
   country_code?: string
   /**
-   * The address's province.
+   * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
    */
   province?: string
   /**

packages/core/types/src/http/fulfillment-set/admin/entities.ts

@@ -19,7 +19,7 @@ export interface AdminGeoZone {
    */
   country_code: string
   /**
-   * The geo zone's province code.
+   * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
    */
   province_code: string | null
   /**

packages/core/types/src/http/fulfillment-set/admin/payloads.ts

@@ -25,7 +25,7 @@ interface AdminUpsertFulfillmentSetServiceZoneProvince
   extends AdminUpsertGeoZone {
   type: "province"
   /**
-   * The geo zone's province code.
+   * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
    */
   province_code: string
 }
@@ -33,7 +33,7 @@ interface AdminUpsertFulfillmentSetServiceZoneProvince
 interface AdminUpsertFulfillmentSetServiceZoneCity extends AdminUpsertGeoZone {
   type: "city"
   /**
-   * The geo zone's province code.
+   * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
    */
   province_code: string
   /**
@@ -45,7 +45,7 @@ interface AdminUpsertFulfillmentSetServiceZoneCity extends AdminUpsertGeoZone {
 interface AdminUpsertFulfillmentSetServiceZoneZip extends AdminUpsertGeoZone {
   type: "zip"
   /**
-   * The geo zone's province code.
+   * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
    */
   province_code: string
   /**
@@ -92,7 +92,7 @@ interface AdminUpdateFulfillmentSetServiceZoneProvince
   extends AdminUpdateGeoZone {
   type: "province"
   /**
-   * The geo zone's province code.
+   * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
    */
   province_code: string
 }
@@ -100,7 +100,7 @@ interface AdminUpdateFulfillmentSetServiceZoneProvince
 interface AdminUpdateFulfillmentSetServiceZoneCity extends AdminUpdateGeoZone {
   type: "city"
   /**
-   * The geo zone's province code.
+   * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
    */
   province_code: string
   /**
@@ -112,7 +112,7 @@ interface AdminUpdateFulfillmentSetServiceZoneCity extends AdminUpdateGeoZone {
 interface AdminUpdateFulfillmentSetServiceZoneZip extends AdminUpdateGeoZone {
   type: "zip"
   /**
-   * The geo zone's province code.
+   * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
    */
   province_code: string
   /**

packages/core/types/src/http/fulfillment/admin/entitites.ts

@@ -99,7 +99,7 @@ export interface AdminFulfillmentAddress {
    */
   country_code: string | null
   /**
-   * The address's province.
+   * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
    */
   province: string | null
   /**

packages/core/types/src/http/fulfillment/admin/payloads.ts

@@ -77,7 +77,7 @@ interface AdminFulfillmentDeliveryAddress {
    */
   country_code?: string
   /**
-   * The address's province.
+   * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
    */
   province?: string
   /**

packages/core/types/src/http/order/admin/payload.ts

@@ -147,7 +147,7 @@ export interface OrderAddress {
   country_code?: string
 
   /**
-   * The province/state of the address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
    */
   province?: string
 

packages/core/types/src/http/order/common.ts

@@ -196,7 +196,7 @@ export interface BaseOrderAddress {
    */
   country_code?: string
   /**
-   * The address's province.
+   * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
    */
   province?: string
   /**

packages/core/types/src/http/product/store/queries.ts

@@ -17,7 +17,7 @@ export interface StoreProductPricingContext {
    */
   country_code?: string
   /**
-   * The province, which can be taken from a customer's address. This parameter helps further narrowing down the taxes applied on a the product variant's prices.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province, which can be taken from a customer's address. This parameter helps further narrowing down the taxes applied on a the product variant's prices.
    */
   province?: string
   /**

packages/core/types/src/http/stock-locations/admin/payloads.ts

@@ -31,7 +31,7 @@ interface AdminUpsertStockLocationAddress {
    */
   postal_code?: string
   /**
-   * The province or state of the address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state of the address.
    */
   province?: string
 }

packages/core/types/src/http/tax-region/admin/entities.ts

@@ -13,10 +13,10 @@ export interface AdminTaxRegion {
    */
   country_code: string | null
   /**
-   * The tax region's province or state code.
+   * The tax region's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code.
    * 
    * @example
-   * "ca"
+   * "us-ca"
    */
   province_code: string | null
   /**

packages/core/types/src/http/tax-region/admin/payloads.ts

@@ -4,7 +4,7 @@ export interface AdminCreateTaxRegion {
    */
   country_code: string
   /**
-   * The province code of the tax region.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code of the tax region.
    */
   province_code?: string
   /**

packages/core/types/src/http/tax-region/admin/queries.ts

@@ -21,7 +21,7 @@ export interface AdminTaxRegionListParams
    */
   country_code?: string | string[] | OperatorMap<string | string[]>
   /**
-   * Filter by the tax region's province code(s).
+   * Filter by the tax region's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code(s).
    */
   province_code?: string | string[] | OperatorMap<string | string[]>
   /**

packages/core/types/src/order/common.ts

@@ -330,7 +330,7 @@ export interface OrderAddressDTO {
   country_code?: string
 
   /**
-   * The province/state of the address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
    */
   province?: string
 

packages/core/types/src/order/mutations.ts

@@ -67,7 +67,7 @@ export interface UpsertOrderAddressDTO {
   country_code?: string
 
   /**
-   * The province of the address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the address.
    */
   province?: string
 

packages/core/types/src/order/service.ts

@@ -855,8 +855,8 @@ export interface IOrderModuleService extends IModuleService {
    *     last_name: "Doe",
    *     address_1: "123 Main St",
    *     city: "Anytown",
-   *     country_code: "US",
+   *     country_code: "us",
-   *     province: "AnyState",
+   *     province: "us-ca",
    *     postal_code: "12345"
    *   }
    * ])
@@ -882,8 +882,8 @@ export interface IOrderModuleService extends IModuleService {
    *   last_name: "Doe",
    *   address_1: "123 Main St",
    *   city: "Anytown",
-   *   country_code: "US",
+   *   country_code: "us",
-   *   province: "AnyState",
+   *   province: "us-ca",
    *   postal_code: "12345"
    * })
    * ```

packages/core/types/src/stock-location/common.ts

@@ -108,7 +108,7 @@ export type StockLocationAddressDTO = {
   postal_code?: string | null
 
   /**
-   * The province of the stock location address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the stock location address.
    */
   province?: string | null
 
@@ -301,8 +301,8 @@ export interface FilterableStockLocationProps
  *     example: HD3-1G8
  *   province:
  *     type: string
- *     description: Stock location address' province
+ *     description: Stock location address' lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province
- *     example: Sinaloa
+ *     example: us-ca
  *   metadata:
  *     type: object
  *     description: An optional key-value map with additional details
@@ -335,7 +335,7 @@ export type StockLocationAddressInput = {
   phone?: string | null
 
   /**
-   * The province of the stock location address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the stock location address.
    */
   province?: string | null
 

packages/core/types/src/tax/common.ts

@@ -154,7 +154,7 @@ export interface TaxRegionDTO {
   country_code: string
 
   /**
-   * The province code of the tax region.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code of the tax region.
    */
   province_code: string | null
 
@@ -197,6 +197,7 @@ export interface FilterableTaxRegionProps
   extends BaseFilterable<FilterableTaxRegionProps> {
   /**
    * Find tax regions based on currency and province codes through this search term.
+   * The province code is the lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code.
    */
   q?: string
 
@@ -211,7 +212,7 @@ export interface FilterableTaxRegionProps
   country_code?: string | string[] | OperatorMap<string>
 
   /**
-   * Filter the tax regions by their province code.
+   * Filter the tax regions by their lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code.
    */
   province_code?: string | string[] | OperatorMap<string>
 
@@ -425,7 +426,7 @@ export interface TaxCalculationContext {
     country_code: string
 
     /**
-     * The province code.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code.
      */
     province_code?: string | null
 

packages/core/types/src/tax/mutations.ts

@@ -157,7 +157,7 @@ export interface CreateTaxRegionDTO {
   country_code: string
 
   /**
-   * The province code of the tax region.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code of the tax region.
    */
   province_code?: string | null
 
@@ -216,7 +216,7 @@ export interface UpdateTaxRegionDTO {
   id: string
 
   /**
-   * The province code of the tax region.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code of the tax region.
    */
   province_code?: string | null
 

packages/core/types/src/tax/service.ts

@@ -417,7 +417,7 @@ export interface ITaxModuleService extends IModuleService {
    *
    * @example
    * const taxRegion = await taxModule.updateTaxRegions({
-   *   province_code: "be",
+   *   province_code: "us-ca",
    * })
    */
   updateTaxRegions(
@@ -436,11 +436,11 @@ export interface ITaxModuleService extends IModuleService {
    * const taxRegions = await taxModule.updateTaxRegions([
    *   {
    *     id: "tx-1",
-   *     province_code: "be",
+   *     province_code: "us-ca",
    *   },
    *   {
    *     id: "tx-2",
-   *     province_code: "ca",
+   *     province_code: "us-ny",
    *   },
    * ])
    */

packages/core/types/src/workflow/fulfillment/create-fulfillment.ts

@@ -38,7 +38,7 @@ export type CreateFulfillmentAddressWorkflowDTO = {
   country_code?: string | null
 
   /**
-   * The province of the fulfillment address.
+   * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the fulfillment address.
    */
   province?: string | null