@zenglobal/api-client 3.0.1 → 4.0.0
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.
- package/README.md +25 -7
- package/dist/client/index.d.ts +2 -2
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/sdk.gen.d.ts +19 -1
- package/dist/client/sdk.gen.d.ts.map +1 -1
- package/dist/client/sdk.gen.js +22 -0
- package/dist/client/sdk.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +117 -0
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/configure.d.ts +10 -0
- package/dist/configure.d.ts.map +1 -1
- package/dist/configure.js +11 -0
- package/dist/configure.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/package.json +2 -2
|
@@ -4966,6 +4966,86 @@ export type SiteInfo = {
|
|
|
4966
4966
|
*/
|
|
4967
4967
|
locations: Array<LocationInfo>;
|
|
4968
4968
|
};
|
|
4969
|
+
/**
|
|
4970
|
+
* Address information for a site search result.
|
|
4971
|
+
*/
|
|
4972
|
+
export type SiteSearchAddress = {
|
|
4973
|
+
/**
|
|
4974
|
+
* Address line 1
|
|
4975
|
+
*/
|
|
4976
|
+
address1: string;
|
|
4977
|
+
/**
|
|
4978
|
+
* Address line 2
|
|
4979
|
+
*/
|
|
4980
|
+
address2: string;
|
|
4981
|
+
/**
|
|
4982
|
+
* City or suburb
|
|
4983
|
+
*/
|
|
4984
|
+
city: string;
|
|
4985
|
+
/**
|
|
4986
|
+
* State name
|
|
4987
|
+
*/
|
|
4988
|
+
state: string;
|
|
4989
|
+
/**
|
|
4990
|
+
* Postal code
|
|
4991
|
+
*/
|
|
4992
|
+
postcode: string;
|
|
4993
|
+
};
|
|
4994
|
+
/**
|
|
4995
|
+
* Site search response.
|
|
4996
|
+
*/
|
|
4997
|
+
export type SiteSearchResponse = {
|
|
4998
|
+
/**
|
|
4999
|
+
* Total number of matching records
|
|
5000
|
+
*/
|
|
5001
|
+
total_records: ApiNumeric;
|
|
5002
|
+
/**
|
|
5003
|
+
* Maximum results returned
|
|
5004
|
+
*/
|
|
5005
|
+
limit: ApiNumeric;
|
|
5006
|
+
/**
|
|
5007
|
+
* Matching sites
|
|
5008
|
+
*/
|
|
5009
|
+
sites: Array<SiteSearchResult>;
|
|
5010
|
+
};
|
|
5011
|
+
/**
|
|
5012
|
+
* Lightweight site record returned by the search endpoint.
|
|
5013
|
+
* Contains only the fields needed for site identification and lookup chaining.
|
|
5014
|
+
*/
|
|
5015
|
+
export type SiteSearchResult = {
|
|
5016
|
+
/**
|
|
5017
|
+
* Site code
|
|
5018
|
+
*/
|
|
5019
|
+
sitecode: ApiNumeric;
|
|
5020
|
+
/**
|
|
5021
|
+
* Site name
|
|
5022
|
+
*/
|
|
5023
|
+
name: string;
|
|
5024
|
+
/**
|
|
5025
|
+
* Salesforce CCode identifier
|
|
5026
|
+
*/
|
|
5027
|
+
ccode: string | null;
|
|
5028
|
+
/**
|
|
5029
|
+
* Whether the site is active
|
|
5030
|
+
*/
|
|
5031
|
+
active: boolean;
|
|
5032
|
+
/**
|
|
5033
|
+
* Site address
|
|
5034
|
+
*/
|
|
5035
|
+
address: SiteSearchAddress;
|
|
5036
|
+
/**
|
|
5037
|
+
* Point of sale provider name
|
|
5038
|
+
*/
|
|
5039
|
+
point_of_sale_provider: string | null;
|
|
5040
|
+
/**
|
|
5041
|
+
* Point of sale reseller name
|
|
5042
|
+
*/
|
|
5043
|
+
point_of_sale_reseller: string | null;
|
|
5044
|
+
/**
|
|
5045
|
+
* Whether POS support is enabled
|
|
5046
|
+
*/
|
|
5047
|
+
point_of_sale_support: boolean;
|
|
5048
|
+
};
|
|
4969
5049
|
/**
|
|
4970
5050
|
* Sites endpoint response.
|
|
4971
5051
|
*/
|
|
@@ -9609,6 +9689,43 @@ export type SitesGetSitesResponses = {
|
|
|
9609
9689
|
200: SitesResponse;
|
|
9610
9690
|
};
|
|
9611
9691
|
export type SitesGetSitesResponse = SitesGetSitesResponses[keyof SitesGetSitesResponses];
|
|
9692
|
+
export type SitesSearchSitesData = {
|
|
9693
|
+
body?: never;
|
|
9694
|
+
path?: never;
|
|
9695
|
+
query: {
|
|
9696
|
+
/**
|
|
9697
|
+
* Search query (required, minimum 1 character). Searches across site name (partial match), CCode (exact), and site code (exact).
|
|
9698
|
+
*/
|
|
9699
|
+
q: string;
|
|
9700
|
+
/**
|
|
9701
|
+
* Restrict search to a specific field. When omitted, searches all fields.
|
|
9702
|
+
*/
|
|
9703
|
+
field?: 'name' | 'ccode' | 'sitecode';
|
|
9704
|
+
/**
|
|
9705
|
+
* Maximum number of results to return (default 50, max 200)
|
|
9706
|
+
*/
|
|
9707
|
+
limit?: number;
|
|
9708
|
+
};
|
|
9709
|
+
url: '/v1/sites/search';
|
|
9710
|
+
};
|
|
9711
|
+
export type SitesSearchSitesErrors = {
|
|
9712
|
+
/**
|
|
9713
|
+
* The server could not understand the request due to invalid syntax.
|
|
9714
|
+
*/
|
|
9715
|
+
400: ValidationError;
|
|
9716
|
+
/**
|
|
9717
|
+
* Access is unauthorized.
|
|
9718
|
+
*/
|
|
9719
|
+
401: InvalidAccessKeyError;
|
|
9720
|
+
};
|
|
9721
|
+
export type SitesSearchSitesError = SitesSearchSitesErrors[keyof SitesSearchSitesErrors];
|
|
9722
|
+
export type SitesSearchSitesResponses = {
|
|
9723
|
+
/**
|
|
9724
|
+
* The request has succeeded.
|
|
9725
|
+
*/
|
|
9726
|
+
200: SiteSearchResponse;
|
|
9727
|
+
};
|
|
9728
|
+
export type SitesSearchSitesResponse = SitesSearchSitesResponses[keyof SitesSearchSitesResponses];
|
|
9612
9729
|
export type StripeGetStripeConfigData = {
|
|
9613
9730
|
body?: never;
|
|
9614
9731
|
path?: never;
|