@stigg/typescript 0.1.0-beta.63 → 0.1.0-beta.65

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 (39) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/client.d.mts +1 -1
  3. package/client.d.ts +1 -1
  4. package/client.js +3 -3
  5. package/client.js.map +1 -1
  6. package/client.mjs +3 -3
  7. package/client.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/v1/customers/customers.d.mts +16 -0
  10. package/resources/v1/customers/customers.d.mts.map +1 -1
  11. package/resources/v1/customers/customers.d.ts +16 -0
  12. package/resources/v1/customers/customers.d.ts.map +1 -1
  13. package/resources/v1/customers/customers.js.map +1 -1
  14. package/resources/v1/customers/customers.mjs.map +1 -1
  15. package/resources/v1-beta/customers/entities.d.mts +5 -9
  16. package/resources/v1-beta/customers/entities.d.mts.map +1 -1
  17. package/resources/v1-beta/customers/entities.d.ts +5 -9
  18. package/resources/v1-beta/customers/entities.d.ts.map +1 -1
  19. package/resources/v1-beta/customers/entities.js +5 -9
  20. package/resources/v1-beta/customers/entities.js.map +1 -1
  21. package/resources/v1-beta/customers/entities.mjs +5 -9
  22. package/resources/v1-beta/customers/entities.mjs.map +1 -1
  23. package/resources/v1-beta/entity-types.d.mts +15 -2
  24. package/resources/v1-beta/entity-types.d.mts.map +1 -1
  25. package/resources/v1-beta/entity-types.d.ts +15 -2
  26. package/resources/v1-beta/entity-types.d.ts.map +1 -1
  27. package/resources/v1-beta/entity-types.js +3 -2
  28. package/resources/v1-beta/entity-types.js.map +1 -1
  29. package/resources/v1-beta/entity-types.mjs +3 -2
  30. package/resources/v1-beta/entity-types.mjs.map +1 -1
  31. package/src/client.ts +3 -3
  32. package/src/resources/v1/customers/customers.ts +20 -0
  33. package/src/resources/v1-beta/customers/entities.ts +5 -9
  34. package/src/resources/v1-beta/entity-types.ts +18 -2
  35. package/src/version.ts +1 -1
  36. package/version.d.mts +1 -1
  37. package/version.d.ts +1 -1
  38. package/version.js +1 -1
  39. package/version.mjs +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"entity-types.js","sourceRoot":"","sources":["../../src/resources/v1-beta/entity-types.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAA+F;AAC/F,uDAAsD;AAGtD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAClG,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,2BAA2B,EAAE,CAAA,2BAAsC,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAvED,kCAuEC"}
1
+ {"version":3,"file":"entity-types.js","sourceRoot":"","sources":["../../src/resources/v1-beta/entity-types.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAA+F;AAC/F,uDAAsD;AAGtD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAClG,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,2BAA2B,EAAE,CAAA,2BAAsC,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AAxED,kCAwEC"}
@@ -6,7 +6,8 @@ export class EntityTypes extends APIResource {
6
6
  /**
7
7
  * Returns a cursor-paginated list of entity types defined in the environment.
8
8
  * Entity types are vendor-defined categories of resource that can be governed
9
- * (e.g. Org, Team, User).
9
+ * (e.g. Org, Team, User). Archived entity types are excluded unless
10
+ * includeArchived=true.
10
11
  *
11
12
  * @example
12
13
  * ```ts
@@ -33,7 +34,7 @@ export class EntityTypes extends APIResource {
33
34
  /**
34
35
  * Batched create-or-update of entity types. Existing types matched by id are
35
36
  * updated; new ids are created. Idempotent — re-submitting the same payload
36
- * converges to the same state.
37
+ * converges to the same state. An upsert of an archived entity type restores it.
37
38
  *
38
39
  * @example
39
40
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"entity-types.mjs","sourceRoot":"","sources":["../../src/resources/v1-beta/entity-types.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,cAAc,EAA0C,kCAA8B;AAC/F,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAGtD,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAClG,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,2BAA2B,EAAE,CAAA,cAAsC,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"entity-types.mjs","sourceRoot":"","sources":["../../src/resources/v1-beta/entity-types.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,cAAc,EAA0C,kCAA8B;AAC/F,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAGtD,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAClG,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,2BAA2B,EAAE,CAAA,cAAsC,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,MAA8B,EAAE,OAAwB;QAC7D,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBACpE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACjF;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}
package/src/client.ts CHANGED
@@ -132,7 +132,7 @@ export class Stigg {
132
132
  * API Client for interfacing with the Stigg API.
133
133
  *
134
134
  * @param {string | undefined} [opts.apiKey=process.env['STIGG_API_KEY'] ?? undefined]
135
- * @param {string} [opts.baseURL=process.env['STIGG_BASE_URL'] ?? https://api.stigg.io] - Override the default base URL for the API.
135
+ * @param {string} [opts.baseURL=process.env['STIGG_BASE_URL'] ?? https://edge.api.stigg.io] - Override the default base URL for the API.
136
136
  * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
137
137
  * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
138
138
  * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
@@ -154,7 +154,7 @@ export class Stigg {
154
154
  const options: ClientOptions = {
155
155
  apiKey,
156
156
  ...opts,
157
- baseURL: baseURL || `https://api.stigg.io`,
157
+ baseURL: baseURL || `https://edge.api.stigg.io`,
158
158
  };
159
159
 
160
160
  this.baseURL = options.baseURL!;
@@ -212,7 +212,7 @@ export class Stigg {
212
212
  * Check whether the base URL is set to its default.
213
213
  */
214
214
  #baseURLOverridden(): boolean {
215
- return this.baseURL !== 'https://api.stigg.io';
215
+ return this.baseURL !== 'https://edge.api.stigg.io';
216
216
  }
217
217
 
218
218
  protected defaultQuery(): Record<string, string | undefined> | undefined {
@@ -625,6 +625,11 @@ export namespace CustomerResponse {
625
625
  */
626
626
  passthrough?: Data.Passthrough;
627
627
 
628
+ /**
629
+ * The unique identifier for the customer in Salesforce integration
630
+ */
631
+ salesforceId?: string | null;
632
+
628
633
  /**
629
634
  * Timezone to use for this customer
630
635
  */
@@ -1235,6 +1240,11 @@ export interface CustomerListResponse {
1235
1240
  */
1236
1241
  passthrough?: CustomerListResponse.Passthrough;
1237
1242
 
1243
+ /**
1244
+ * The unique identifier for the customer in Salesforce integration
1245
+ */
1246
+ salesforceId?: string | null;
1247
+
1238
1248
  /**
1239
1249
  * Timezone to use for this customer
1240
1250
  */
@@ -2813,6 +2823,11 @@ export interface CustomerUpdateParams {
2813
2823
  */
2814
2824
  passthrough?: CustomerUpdateParams.Passthrough;
2815
2825
 
2826
+ /**
2827
+ * Body param: The unique identifier for the customer in Salesforce integration
2828
+ */
2829
+ salesforceId?: string | null;
2830
+
2816
2831
  /**
2817
2832
  * Body param: Timezone to use for this customer
2818
2833
  */
@@ -3675,6 +3690,11 @@ export interface CustomerProvisionParams {
3675
3690
  */
3676
3691
  passthrough?: CustomerProvisionParams.Passthrough;
3677
3692
 
3693
+ /**
3694
+ * Body param: The unique identifier for the customer in Salesforce integration
3695
+ */
3696
+ salesforceId?: string | null;
3697
+
3678
3698
  /**
3679
3699
  * Body param: Timezone to use for this customer
3680
3700
  */
@@ -104,15 +104,10 @@ export class Entities extends APIResource {
104
104
  }
105
105
 
106
106
  /**
107
- * Restores previously archived entities in bulk for the given customer by id.
107
+ * Deprecated: upsert an entity to restore it. Restores previously archived
108
+ * entities in bulk for the given customer by id.
108
109
  *
109
- * @example
110
- * ```ts
111
- * const response =
112
- * await client.v1Beta.customers.entities.unarchive('id', {
113
- * ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
114
- * });
115
- * ```
110
+ * @deprecated
116
111
  */
117
112
  unarchive(
118
113
  id: string,
@@ -135,7 +130,8 @@ export class Entities extends APIResource {
135
130
 
136
131
  /**
137
132
  * Creates or updates entities in bulk for the given customer. Existing entities
138
- * matched by id are updated; new ids are created.
133
+ * matched by id are updated; new ids are created. An upsert of an archived entity
134
+ * restores it. An entity on an archived entity type fails with 400.
139
135
  *
140
136
  * @example
141
137
  * ```ts
@@ -10,7 +10,8 @@ export class EntityTypes extends APIResource {
10
10
  /**
11
11
  * Returns a cursor-paginated list of entity types defined in the environment.
12
12
  * Entity types are vendor-defined categories of resource that can be governed
13
- * (e.g. Org, Team, User).
13
+ * (e.g. Org, Team, User). Archived entity types are excluded unless
14
+ * includeArchived=true.
14
15
  *
15
16
  * @example
16
17
  * ```ts
@@ -41,7 +42,7 @@ export class EntityTypes extends APIResource {
41
42
  /**
42
43
  * Batched create-or-update of entity types. Existing types matched by id are
43
44
  * updated; new ids are created. Idempotent — re-submitting the same payload
44
- * converges to the same state.
45
+ * converges to the same state. An upsert of an archived entity type restores it.
45
46
  *
46
47
  * @example
47
48
  * ```ts
@@ -93,6 +94,11 @@ export interface EntityTypeListResponse {
93
94
  */
94
95
  id: string;
95
96
 
97
+ /**
98
+ * Timestamp of when the record was deleted
99
+ */
100
+ archivedAt: string | null;
101
+
96
102
  /**
97
103
  * Dimension keys used to attribute usage events to instances of this type (e.g.
98
104
  * ["orgId"]). Empty array means no attribution.
@@ -141,6 +147,11 @@ export namespace EntityTypeUpsertResponse {
141
147
  */
142
148
  id: string;
143
149
 
150
+ /**
151
+ * Timestamp of when the record was deleted
152
+ */
153
+ archivedAt: string | null;
154
+
144
155
  /**
145
156
  * Dimension keys used to attribute usage events to instances of this type (e.g.
146
157
  * ["orgId"]). Empty array means no attribution.
@@ -171,6 +182,11 @@ export namespace EntityTypeUpsertResponse {
171
182
  }
172
183
 
173
184
  export interface EntityTypeListParams extends MyCursorIDPageParams {
185
+ /**
186
+ * Query param: Whether to include archived entity types. One of: true, false
187
+ */
188
+ includeArchived?: 'true' | 'false';
189
+
174
190
  /**
175
191
  * Header param: Account ID — optional when authenticating with a user JWT (Bearer
176
192
  * token); falls back to the user's first membership. Ignored for API-key auth.
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.1.0-beta.63'; // x-release-please-version
1
+ export const VERSION = '0.1.0-beta.65'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.1.0-beta.63";
1
+ export declare const VERSION = "0.1.0-beta.65";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.1.0-beta.63";
1
+ export declare const VERSION = "0.1.0-beta.65";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.1.0-beta.63'; // x-release-please-version
4
+ exports.VERSION = '0.1.0-beta.65'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.1.0-beta.63'; // x-release-please-version
1
+ export const VERSION = '0.1.0-beta.65'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map