@seamapi/types 1.687.0 → 1.689.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.
@@ -14946,6 +14946,7 @@ declare const batch: z.ZodObject<{
14946
14946
  }>>;
14947
14947
  account_type: z.ZodOptional<z.ZodString>;
14948
14948
  account_type_display_name: z.ZodString;
14949
+ display_name: z.ZodString;
14949
14950
  errors: z.ZodArray<z.ZodDiscriminatedUnion<"error_code", [z.ZodObject<{
14950
14951
  created_at: z.ZodString;
14951
14952
  message: z.ZodString;
@@ -15158,6 +15159,7 @@ declare const batch: z.ZodObject<{
15158
15159
  customer_key: z.ZodOptional<z.ZodString>;
15159
15160
  accepted_capabilities: z.ZodArray<z.ZodEnum<["lock", "thermostat", "noise_sensor", "access_control"]>, "many">;
15160
15161
  }, "strip", z.ZodTypeAny, {
15162
+ display_name: string;
15161
15163
  errors: ({
15162
15164
  message: string;
15163
15165
  created_at: string;
@@ -15226,6 +15228,7 @@ declare const batch: z.ZodObject<{
15226
15228
  account_type?: string | undefined;
15227
15229
  customer_key?: string | undefined;
15228
15230
  }, {
15231
+ display_name: string;
15229
15232
  errors: ({
15230
15233
  message: string;
15231
15234
  created_at: string;
@@ -32755,6 +32758,7 @@ declare const batch: z.ZodObject<{
32755
32758
  nickname?: string | undefined;
32756
32759
  }[] | undefined;
32757
32760
  connected_accounts?: {
32761
+ display_name: string;
32758
32762
  errors: ({
32759
32763
  message: string;
32760
32764
  created_at: string;
@@ -36813,6 +36817,7 @@ declare const batch: z.ZodObject<{
36813
36817
  nickname?: string | undefined;
36814
36818
  }[] | undefined;
36815
36819
  connected_accounts?: {
36820
+ display_name: string;
36816
36821
  errors: ({
36817
36822
  message: string;
36818
36823
  created_at: string;
@@ -40606,6 +40611,7 @@ declare const connected_account: z.ZodObject<{
40606
40611
  }>>;
40607
40612
  account_type: z.ZodOptional<z.ZodString>;
40608
40613
  account_type_display_name: z.ZodString;
40614
+ display_name: z.ZodString;
40609
40615
  errors: z.ZodArray<z.ZodDiscriminatedUnion<"error_code", [z.ZodObject<{
40610
40616
  created_at: z.ZodString;
40611
40617
  message: z.ZodString;
@@ -40818,6 +40824,7 @@ declare const connected_account: z.ZodObject<{
40818
40824
  customer_key: z.ZodOptional<z.ZodString>;
40819
40825
  accepted_capabilities: z.ZodArray<z.ZodEnum<["lock", "thermostat", "noise_sensor", "access_control"]>, "many">;
40820
40826
  }, "strip", z.ZodTypeAny, {
40827
+ display_name: string;
40821
40828
  errors: ({
40822
40829
  message: string;
40823
40830
  created_at: string;
@@ -40886,6 +40893,7 @@ declare const connected_account: z.ZodObject<{
40886
40893
  account_type?: string | undefined;
40887
40894
  customer_key?: string | undefined;
40888
40895
  }, {
40896
+ display_name: string;
40889
40897
  errors: ({
40890
40898
  message: string;
40891
40899
  created_at: string;
@@ -57428,6 +57436,10 @@ declare const _default: {
57428
57436
  description: string;
57429
57437
  type: string;
57430
57438
  };
57439
+ display_name: {
57440
+ description: string;
57441
+ type: string;
57442
+ };
57431
57443
  errors: {
57432
57444
  description: string;
57433
57445
  items: {
@@ -57532,6 +57544,7 @@ declare const _default: {
57532
57544
  type: string;
57533
57545
  };
57534
57546
  user_identifier: {
57547
+ deprecated: boolean;
57535
57548
  description: string;
57536
57549
  properties: {
57537
57550
  api_url: {
@@ -57556,6 +57569,7 @@ declare const _default: {
57556
57569
  };
57557
57570
  };
57558
57571
  type: string;
57572
+ 'x-deprecated': string;
57559
57573
  };
57560
57574
  warnings: {
57561
57575
  description: string;
@@ -98061,16 +98075,10 @@ declare const _default: {
98061
98075
  };
98062
98076
  security: ({
98063
98077
  api_key: never[];
98064
- client_session_with_customer?: never;
98065
- console_session_with_workspace?: never;
98066
- } | {
98067
- client_session_with_customer: never[];
98068
- api_key?: never;
98069
98078
  console_session_with_workspace?: never;
98070
98079
  } | {
98071
98080
  console_session_with_workspace: never[];
98072
98081
  api_key?: never;
98073
- client_session_with_customer?: never;
98074
98082
  })[];
98075
98083
  summary: string;
98076
98084
  tags: never[];
@@ -98091,11 +98099,23 @@ declare const _default: {
98091
98099
  'application/json': {
98092
98100
  schema: {
98093
98101
  properties: {
98102
+ connector_customer_id: {
98103
+ type: string;
98104
+ };
98094
98105
  connector_id: {
98095
98106
  description: string;
98096
98107
  minLength: number;
98097
98108
  type: string;
98098
98109
  };
98110
+ customer_id: {
98111
+ type: string;
98112
+ };
98113
+ customer_key: {
98114
+ type: string;
98115
+ };
98116
+ unique_provider_resource_key: {
98117
+ type: string;
98118
+ };
98099
98119
  };
98100
98120
  required: string[];
98101
98121
  type: string;
@@ -98145,16 +98165,10 @@ declare const _default: {
98145
98165
  };
98146
98166
  security: ({
98147
98167
  api_key: never[];
98148
- client_session_with_customer?: never;
98149
- console_session_with_workspace?: never;
98150
- } | {
98151
- client_session_with_customer: never[];
98152
- api_key?: never;
98153
98168
  console_session_with_workspace?: never;
98154
98169
  } | {
98155
98170
  console_session_with_workspace: never[];
98156
98171
  api_key?: never;
98157
- client_session_with_customer?: never;
98158
98172
  })[];
98159
98173
  summary: string;
98160
98174
  tags: never[];
@@ -98337,11 +98351,34 @@ declare const _default: {
98337
98351
  'application/json': {
98338
98352
  schema: {
98339
98353
  properties: {
98354
+ connector_customer_id: {
98355
+ description: string;
98356
+ format: string;
98357
+ nullable: boolean;
98358
+ type: string;
98359
+ };
98340
98360
  connector_id: {
98341
98361
  description: string;
98342
98362
  format: string;
98343
98363
  type: string;
98344
98364
  };
98365
+ connector_type: {
98366
+ description: string;
98367
+ type: string;
98368
+ };
98369
+ customer_id: {
98370
+ description: string;
98371
+ type: string;
98372
+ };
98373
+ customer_key: {
98374
+ description: string;
98375
+ type: string;
98376
+ };
98377
+ unique_provider_resource_key: {
98378
+ description: string;
98379
+ nullable: boolean;
98380
+ type: string;
98381
+ };
98345
98382
  };
98346
98383
  required: string[];
98347
98384
  type: string;
@@ -98357,9 +98394,6 @@ declare const _default: {
98357
98394
  properties: {
98358
98395
  connector_sync: {
98359
98396
  properties: {
98360
- connector_id: {
98361
- type: string;
98362
- };
98363
98397
  message: {
98364
98398
  type: string;
98365
98399
  };
@@ -125917,7 +125951,8 @@ type Routes = {
125917
125951
  connected_account_id: string;
125918
125952
  /** Date and time at which the connected account was created. */
125919
125953
  created_at?: string | undefined;
125920
- /** User identifier associated with the connected account. */
125954
+ /** User identifier associated with the connected account.
125955
+ * @deprecated Use `display_name` instead.*/
125921
125956
  user_identifier?: {
125922
125957
  /** Username of the user identifier associated with the connected account. */
125923
125958
  username?: string | undefined;
@@ -125934,6 +125969,8 @@ type Routes = {
125934
125969
  account_type?: string | undefined;
125935
125970
  /** Display name for the connected account type. */
125936
125971
  account_type_display_name: string;
125972
+ /** Display name for the connected account. */
125973
+ display_name: string;
125937
125974
  /** Errors associated with the connected account. */
125938
125975
  errors: ({
125939
125976
  /** Date and time at which Seam created the error. */
@@ -140415,7 +140452,8 @@ type Routes = {
140415
140452
  connected_account_id: string;
140416
140453
  /** Date and time at which the connected account was created. */
140417
140454
  created_at?: string | undefined;
140418
- /** User identifier associated with the connected account. */
140455
+ /** User identifier associated with the connected account.
140456
+ * @deprecated Use `display_name` instead.*/
140419
140457
  user_identifier?: {
140420
140458
  /** Username of the user identifier associated with the connected account. */
140421
140459
  username?: string | undefined;
@@ -140432,6 +140470,8 @@ type Routes = {
140432
140470
  account_type?: string | undefined;
140433
140471
  /** Display name for the connected account type. */
140434
140472
  account_type_display_name: string;
140473
+ /** Display name for the connected account. */
140474
+ display_name: string;
140435
140475
  /** Errors associated with the connected account. */
140436
140476
  errors: ({
140437
140477
  /** Date and time at which Seam created the error. */
@@ -140567,7 +140607,8 @@ type Routes = {
140567
140607
  connected_account_id: string;
140568
140608
  /** Date and time at which the connected account was created. */
140569
140609
  created_at?: string | undefined;
140570
- /** User identifier associated with the connected account. */
140610
+ /** User identifier associated with the connected account.
140611
+ * @deprecated Use `display_name` instead.*/
140571
140612
  user_identifier?: {
140572
140613
  /** Username of the user identifier associated with the connected account. */
140573
140614
  username?: string | undefined;
@@ -140584,6 +140625,8 @@ type Routes = {
140584
140625
  account_type?: string | undefined;
140585
140626
  /** Display name for the connected account type. */
140586
140627
  account_type_display_name: string;
140628
+ /** Display name for the connected account. */
140629
+ display_name: string;
140587
140630
  /** Errors associated with the connected account. */
140588
140631
  errors: ({
140589
140632
  /** Date and time at which Seam created the error. */
@@ -140753,7 +140796,8 @@ type Routes = {
140753
140796
  connected_account_id: string;
140754
140797
  /** Date and time at which the connected account was created. */
140755
140798
  created_at?: string | undefined;
140756
- /** User identifier associated with the connected account. */
140799
+ /** User identifier associated with the connected account.
140800
+ * @deprecated Use `display_name` instead.*/
140757
140801
  user_identifier?: {
140758
140802
  /** Username of the user identifier associated with the connected account. */
140759
140803
  username?: string | undefined;
@@ -140770,6 +140814,8 @@ type Routes = {
140770
140814
  account_type?: string | undefined;
140771
140815
  /** Display name for the connected account type. */
140772
140816
  account_type_display_name: string;
140817
+ /** Display name for the connected account. */
140818
+ display_name: string;
140773
140819
  /** Errors associated with the connected account. */
140774
140820
  errors: ({
140775
140821
  /** Date and time at which Seam created the error. */
@@ -166813,6 +166859,10 @@ type Routes = {
166813
166859
  jsonBody: {
166814
166860
  /** ID of the connector to delete */
166815
166861
  connector_id: string;
166862
+ customer_key?: string | undefined;
166863
+ customer_id?: string | undefined;
166864
+ connector_customer_id?: string | undefined;
166865
+ unique_provider_resource_key?: string | undefined;
166816
166866
  };
166817
166867
  commonParams: {};
166818
166868
  formData: {};
@@ -166854,11 +166904,20 @@ type Routes = {
166854
166904
  commonParams: {
166855
166905
  /** ID of the connector to sync */
166856
166906
  connector_id: string;
166907
+ /** Type of the connector to sync */
166908
+ connector_type: string;
166909
+ /** ID of the customer to sync */
166910
+ customer_id: string;
166911
+ /** Key of the customer to sync */
166912
+ customer_key: string;
166913
+ /** ID of the connector customer to sync */
166914
+ connector_customer_id: string | null;
166915
+ /** Unique provider resource key of the connector to sync */
166916
+ unique_provider_resource_key: string | null;
166857
166917
  };
166858
166918
  formData: {};
166859
166919
  jsonResponse: {
166860
166920
  connector_sync: {
166861
- connector_id: string;
166862
166921
  status: string;
166863
166922
  message: string;
166864
166923
  };
@@ -171551,7 +171610,8 @@ type Routes = {
171551
171610
  connected_account_id: string;
171552
171611
  /** Date and time at which the connected account was created. */
171553
171612
  created_at?: string | undefined;
171554
- /** User identifier associated with the connected account. */
171613
+ /** User identifier associated with the connected account.
171614
+ * @deprecated Use `display_name` instead.*/
171555
171615
  user_identifier?: {
171556
171616
  /** Username of the user identifier associated with the connected account. */
171557
171617
  username?: string | undefined;
@@ -171568,6 +171628,8 @@ type Routes = {
171568
171628
  account_type?: string | undefined;
171569
171629
  /** Display name for the connected account type. */
171570
171630
  account_type_display_name: string;
171631
+ /** Display name for the connected account. */
171632
+ display_name: string;
171571
171633
  /** Errors associated with the connected account. */
171572
171634
  errors: ({
171573
171635
  /** Date and time at which Seam created the error. */
@@ -195460,7 +195522,8 @@ type Routes = {
195460
195522
  connected_account_id: string;
195461
195523
  /** Date and time at which the connected account was created. */
195462
195524
  created_at?: string | undefined;
195463
- /** User identifier associated with the connected account. */
195525
+ /** User identifier associated with the connected account.
195526
+ * @deprecated Use `display_name` instead.*/
195464
195527
  user_identifier?: {
195465
195528
  /** Username of the user identifier associated with the connected account. */
195466
195529
  username?: string | undefined;
@@ -195477,6 +195540,8 @@ type Routes = {
195477
195540
  account_type?: string | undefined;
195478
195541
  /** Display name for the connected account type. */
195479
195542
  account_type_display_name: string;
195543
+ /** Display name for the connected account. */
195544
+ display_name: string;
195480
195545
  /** Errors associated with the connected account. */
195481
195546
  errors: ({
195482
195547
  /** Date and time at which Seam created the error. */
package/dist/index.cjs CHANGED
@@ -705,9 +705,15 @@ var connected_account = zod.z.object({
705
705
  exclusive: zod.z.boolean().optional().describe(
706
706
  "Indicates whether the user identifier associated with the connected account is exclusive."
707
707
  )
708
- }).optional().describe("User identifier associated with the connected account."),
708
+ }).optional().describe(`
709
+ ---
710
+ deprecated: Use \`display_name\` instead.
711
+ ---
712
+ User identifier associated with the connected account.
713
+ `),
709
714
  account_type: zod.z.string().optional().describe("Type of connected account."),
710
715
  account_type_display_name: zod.z.string().describe("Display name for the connected account type."),
716
+ display_name: zod.z.string().describe("Display name for the connected account."),
711
717
  errors: zod.z.array(connected_account_error).describe("Errors associated with the connected account."),
712
718
  warnings: zod.z.array(connected_account_warning).describe("Warnings associated with the connected account."),
713
719
  custom_metadata,
@@ -14064,6 +14070,10 @@ var openapi_default = {
14064
14070
  description: "Your unique key for the customer associated with this connected account.",
14065
14071
  type: "string"
14066
14072
  },
14073
+ display_name: {
14074
+ description: "Display name for the connected account.",
14075
+ type: "string"
14076
+ },
14067
14077
  errors: {
14068
14078
  description: "Errors associated with the connected account.",
14069
14079
  items: {
@@ -14207,6 +14217,7 @@ var openapi_default = {
14207
14217
  type: "array"
14208
14218
  },
14209
14219
  user_identifier: {
14220
+ deprecated: true,
14210
14221
  description: "User identifier associated with the connected account.",
14211
14222
  properties: {
14212
14223
  api_url: {
@@ -14230,7 +14241,8 @@ var openapi_default = {
14230
14241
  type: "string"
14231
14242
  }
14232
14243
  },
14233
- type: "object"
14244
+ type: "object",
14245
+ "x-deprecated": "Use `display_name` instead."
14234
14246
  },
14235
14247
  warnings: {
14236
14248
  description: "Warnings associated with the connected account.",
@@ -14376,6 +14388,7 @@ var openapi_default = {
14376
14388
  required: [
14377
14389
  "connected_account_id",
14378
14390
  "account_type_display_name",
14391
+ "display_name",
14379
14392
  "errors",
14380
14393
  "warnings",
14381
14394
  "custom_metadata",
@@ -55760,7 +55773,7 @@ var openapi_default = {
55760
55773
  },
55761
55774
  "/seam/customer/v1/connectors/create": {
55762
55775
  post: {
55763
- description: "Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.\nIf a connector already exists for the same customer, it will be updated instead of creating a new one.",
55776
+ description: "Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.",
55764
55777
  operationId: "seamCustomerV1ConnectorsCreatePost",
55765
55778
  requestBody: {
55766
55779
  content: {
@@ -55848,11 +55861,7 @@ var openapi_default = {
55848
55861
  400: { description: "Bad Request" },
55849
55862
  401: { description: "Unauthorized" }
55850
55863
  },
55851
- security: [
55852
- { api_key: [] },
55853
- { client_session_with_customer: [] },
55854
- { console_session_with_workspace: [] }
55855
- ],
55864
+ security: [{ api_key: [] }, { console_session_with_workspace: [] }],
55856
55865
  summary: "/seam/customer/v1/connectors/create",
55857
55866
  tags: [],
55858
55867
  "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"],
@@ -55872,11 +55881,15 @@ var openapi_default = {
55872
55881
  "application/json": {
55873
55882
  schema: {
55874
55883
  properties: {
55884
+ connector_customer_id: { type: "string" },
55875
55885
  connector_id: {
55876
55886
  description: "ID of the connector to delete",
55877
55887
  minLength: 1,
55878
55888
  type: "string"
55879
- }
55889
+ },
55890
+ customer_id: { type: "string" },
55891
+ customer_key: { type: "string" },
55892
+ unique_provider_resource_key: { type: "string" }
55880
55893
  },
55881
55894
  required: ["connector_id"],
55882
55895
  type: "object"
@@ -55911,11 +55924,7 @@ var openapi_default = {
55911
55924
  400: { description: "Bad Request" },
55912
55925
  401: { description: "Unauthorized" }
55913
55926
  },
55914
- security: [
55915
- { api_key: [] },
55916
- { client_session_with_customer: [] },
55917
- { console_session_with_workspace: [] }
55918
- ],
55927
+ security: [{ api_key: [] }, { console_session_with_workspace: [] }],
55919
55928
  summary: "/seam/customer/v1/connectors/delete",
55920
55929
  tags: [],
55921
55930
  "x-fern-sdk-group-name": ["seam", "customer", "v1", "connectors"],
@@ -56067,13 +56076,43 @@ var openapi_default = {
56067
56076
  "application/json": {
56068
56077
  schema: {
56069
56078
  properties: {
56079
+ connector_customer_id: {
56080
+ description: "ID of the connector customer to sync",
56081
+ format: "uuid",
56082
+ nullable: true,
56083
+ type: "string"
56084
+ },
56070
56085
  connector_id: {
56071
56086
  description: "ID of the connector to sync",
56072
56087
  format: "uuid",
56073
56088
  type: "string"
56089
+ },
56090
+ connector_type: {
56091
+ description: "Type of the connector to sync",
56092
+ type: "string"
56093
+ },
56094
+ customer_id: {
56095
+ description: "ID of the customer to sync",
56096
+ type: "string"
56097
+ },
56098
+ customer_key: {
56099
+ description: "Key of the customer to sync",
56100
+ type: "string"
56101
+ },
56102
+ unique_provider_resource_key: {
56103
+ description: "Unique provider resource key of the connector to sync",
56104
+ nullable: true,
56105
+ type: "string"
56074
56106
  }
56075
56107
  },
56076
- required: ["connector_id"],
56108
+ required: [
56109
+ "connector_id",
56110
+ "connector_type",
56111
+ "customer_id",
56112
+ "customer_key",
56113
+ "connector_customer_id",
56114
+ "unique_provider_resource_key"
56115
+ ],
56077
56116
  type: "object"
56078
56117
  }
56079
56118
  }
@@ -56087,11 +56126,10 @@ var openapi_default = {
56087
56126
  properties: {
56088
56127
  connector_sync: {
56089
56128
  properties: {
56090
- connector_id: { type: "string" },
56091
56129
  message: { type: "string" },
56092
56130
  status: { type: "string" }
56093
56131
  },
56094
- required: ["connector_id", "status", "message"],
56132
+ required: ["status", "message"],
56095
56133
  type: "object"
56096
56134
  },
56097
56135
  ok: { type: "boolean" }