@heymantle/core-api-client 0.3.3 → 0.3.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.mts +23 -20
  2. package/dist/index.d.ts +23 -20
  3. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -4887,6 +4887,8 @@ type paths = {
4887
4887
  appIds?: string[];
4888
4888
  /** @description The cursor to paginate from */
4889
4889
  cursor?: components["parameters"]["cursor"];
4890
+ /** @description An optional custom domain to filter customers by (e.g. example.com). */
4891
+ domain?: string;
4890
4892
  /** @description Email addresses to filter customers by. Can be passed as an array (email=test1@example.com&email=test2@example.com) or a single string. Returns customers with emails matching any of the provided addresses. */
4891
4893
  email?: string[] | string;
4892
4894
  /** @description The maximum date/time (ISO 8601) of the last update to the Customer */
@@ -4897,7 +4899,7 @@ type paths = {
4897
4899
  page?: components["parameters"]["page"];
4898
4900
  /** @description The search term to filter by */
4899
4901
  search?: components["parameters"]["search"];
4900
- /** @description An optional shopify shop domain to filter customers by. */
4902
+ /** @description An optional shopify shop domain (myshopify.com domain) to filter customers by. */
4901
4903
  shopifyShopDomain?: string;
4902
4904
  /** @description An optional shopify shop id to filter customers by. */
4903
4905
  shopifyShopId?: string;
@@ -8896,7 +8898,7 @@ type paths = {
8896
8898
  conditions?: {
8897
8899
  operator?: string;
8898
8900
  property?: string;
8899
- value?: Record<string, never>;
8901
+ value?: string | number | boolean | null;
8900
8902
  }[][];
8901
8903
  contactConditions?: unknown[];
8902
8904
  filterContacts?: boolean;
@@ -16586,7 +16588,8 @@ type components = {
16586
16588
  updatedAt: string;
16587
16589
  };
16588
16590
  CustomerContact: {
16589
- customerId?: string;
16591
+ /** @description The customer ID */
16592
+ id?: string;
16590
16593
  label?: string;
16591
16594
  };
16592
16595
  CustomerContactWebhook: {
@@ -20601,7 +20604,7 @@ declare class ContactsResource extends BaseResource {
20601
20604
  contacts?: {
20602
20605
  createdAt?: string | undefined;
20603
20606
  customers?: {
20604
- customerId?: string | undefined;
20607
+ id?: string | undefined;
20605
20608
  label?: string | undefined;
20606
20609
  }[] | undefined;
20607
20610
  email?: string | undefined;
@@ -20623,7 +20626,7 @@ declare class ContactsResource extends BaseResource {
20623
20626
  create(data: NonNullable<paths['/contacts']['post']['requestBody']>['content']['application/json']): Promise<{
20624
20627
  createdAt?: string | undefined;
20625
20628
  customers?: {
20626
- customerId?: string | undefined;
20629
+ id?: string | undefined;
20627
20630
  label?: string | undefined;
20628
20631
  }[] | undefined;
20629
20632
  email?: string | undefined;
@@ -20644,7 +20647,7 @@ declare class ContactsResource extends BaseResource {
20644
20647
  } | {
20645
20648
  createdAt?: string | undefined;
20646
20649
  customers?: {
20647
- customerId?: string | undefined;
20650
+ id?: string | undefined;
20648
20651
  label?: string | undefined;
20649
20652
  }[] | undefined;
20650
20653
  email?: string | undefined;
@@ -20667,7 +20670,7 @@ declare class ContactsResource extends BaseResource {
20667
20670
  contact?: {
20668
20671
  createdAt?: string | undefined;
20669
20672
  customers?: {
20670
- customerId?: string | undefined;
20673
+ id?: string | undefined;
20671
20674
  label?: string | undefined;
20672
20675
  }[] | undefined;
20673
20676
  email?: string | undefined;
@@ -20690,7 +20693,7 @@ declare class ContactsResource extends BaseResource {
20690
20693
  contact?: {
20691
20694
  createdAt?: string | undefined;
20692
20695
  customers?: {
20693
- customerId?: string | undefined;
20696
+ id?: string | undefined;
20694
20697
  label?: string | undefined;
20695
20698
  }[] | undefined;
20696
20699
  email?: string | undefined;
@@ -20713,7 +20716,7 @@ declare class ContactsResource extends BaseResource {
20713
20716
  contact?: {
20714
20717
  createdAt?: string | undefined;
20715
20718
  customers?: {
20716
- customerId?: string | undefined;
20719
+ id?: string | undefined;
20717
20720
  label?: string | undefined;
20718
20721
  }[] | undefined;
20719
20722
  email?: string | undefined;
@@ -20739,7 +20742,7 @@ declare class ContactsResource extends BaseResource {
20739
20742
  contact?: {
20740
20743
  createdAt?: string | undefined;
20741
20744
  customers?: {
20742
- customerId?: string | undefined;
20745
+ id?: string | undefined;
20743
20746
  label?: string | undefined;
20744
20747
  }[] | undefined;
20745
20748
  email?: string | undefined;
@@ -20958,7 +20961,7 @@ declare class CustomersResource extends BaseResource {
20958
20961
  label?: string | undefined;
20959
20962
  createdAt?: string | undefined;
20960
20963
  customers?: {
20961
- customerId?: string | undefined;
20964
+ id?: string | undefined;
20962
20965
  label?: string | undefined;
20963
20966
  }[] | undefined;
20964
20967
  email?: string | undefined;
@@ -21139,7 +21142,7 @@ declare class CustomersResource extends BaseResource {
21139
21142
  label?: string | undefined;
21140
21143
  createdAt?: string | undefined;
21141
21144
  customers?: {
21142
- customerId?: string | undefined;
21145
+ id?: string | undefined;
21143
21146
  label?: string | undefined;
21144
21147
  }[] | undefined;
21145
21148
  email?: string | undefined;
@@ -21368,7 +21371,7 @@ declare class CustomersResource extends BaseResource {
21368
21371
  label?: string | undefined;
21369
21372
  createdAt?: string | undefined;
21370
21373
  customers?: {
21371
- customerId?: string | undefined;
21374
+ id?: string | undefined;
21372
21375
  label?: string | undefined;
21373
21376
  }[] | undefined;
21374
21377
  email?: string | undefined;
@@ -21549,7 +21552,7 @@ declare class CustomersResource extends BaseResource {
21549
21552
  label?: string | undefined;
21550
21553
  createdAt?: string | undefined;
21551
21554
  customers?: {
21552
- customerId?: string | undefined;
21555
+ id?: string | undefined;
21553
21556
  label?: string | undefined;
21554
21557
  }[] | undefined;
21555
21558
  email?: string | undefined;
@@ -21730,7 +21733,7 @@ declare class CustomersResource extends BaseResource {
21730
21733
  label?: string | undefined;
21731
21734
  createdAt?: string | undefined;
21732
21735
  customers?: {
21733
- customerId?: string | undefined;
21736
+ id?: string | undefined;
21734
21737
  label?: string | undefined;
21735
21738
  }[] | undefined;
21736
21739
  email?: string | undefined;
@@ -21911,7 +21914,7 @@ declare class CustomersResource extends BaseResource {
21911
21914
  label?: string | undefined;
21912
21915
  createdAt?: string | undefined;
21913
21916
  customers?: {
21914
- customerId?: string | undefined;
21917
+ id?: string | undefined;
21915
21918
  label?: string | undefined;
21916
21919
  }[] | undefined;
21917
21920
  email?: string | undefined;
@@ -23875,7 +23878,7 @@ declare class EntitiesResource extends BaseResource {
23875
23878
  label?: string | undefined;
23876
23879
  createdAt?: string | undefined;
23877
23880
  customers?: {
23878
- customerId?: string | undefined;
23881
+ id?: string | undefined;
23879
23882
  label?: string | undefined;
23880
23883
  }[] | undefined;
23881
23884
  email?: string | undefined;
@@ -23907,7 +23910,7 @@ declare class EntitiesResource extends BaseResource {
23907
23910
  } | {
23908
23911
  createdAt?: string | undefined;
23909
23912
  customers?: {
23910
- customerId?: string | undefined;
23913
+ id?: string | undefined;
23911
23914
  label?: string | undefined;
23912
23915
  }[] | undefined;
23913
23916
  email?: string | undefined;
@@ -24514,7 +24517,7 @@ declare class ListsResource extends BaseResource {
24514
24517
  label?: string | undefined;
24515
24518
  createdAt?: string | undefined;
24516
24519
  customers?: {
24517
- customerId?: string | undefined;
24520
+ id?: string | undefined;
24518
24521
  label?: string | undefined;
24519
24522
  }[] | undefined;
24520
24523
  email?: string | undefined;
@@ -24546,7 +24549,7 @@ declare class ListsResource extends BaseResource {
24546
24549
  } | {
24547
24550
  createdAt?: string | undefined;
24548
24551
  customers?: {
24549
- customerId?: string | undefined;
24552
+ id?: string | undefined;
24550
24553
  label?: string | undefined;
24551
24554
  }[] | undefined;
24552
24555
  email?: string | undefined;
package/dist/index.d.ts CHANGED
@@ -4887,6 +4887,8 @@ type paths = {
4887
4887
  appIds?: string[];
4888
4888
  /** @description The cursor to paginate from */
4889
4889
  cursor?: components["parameters"]["cursor"];
4890
+ /** @description An optional custom domain to filter customers by (e.g. example.com). */
4891
+ domain?: string;
4890
4892
  /** @description Email addresses to filter customers by. Can be passed as an array (email=test1@example.com&email=test2@example.com) or a single string. Returns customers with emails matching any of the provided addresses. */
4891
4893
  email?: string[] | string;
4892
4894
  /** @description The maximum date/time (ISO 8601) of the last update to the Customer */
@@ -4897,7 +4899,7 @@ type paths = {
4897
4899
  page?: components["parameters"]["page"];
4898
4900
  /** @description The search term to filter by */
4899
4901
  search?: components["parameters"]["search"];
4900
- /** @description An optional shopify shop domain to filter customers by. */
4902
+ /** @description An optional shopify shop domain (myshopify.com domain) to filter customers by. */
4901
4903
  shopifyShopDomain?: string;
4902
4904
  /** @description An optional shopify shop id to filter customers by. */
4903
4905
  shopifyShopId?: string;
@@ -8896,7 +8898,7 @@ type paths = {
8896
8898
  conditions?: {
8897
8899
  operator?: string;
8898
8900
  property?: string;
8899
- value?: Record<string, never>;
8901
+ value?: string | number | boolean | null;
8900
8902
  }[][];
8901
8903
  contactConditions?: unknown[];
8902
8904
  filterContacts?: boolean;
@@ -16586,7 +16588,8 @@ type components = {
16586
16588
  updatedAt: string;
16587
16589
  };
16588
16590
  CustomerContact: {
16589
- customerId?: string;
16591
+ /** @description The customer ID */
16592
+ id?: string;
16590
16593
  label?: string;
16591
16594
  };
16592
16595
  CustomerContactWebhook: {
@@ -20601,7 +20604,7 @@ declare class ContactsResource extends BaseResource {
20601
20604
  contacts?: {
20602
20605
  createdAt?: string | undefined;
20603
20606
  customers?: {
20604
- customerId?: string | undefined;
20607
+ id?: string | undefined;
20605
20608
  label?: string | undefined;
20606
20609
  }[] | undefined;
20607
20610
  email?: string | undefined;
@@ -20623,7 +20626,7 @@ declare class ContactsResource extends BaseResource {
20623
20626
  create(data: NonNullable<paths['/contacts']['post']['requestBody']>['content']['application/json']): Promise<{
20624
20627
  createdAt?: string | undefined;
20625
20628
  customers?: {
20626
- customerId?: string | undefined;
20629
+ id?: string | undefined;
20627
20630
  label?: string | undefined;
20628
20631
  }[] | undefined;
20629
20632
  email?: string | undefined;
@@ -20644,7 +20647,7 @@ declare class ContactsResource extends BaseResource {
20644
20647
  } | {
20645
20648
  createdAt?: string | undefined;
20646
20649
  customers?: {
20647
- customerId?: string | undefined;
20650
+ id?: string | undefined;
20648
20651
  label?: string | undefined;
20649
20652
  }[] | undefined;
20650
20653
  email?: string | undefined;
@@ -20667,7 +20670,7 @@ declare class ContactsResource extends BaseResource {
20667
20670
  contact?: {
20668
20671
  createdAt?: string | undefined;
20669
20672
  customers?: {
20670
- customerId?: string | undefined;
20673
+ id?: string | undefined;
20671
20674
  label?: string | undefined;
20672
20675
  }[] | undefined;
20673
20676
  email?: string | undefined;
@@ -20690,7 +20693,7 @@ declare class ContactsResource extends BaseResource {
20690
20693
  contact?: {
20691
20694
  createdAt?: string | undefined;
20692
20695
  customers?: {
20693
- customerId?: string | undefined;
20696
+ id?: string | undefined;
20694
20697
  label?: string | undefined;
20695
20698
  }[] | undefined;
20696
20699
  email?: string | undefined;
@@ -20713,7 +20716,7 @@ declare class ContactsResource extends BaseResource {
20713
20716
  contact?: {
20714
20717
  createdAt?: string | undefined;
20715
20718
  customers?: {
20716
- customerId?: string | undefined;
20719
+ id?: string | undefined;
20717
20720
  label?: string | undefined;
20718
20721
  }[] | undefined;
20719
20722
  email?: string | undefined;
@@ -20739,7 +20742,7 @@ declare class ContactsResource extends BaseResource {
20739
20742
  contact?: {
20740
20743
  createdAt?: string | undefined;
20741
20744
  customers?: {
20742
- customerId?: string | undefined;
20745
+ id?: string | undefined;
20743
20746
  label?: string | undefined;
20744
20747
  }[] | undefined;
20745
20748
  email?: string | undefined;
@@ -20958,7 +20961,7 @@ declare class CustomersResource extends BaseResource {
20958
20961
  label?: string | undefined;
20959
20962
  createdAt?: string | undefined;
20960
20963
  customers?: {
20961
- customerId?: string | undefined;
20964
+ id?: string | undefined;
20962
20965
  label?: string | undefined;
20963
20966
  }[] | undefined;
20964
20967
  email?: string | undefined;
@@ -21139,7 +21142,7 @@ declare class CustomersResource extends BaseResource {
21139
21142
  label?: string | undefined;
21140
21143
  createdAt?: string | undefined;
21141
21144
  customers?: {
21142
- customerId?: string | undefined;
21145
+ id?: string | undefined;
21143
21146
  label?: string | undefined;
21144
21147
  }[] | undefined;
21145
21148
  email?: string | undefined;
@@ -21368,7 +21371,7 @@ declare class CustomersResource extends BaseResource {
21368
21371
  label?: string | undefined;
21369
21372
  createdAt?: string | undefined;
21370
21373
  customers?: {
21371
- customerId?: string | undefined;
21374
+ id?: string | undefined;
21372
21375
  label?: string | undefined;
21373
21376
  }[] | undefined;
21374
21377
  email?: string | undefined;
@@ -21549,7 +21552,7 @@ declare class CustomersResource extends BaseResource {
21549
21552
  label?: string | undefined;
21550
21553
  createdAt?: string | undefined;
21551
21554
  customers?: {
21552
- customerId?: string | undefined;
21555
+ id?: string | undefined;
21553
21556
  label?: string | undefined;
21554
21557
  }[] | undefined;
21555
21558
  email?: string | undefined;
@@ -21730,7 +21733,7 @@ declare class CustomersResource extends BaseResource {
21730
21733
  label?: string | undefined;
21731
21734
  createdAt?: string | undefined;
21732
21735
  customers?: {
21733
- customerId?: string | undefined;
21736
+ id?: string | undefined;
21734
21737
  label?: string | undefined;
21735
21738
  }[] | undefined;
21736
21739
  email?: string | undefined;
@@ -21911,7 +21914,7 @@ declare class CustomersResource extends BaseResource {
21911
21914
  label?: string | undefined;
21912
21915
  createdAt?: string | undefined;
21913
21916
  customers?: {
21914
- customerId?: string | undefined;
21917
+ id?: string | undefined;
21915
21918
  label?: string | undefined;
21916
21919
  }[] | undefined;
21917
21920
  email?: string | undefined;
@@ -23875,7 +23878,7 @@ declare class EntitiesResource extends BaseResource {
23875
23878
  label?: string | undefined;
23876
23879
  createdAt?: string | undefined;
23877
23880
  customers?: {
23878
- customerId?: string | undefined;
23881
+ id?: string | undefined;
23879
23882
  label?: string | undefined;
23880
23883
  }[] | undefined;
23881
23884
  email?: string | undefined;
@@ -23907,7 +23910,7 @@ declare class EntitiesResource extends BaseResource {
23907
23910
  } | {
23908
23911
  createdAt?: string | undefined;
23909
23912
  customers?: {
23910
- customerId?: string | undefined;
23913
+ id?: string | undefined;
23911
23914
  label?: string | undefined;
23912
23915
  }[] | undefined;
23913
23916
  email?: string | undefined;
@@ -24514,7 +24517,7 @@ declare class ListsResource extends BaseResource {
24514
24517
  label?: string | undefined;
24515
24518
  createdAt?: string | undefined;
24516
24519
  customers?: {
24517
- customerId?: string | undefined;
24520
+ id?: string | undefined;
24518
24521
  label?: string | undefined;
24519
24522
  }[] | undefined;
24520
24523
  email?: string | undefined;
@@ -24546,7 +24549,7 @@ declare class ListsResource extends BaseResource {
24546
24549
  } | {
24547
24550
  createdAt?: string | undefined;
24548
24551
  customers?: {
24549
- customerId?: string | undefined;
24552
+ id?: string | undefined;
24550
24553
  label?: string | undefined;
24551
24554
  }[] | undefined;
24552
24555
  email?: string | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@heymantle/core-api-client",
3
- "version": "0.3.3",
3
+ "version": "0.3.5",
4
4
  "description": "TypeScript SDK for the Mantle Core API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",