feat(types): extend country and country state types (#174)

* feat(types): extend country and country state types * chore: changeset
shopware · Apr 27, 2023 · a1edcd1 · a1edcd1 · vercel · Apr 27, 2023
1 parent 4c01ff5
commit a1edcd1
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 0 deletions.
diff --git a/.changeset/heavy-bats-turn.md b/.changeset/heavy-bats-turn.md
@@ -0,0 +1,5 @@
+---
+"@shopware-pwa/types": patch
+---
+
+Extend types for Country and CountryState entities
diff --git a/packages/types/shopware-6-client/models/system/country/Country.d.ts b/packages/types/shopware-6-client/models/system/country/Country.d.ts
@@ -5,6 +5,13 @@ import { CustomerAddress } from "../../checkout/customer/CustomerAddress";
 import { SalesChannel } from "../sales-channel/SalesChannel";
 import { CustomFields } from "../../common/CustomField";
 
+type CountryTaxSetting = {
+  enabled: boolean;
+  currencyId: string;
+  amount: number;
+  apiAlias: string;
+};
+
 /**
  * @public
  */
@@ -30,4 +37,25 @@ export type Country = {
   customerAddress: CustomerAddress[] | null;
   salesChannelDefaultAssignments: SalesChannel[] | null;
   salesChannels: SalesChannel[] | null;
+  extensions: unknown;
+  _uniqueIdentifier: string;
+  translated: {
+    name: string;
+    customFields: unknown;
+    addressFormat: string[][];
+  };
+  companyTaxFree: boolean;
+  checkVatIdPattern: boolean;
+  vatIdPattern: string;
+  vatIdRequired: boolean;
+  customerTax: CountryTaxSetting;
+  companyTax: CountryTaxSetting;
+  states: CountryState[];
+  postalCodeRequired: boolean;
+  checkPostalCodePattern: boolean;
+  checkAdvancedPostalCodePattern: boolean;
+  advancedPostalCodePattern: null | string;
+  defaultPostalCodePattern: string;
+  addressFormat: string[][];
+  apiAlias: "country";
 };
diff --git a/packages/types/shopware-6-client/models/system/country/CountryState.d.ts b/packages/types/shopware-6-client/models/system/country/CountryState.d.ts
@@ -18,4 +18,20 @@ export type CountryState = {
   customerAddresses: CustomerAddress[] | null;
   orderAddresses: OrderAddress[] | null;
   customFields: CustomFields;
+  extensions: unknown;
+  _uniqueIdentifier: string;
+  versionId: string | null;
+  translated: {
+    name: string;
+    customFields: unknown;
+  };
+  createdAt: string;
+  updatedAt: string | null;
+  countryId: string;
+  shortCode: string;
+  name: string | null;
+  position: number;
+  active: boolean;
+  id: string;
+  apiAlias: "country_state";
 };