@deepraxis/sdk 0.1.1-dev.de0a917 → 0.1.1-dev.e47a392

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.
@@ -6417,6 +6417,1352 @@ export declare const operations: readonly [{
6417
6417
  readonly description: "Collection display name, 1–100 characters after trimming surrounding whitespace; duplicate names within the organization are allowed.";
6418
6418
  }];
6419
6419
  };
6420
+ }, {
6421
+ readonly resource: "crm.changes";
6422
+ readonly method: "revert";
6423
+ readonly summary: "Revert change set";
6424
+ readonly description: "Reverse property changes made by one earlier request. Unlike HubSpot, CRM exposes change-set reversal because agents need to undo a whole recorded action rather than manually reconstructing individual values. Supply the changeSetId recorded in property history. A later conflicting value prevents reversal with HTTP 409 CONFLICT; inspect current records before resolving the conflict. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
6425
+ readonly http: "POST";
6426
+ readonly path: "/crm/v1/changes/{changeSetId}:revert";
6427
+ readonly streaming: "no";
6428
+ readonly pagination: false;
6429
+ readonly pathParams: readonly [{
6430
+ readonly name: "changeSetId";
6431
+ readonly sdkName: "changeSetId";
6432
+ readonly description: "Change-set identifier recorded for the original write in property history; one request forms one change set.";
6433
+ }];
6434
+ readonly query: readonly [];
6435
+ }, {
6436
+ readonly resource: "crm.layouts";
6437
+ readonly method: "retrieve";
6438
+ readonly summary: "Retrieve record layout";
6439
+ readonly description: "Read the shared record-page layout for an object type from schemas.list. Unlike HubSpot, CRM exposes this presentation as an API resource so people and agents can share the same record layout instead of relying on interface-only settings. The response orders summary tiles, sidebar properties and main-column sections.";
6440
+ readonly http: "GET";
6441
+ readonly path: "/crm/v1/layouts/{objectType}";
6442
+ readonly streaming: "no";
6443
+ readonly pagination: false;
6444
+ readonly pathParams: readonly [{
6445
+ readonly name: "objectType";
6446
+ readonly sdkName: "objectType";
6447
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6448
+ }];
6449
+ readonly query: readonly [];
6450
+ }, {
6451
+ readonly resource: "crm.layouts";
6452
+ readonly method: "update";
6453
+ readonly summary: "Update record layout";
6454
+ readonly description: "Replace the shared record-page layout for an object type from schemas.list. Unlike HubSpot, CRM exposes this presentation as an API resource so agents can configure the same record view used by people. Send the complete layout with at most three summary tiles and property names from properties.list; omitted prior sections are removed. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
6455
+ readonly http: "PUT";
6456
+ readonly path: "/crm/v1/layouts/{objectType}";
6457
+ readonly streaming: "no";
6458
+ readonly pagination: false;
6459
+ readonly pathParams: readonly [{
6460
+ readonly name: "objectType";
6461
+ readonly sdkName: "objectType";
6462
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6463
+ }];
6464
+ readonly query: readonly [];
6465
+ readonly body: {
6466
+ readonly required: true;
6467
+ readonly fields: readonly [{
6468
+ readonly name: "objectType";
6469
+ readonly type: "string";
6470
+ readonly required: true;
6471
+ readonly description: "Object type whose record page uses this layout, matching the path parameter.";
6472
+ }, {
6473
+ readonly name: "summary";
6474
+ readonly type: "array";
6475
+ readonly itemType: "object";
6476
+ readonly required: true;
6477
+ readonly description: "Ordered statistic tiles below the record header, with at most three tiles.";
6478
+ }, {
6479
+ readonly name: "sidebar";
6480
+ readonly type: "array";
6481
+ readonly itemType: "string";
6482
+ readonly required: true;
6483
+ readonly description: "Ordered internal property names shown in the record property sidebar.";
6484
+ }, {
6485
+ readonly name: "sections";
6486
+ readonly type: "array";
6487
+ readonly itemType: "string";
6488
+ readonly required: true;
6489
+ readonly description: "Ordered main-column sections for activity, relationships, tables and property groups.";
6490
+ }];
6491
+ };
6492
+ }, {
6493
+ readonly resource: "crm.leads";
6494
+ readonly method: "qualify";
6495
+ readonly summary: "Qualify lead";
6496
+ readonly description: "Qualify a lead with explicit contact, company and optional deal choices in one operation. Unlike HubSpot, CRM exposes these decisions as a single action because qualification coordinates several related record edits rather than editing only the lead stage. Obtain leadId from objects.list for leads and qualifiedStageId from its pipeline; choose a won stage and satisfy its required properties. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
6497
+ readonly http: "POST";
6498
+ readonly path: "/crm/v1/leads/{leadId}:qualify";
6499
+ readonly streaming: "no";
6500
+ readonly pagination: false;
6501
+ readonly pathParams: readonly [{
6502
+ readonly name: "leadId";
6503
+ readonly sdkName: "leadId";
6504
+ readonly description: "Lead record identifier from objects.list or objects.search with objectType=leads.";
6505
+ }];
6506
+ readonly query: readonly [];
6507
+ readonly body: {
6508
+ readonly required: true;
6509
+ readonly fields: readonly [{
6510
+ readonly name: "contact";
6511
+ readonly type: "object";
6512
+ readonly required: true;
6513
+ readonly description: "Keep the existing contact, or merge it into the chosen contact record.";
6514
+ }, {
6515
+ readonly name: "company";
6516
+ readonly type: "object";
6517
+ readonly required: true;
6518
+ readonly description: "Leave company unchanged, associate an existing company, or create one with explicit properties.";
6519
+ }, {
6520
+ readonly name: "deal";
6521
+ readonly type: "object";
6522
+ readonly required: false;
6523
+ readonly description: "Optional deal to create as part of qualification; omit to qualify without creating a deal.";
6524
+ }, {
6525
+ readonly name: "qualifiedStageId";
6526
+ readonly type: "string";
6527
+ readonly required: true;
6528
+ readonly description: "Lead stage id with praxis_category=won, obtained from the leads pipeline.";
6529
+ }];
6530
+ };
6531
+ }, {
6532
+ readonly resource: "crm.objects";
6533
+ readonly method: "list";
6534
+ readonly summary: "List records";
6535
+ readonly description: "Browse records of one object type and obtain ids for retrieval or edits. Discover objectType with schemas.list; select properties by internal names from properties.list. Omit after for the first page, then copy paging.next.after until no next page is returned. archived defaults to false; use objects.search for property filters.";
6536
+ readonly http: "GET";
6537
+ readonly path: "/crm/v1/objects/{objectType}";
6538
+ readonly streaming: "no";
6539
+ readonly pagination: false;
6540
+ readonly pathParams: readonly [{
6541
+ readonly name: "objectType";
6542
+ readonly sdkName: "objectType";
6543
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6544
+ }];
6545
+ readonly query: readonly [{
6546
+ readonly name: "after";
6547
+ readonly type: "string";
6548
+ readonly required: false;
6549
+ readonly description: "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.";
6550
+ }, {
6551
+ readonly name: "archived";
6552
+ readonly type: "boolean";
6553
+ readonly required: false;
6554
+ readonly description: "Whether to return only results that have been archived.";
6555
+ }, {
6556
+ readonly name: "associations";
6557
+ readonly type: "array";
6558
+ readonly itemType: "string";
6559
+ readonly required: false;
6560
+ readonly description: "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.";
6561
+ }, {
6562
+ readonly name: "limit";
6563
+ readonly type: "integer";
6564
+ readonly required: false;
6565
+ readonly description: "The maximum number of results to display per page.";
6566
+ }, {
6567
+ readonly name: "properties";
6568
+ readonly type: "array";
6569
+ readonly itemType: "string";
6570
+ readonly required: false;
6571
+ readonly description: "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.";
6572
+ }, {
6573
+ readonly name: "propertiesWithHistory";
6574
+ readonly type: "array";
6575
+ readonly itemType: "string";
6576
+ readonly required: false;
6577
+ readonly description: "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.";
6578
+ }];
6579
+ }, {
6580
+ readonly resource: "crm.objects";
6581
+ readonly method: "create";
6582
+ readonly summary: "Create record";
6583
+ readonly description: "Create a customer record with property values and optional initial associations. Discover objectType with schemas.list and allowed property names with properties.list; save the returned id for subsequent calls. Each call creates a record. Example for contacts: {\"properties\":{\"email\":\"person@example.com\"}}. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
6584
+ readonly http: "POST";
6585
+ readonly path: "/crm/v1/objects/{objectType}";
6586
+ readonly streaming: "no";
6587
+ readonly pagination: false;
6588
+ readonly pathParams: readonly [{
6589
+ readonly name: "objectType";
6590
+ readonly sdkName: "objectType";
6591
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6592
+ }];
6593
+ readonly query: readonly [];
6594
+ readonly body: {
6595
+ readonly required: true;
6596
+ readonly fields: readonly [{
6597
+ readonly name: "associations";
6598
+ readonly type: "array";
6599
+ readonly itemType: "object";
6600
+ readonly required: true;
6601
+ readonly description: "Initial relationships to existing records; choose destination ids and association type ids before creating the record.";
6602
+ }, {
6603
+ readonly name: "properties";
6604
+ readonly type: "object";
6605
+ readonly required: true;
6606
+ readonly description: "Key-value pairs for setting properties for the new object.";
6607
+ }];
6608
+ };
6609
+ }, {
6610
+ readonly resource: "crm.objects.batch";
6611
+ readonly method: "archive";
6612
+ readonly summary: "Batch archive records";
6613
+ readonly description: "Archive known records of one object type using inputs[].id from objects.list or objects.search. Archived records leave active lists but retain their history; confirm all ids before calling. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.";
6614
+ readonly http: "POST";
6615
+ readonly path: "/crm/v1/objects/{objectType}/batch/archive";
6616
+ readonly streaming: "no";
6617
+ readonly pagination: false;
6618
+ readonly pathParams: readonly [{
6619
+ readonly name: "objectType";
6620
+ readonly sdkName: "objectType";
6621
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6622
+ }];
6623
+ readonly query: readonly [];
6624
+ readonly body: {
6625
+ readonly required: true;
6626
+ readonly fields: readonly [{
6627
+ readonly name: "inputs";
6628
+ readonly type: "array";
6629
+ readonly itemType: "object";
6630
+ readonly required: true;
6631
+ readonly description: "Records to process in this batch, each using the identifiers and properties described by its item schema.";
6632
+ }];
6633
+ };
6634
+ }, {
6635
+ readonly resource: "crm.objects.batch";
6636
+ readonly method: "create";
6637
+ readonly summary: "Batch create records";
6638
+ readonly description: "Create several records of one object type using inputs with properties and optional associations. Obtain property names from properties.list; each successful input creates a record, so inspect per-item errors before resubmitting failed inputs. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
6639
+ readonly http: "POST";
6640
+ readonly path: "/crm/v1/objects/{objectType}/batch/create";
6641
+ readonly streaming: "no";
6642
+ readonly pagination: false;
6643
+ readonly pathParams: readonly [{
6644
+ readonly name: "objectType";
6645
+ readonly sdkName: "objectType";
6646
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6647
+ }];
6648
+ readonly query: readonly [];
6649
+ readonly body: {
6650
+ readonly required: true;
6651
+ readonly fields: readonly [{
6652
+ readonly name: "inputs";
6653
+ readonly type: "array";
6654
+ readonly itemType: "object";
6655
+ readonly required: true;
6656
+ readonly description: "Records to process in this batch, each using the identifiers and properties described by its item schema.";
6657
+ }];
6658
+ };
6659
+ }, {
6660
+ readonly resource: "crm.objects.batch";
6661
+ readonly method: "read";
6662
+ readonly summary: "Batch read records";
6663
+ readonly description: "Read a set of known record ids in one call; use objects.search to discover ids first. Supply inputs with ids plus requested properties; set idProperty only when the inputs use unique-property values rather than record ids.";
6664
+ readonly http: "POST";
6665
+ readonly path: "/crm/v1/objects/{objectType}/batch/read";
6666
+ readonly streaming: "no";
6667
+ readonly pagination: false;
6668
+ readonly pathParams: readonly [{
6669
+ readonly name: "objectType";
6670
+ readonly sdkName: "objectType";
6671
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6672
+ }];
6673
+ readonly query: readonly [{
6674
+ readonly name: "archived";
6675
+ readonly type: "boolean";
6676
+ readonly required: false;
6677
+ readonly description: "Whether to return only results that have been archived.";
6678
+ }];
6679
+ readonly body: {
6680
+ readonly required: true;
6681
+ readonly fields: readonly [{
6682
+ readonly name: "idProperty";
6683
+ readonly type: "string";
6684
+ readonly required: false;
6685
+ readonly description: "When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.";
6686
+ }, {
6687
+ readonly name: "inputs";
6688
+ readonly type: "array";
6689
+ readonly itemType: "object";
6690
+ readonly required: true;
6691
+ readonly description: "Records to process in this batch, each using the identifiers and properties described by its item schema.";
6692
+ }, {
6693
+ readonly name: "properties";
6694
+ readonly type: "array";
6695
+ readonly itemType: "string";
6696
+ readonly required: true;
6697
+ readonly description: "Internal property names to include in each returned record; obtain them from properties.list.";
6698
+ }, {
6699
+ readonly name: "propertiesWithHistory";
6700
+ readonly type: "array";
6701
+ readonly itemType: "string";
6702
+ readonly required: true;
6703
+ readonly description: "Internal property names whose previous values should be returned with each record; use an empty array when no history is needed.";
6704
+ }];
6705
+ };
6706
+ }, {
6707
+ readonly resource: "crm.objects.batch";
6708
+ readonly method: "update";
6709
+ readonly summary: "Batch update records";
6710
+ readonly description: "Apply distinct property patches to existing records identified by inputs[].id. Obtain ids from objects.list or objects.search and property names from properties.list. Omitted properties retain their values; inspect results and errors for each input. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
6711
+ readonly http: "POST";
6712
+ readonly path: "/crm/v1/objects/{objectType}/batch/update";
6713
+ readonly streaming: "no";
6714
+ readonly pagination: false;
6715
+ readonly pathParams: readonly [{
6716
+ readonly name: "objectType";
6717
+ readonly sdkName: "objectType";
6718
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6719
+ }];
6720
+ readonly query: readonly [];
6721
+ readonly body: {
6722
+ readonly required: true;
6723
+ readonly fields: readonly [{
6724
+ readonly name: "inputs";
6725
+ readonly type: "array";
6726
+ readonly itemType: "object";
6727
+ readonly required: true;
6728
+ readonly description: "Records to process in this batch, each using the identifiers and properties described by its item schema.";
6729
+ }];
6730
+ };
6731
+ }, {
6732
+ readonly resource: "crm.objects.batch";
6733
+ readonly method: "upsert";
6734
+ readonly summary: "Batch upsert records";
6735
+ readonly description: "Create records that do not yet exist or update matches using a unique property. Provide idProperty and its value in each input, plus properties; choose a property with hasUniqueValue from properties.list. Inspect each result to determine whether it was newly created. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
6736
+ readonly http: "POST";
6737
+ readonly path: "/crm/v1/objects/{objectType}/batch/upsert";
6738
+ readonly streaming: "no";
6739
+ readonly pagination: false;
6740
+ readonly pathParams: readonly [{
6741
+ readonly name: "objectType";
6742
+ readonly sdkName: "objectType";
6743
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6744
+ }];
6745
+ readonly query: readonly [];
6746
+ readonly body: {
6747
+ readonly required: true;
6748
+ readonly fields: readonly [{
6749
+ readonly name: "inputs";
6750
+ readonly type: "array";
6751
+ readonly itemType: "object";
6752
+ readonly required: true;
6753
+ readonly description: "Records to process in this batch, each using the identifiers and properties described by its item schema.";
6754
+ }];
6755
+ };
6756
+ }, {
6757
+ readonly resource: "crm.objects";
6758
+ readonly method: "search";
6759
+ readonly summary: "Search records";
6760
+ readonly description: "Find records using text query, property filters and sort order rather than scanning a list. Obtain objectType from schemas.list and filter propertyName values from properties.list. Supply filterGroups, sorts, properties, limit and after; use empty arrays for no filters, sorts or property selection, and an empty after for the first page. Copy paging.next.after with the same query to continue. This operation reads records without changing them.";
6761
+ readonly http: "POST";
6762
+ readonly path: "/crm/v1/objects/{objectType}/search";
6763
+ readonly streaming: "no";
6764
+ readonly pagination: false;
6765
+ readonly pathParams: readonly [{
6766
+ readonly name: "objectType";
6767
+ readonly sdkName: "objectType";
6768
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6769
+ }];
6770
+ readonly query: readonly [];
6771
+ readonly body: {
6772
+ readonly required: true;
6773
+ readonly fields: readonly [{
6774
+ readonly name: "after";
6775
+ readonly type: "string";
6776
+ readonly required: true;
6777
+ readonly description: "A paging cursor token for retrieving subsequent pages.";
6778
+ }, {
6779
+ readonly name: "filterGroups";
6780
+ readonly type: "array";
6781
+ readonly itemType: "object";
6782
+ readonly required: true;
6783
+ readonly description: "Up to 6 groups of filters defining additional query criteria.";
6784
+ }, {
6785
+ readonly name: "limit";
6786
+ readonly type: "integer";
6787
+ readonly required: true;
6788
+ readonly description: "The maximum results to return, up to 200 objects.";
6789
+ }, {
6790
+ readonly name: "properties";
6791
+ readonly type: "array";
6792
+ readonly itemType: "string";
6793
+ readonly required: true;
6794
+ readonly description: "Internal property names to include in each returned record; obtain them from properties.list.";
6795
+ }, {
6796
+ readonly name: "query";
6797
+ readonly type: "string";
6798
+ readonly required: false;
6799
+ readonly description: "The search query string, up to 3000 characters.";
6800
+ }, {
6801
+ readonly name: "sorts";
6802
+ readonly type: "array";
6803
+ readonly itemType: "string";
6804
+ readonly required: true;
6805
+ readonly description: "Property names controlling ordering; prefix a property name with a minus sign for descending order.";
6806
+ }];
6807
+ };
6808
+ }, {
6809
+ readonly resource: "crm.objects";
6810
+ readonly method: "archive";
6811
+ readonly summary: "Archive record";
6812
+ readonly description: "Archive a record selected from objects.list or objects.search when it should leave active results. This removes it from normal lists without deleting its history; archived=true can be used to read archived records. Confirm objectType and objectId before calling. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.";
6813
+ readonly http: "DELETE";
6814
+ readonly path: "/crm/v1/objects/{objectType}/{objectId}";
6815
+ readonly streaming: "no";
6816
+ readonly pagination: false;
6817
+ readonly pathParams: readonly [{
6818
+ readonly name: "objectType";
6819
+ readonly sdkName: "objectType";
6820
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6821
+ }, {
6822
+ readonly name: "objectId";
6823
+ readonly sdkName: "objectId";
6824
+ readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
6825
+ }];
6826
+ readonly query: readonly [];
6827
+ }, {
6828
+ readonly resource: "crm.objects";
6829
+ readonly method: "retrieve";
6830
+ readonly summary: "Retrieve record";
6831
+ readonly description: "Read one record by id from objects.list, objects.search or objects.create. Select property names with properties and associated object types with associations; use idProperty only when objectId is a value of that unique property. Use archived=true to inspect an archived record.";
6832
+ readonly http: "GET";
6833
+ readonly path: "/crm/v1/objects/{objectType}/{objectId}";
6834
+ readonly streaming: "no";
6835
+ readonly pagination: false;
6836
+ readonly pathParams: readonly [{
6837
+ readonly name: "objectType";
6838
+ readonly sdkName: "objectType";
6839
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6840
+ }, {
6841
+ readonly name: "objectId";
6842
+ readonly sdkName: "objectId";
6843
+ readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
6844
+ }];
6845
+ readonly query: readonly [{
6846
+ readonly name: "archived";
6847
+ readonly type: "boolean";
6848
+ readonly required: false;
6849
+ readonly description: "Whether to return only results that have been archived.";
6850
+ }, {
6851
+ readonly name: "associations";
6852
+ readonly type: "array";
6853
+ readonly itemType: "string";
6854
+ readonly required: false;
6855
+ readonly description: "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.";
6856
+ }, {
6857
+ readonly name: "idProperty";
6858
+ readonly type: "string";
6859
+ readonly required: false;
6860
+ readonly description: "The name of a property whose values are unique for this object";
6861
+ }, {
6862
+ readonly name: "properties";
6863
+ readonly type: "array";
6864
+ readonly itemType: "string";
6865
+ readonly required: false;
6866
+ readonly description: "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.";
6867
+ }, {
6868
+ readonly name: "propertiesWithHistory";
6869
+ readonly type: "array";
6870
+ readonly itemType: "string";
6871
+ readonly required: false;
6872
+ readonly description: "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.";
6873
+ }];
6874
+ }, {
6875
+ readonly resource: "crm.objects";
6876
+ readonly method: "update";
6877
+ readonly summary: "Update record";
6878
+ readonly description: "Change only the supplied properties of a record selected from objects.list or objects.search. Omitted properties retain their values. Use property names from properties.list and valid stage ids from pipelines.retrieve. Stage-entry requirements must be satisfied by the resulting record; inspect 400 errors before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
6879
+ readonly http: "PATCH";
6880
+ readonly path: "/crm/v1/objects/{objectType}/{objectId}";
6881
+ readonly streaming: "no";
6882
+ readonly pagination: false;
6883
+ readonly pathParams: readonly [{
6884
+ readonly name: "objectType";
6885
+ readonly sdkName: "objectType";
6886
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6887
+ }, {
6888
+ readonly name: "objectId";
6889
+ readonly sdkName: "objectId";
6890
+ readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
6891
+ }];
6892
+ readonly query: readonly [{
6893
+ readonly name: "idProperty";
6894
+ readonly type: "string";
6895
+ readonly required: false;
6896
+ readonly description: "The name of a property whose values are unique for this object";
6897
+ }];
6898
+ readonly body: {
6899
+ readonly required: true;
6900
+ readonly fields: readonly [{
6901
+ readonly name: "properties";
6902
+ readonly type: "object";
6903
+ readonly required: true;
6904
+ readonly description: "Key value pairs representing the properties of the object.";
6905
+ }];
6906
+ };
6907
+ }, {
6908
+ readonly resource: "crm.associations";
6909
+ readonly method: "createDefault";
6910
+ readonly summary: "Create default association";
6911
+ readonly description: "Link two existing records with the default unlabelled association. Obtain each record id from objects.list or objects.search for its type. No request body is required; use associations.create to choose explicit association labels. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
6912
+ readonly http: "PUT";
6913
+ readonly path: "/crm/v1/objects/{objectType}/{objectId}/associations/default/{toObjectType}/{toObjectId}";
6914
+ readonly streaming: "no";
6915
+ readonly pagination: false;
6916
+ readonly pathParams: readonly [{
6917
+ readonly name: "objectType";
6918
+ readonly sdkName: "objectType";
6919
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6920
+ }, {
6921
+ readonly name: "objectId";
6922
+ readonly sdkName: "objectId";
6923
+ readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
6924
+ }, {
6925
+ readonly name: "toObjectType";
6926
+ readonly sdkName: "toObjectType";
6927
+ readonly description: "Destination object type from schemas.list; use the type of the record being linked.";
6928
+ }, {
6929
+ readonly name: "toObjectId";
6930
+ readonly sdkName: "toObjectId";
6931
+ readonly description: "Destination record identifier from objects.list or objects.search for toObjectType.";
6932
+ }];
6933
+ readonly query: readonly [];
6934
+ }, {
6935
+ readonly resource: "crm.associations";
6936
+ readonly method: "list";
6937
+ readonly summary: "List record associations";
6938
+ readonly description: "Read records linked to a source record, including association labels and type ids. Obtain source and destination object types from schemas.list and objectId from objects.list or objects.search. Follow paging.next.after to continue reading associated records.";
6939
+ readonly http: "GET";
6940
+ readonly path: "/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}";
6941
+ readonly streaming: "no";
6942
+ readonly pagination: false;
6943
+ readonly pathParams: readonly [{
6944
+ readonly name: "objectType";
6945
+ readonly sdkName: "objectType";
6946
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6947
+ }, {
6948
+ readonly name: "objectId";
6949
+ readonly sdkName: "objectId";
6950
+ readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
6951
+ }, {
6952
+ readonly name: "toObjectType";
6953
+ readonly sdkName: "toObjectType";
6954
+ readonly description: "Destination object type from schemas.list; use the type of the record being linked.";
6955
+ }];
6956
+ readonly query: readonly [{
6957
+ readonly name: "after";
6958
+ readonly type: "string";
6959
+ readonly required: false;
6960
+ readonly description: "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.";
6961
+ }, {
6962
+ readonly name: "limit";
6963
+ readonly type: "integer";
6964
+ readonly required: false;
6965
+ readonly description: "The maximum number of results to display per page.";
6966
+ }];
6967
+ }, {
6968
+ readonly resource: "crm.associations";
6969
+ readonly method: "remove";
6970
+ readonly summary: "Remove association";
6971
+ readonly description: "Remove the association between two existing records without archiving either record. Obtain the linked destination id from associations.list and confirm the source and destination object types before calling. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.";
6972
+ readonly http: "DELETE";
6973
+ readonly path: "/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}";
6974
+ readonly streaming: "no";
6975
+ readonly pagination: false;
6976
+ readonly pathParams: readonly [{
6977
+ readonly name: "objectType";
6978
+ readonly sdkName: "objectType";
6979
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
6980
+ }, {
6981
+ readonly name: "objectId";
6982
+ readonly sdkName: "objectId";
6983
+ readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
6984
+ }, {
6985
+ readonly name: "toObjectType";
6986
+ readonly sdkName: "toObjectType";
6987
+ readonly description: "Destination object type from schemas.list; use the type of the record being linked.";
6988
+ }, {
6989
+ readonly name: "toObjectId";
6990
+ readonly sdkName: "toObjectId";
6991
+ readonly description: "Destination record identifier from objects.list or objects.search for toObjectType.";
6992
+ }];
6993
+ readonly query: readonly [];
6994
+ }, {
6995
+ readonly resource: "crm.associations";
6996
+ readonly method: "create";
6997
+ readonly summary: "Create labelled association";
6998
+ readonly description: "Associate two existing records using the requested association category and type id. Obtain record ids from objects.list or objects.search; reuse known association type ids from associations.list. Send the association-spec array as the body; use associations.createDefault when no label is needed. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
6999
+ readonly http: "PUT";
7000
+ readonly path: "/crm/v1/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}";
7001
+ readonly streaming: "no";
7002
+ readonly pagination: false;
7003
+ readonly pathParams: readonly [{
7004
+ readonly name: "objectType";
7005
+ readonly sdkName: "objectType";
7006
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7007
+ }, {
7008
+ readonly name: "objectId";
7009
+ readonly sdkName: "objectId";
7010
+ readonly description: "Record id from objects.list, objects.search or objects.create for this objectType.";
7011
+ }, {
7012
+ readonly name: "toObjectType";
7013
+ readonly sdkName: "toObjectType";
7014
+ readonly description: "Destination object type from schemas.list; use the type of the record being linked.";
7015
+ }, {
7016
+ readonly name: "toObjectId";
7017
+ readonly sdkName: "toObjectId";
7018
+ readonly description: "Destination record identifier from objects.list or objects.search for toObjectType.";
7019
+ }];
7020
+ readonly query: readonly [];
7021
+ readonly body: {
7022
+ readonly required: true;
7023
+ readonly fields: readonly [];
7024
+ };
7025
+ }, {
7026
+ readonly resource: "crm.pipelines";
7027
+ readonly method: "list";
7028
+ readonly summary: "List pipelines";
7029
+ readonly description: "Discover pipelines and stage ids for records of one object type from schemas.list. Reuse pipeline and stage ids in record property updates or lead qualification. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
7030
+ readonly http: "GET";
7031
+ readonly path: "/crm/v1/pipelines/{objectType}";
7032
+ readonly streaming: "no";
7033
+ readonly pagination: false;
7034
+ readonly pathParams: readonly [{
7035
+ readonly name: "objectType";
7036
+ readonly sdkName: "objectType";
7037
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7038
+ }];
7039
+ readonly query: readonly [];
7040
+ }, {
7041
+ readonly resource: "crm.pipelines";
7042
+ readonly method: "create";
7043
+ readonly summary: "Create pipeline";
7044
+ readonly description: "Create a pipeline with its ordered stages for an object type from schemas.list. Provide a display label, displayOrder and initial stages, then use the returned ids when assigning records. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
7045
+ readonly http: "POST";
7046
+ readonly path: "/crm/v1/pipelines/{objectType}";
7047
+ readonly streaming: "no";
7048
+ readonly pagination: false;
7049
+ readonly pathParams: readonly [{
7050
+ readonly name: "objectType";
7051
+ readonly sdkName: "objectType";
7052
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7053
+ }];
7054
+ readonly query: readonly [];
7055
+ readonly body: {
7056
+ readonly required: true;
7057
+ readonly fields: readonly [{
7058
+ readonly name: "displayOrder";
7059
+ readonly type: "integer";
7060
+ readonly required: true;
7061
+ readonly description: "An integer indicating the order in which the pipeline appears relative to other pipelines.";
7062
+ }, {
7063
+ readonly name: "label";
7064
+ readonly type: "string";
7065
+ readonly required: true;
7066
+ readonly description: "A string representing the name or title of the pipeline.";
7067
+ }, {
7068
+ readonly name: "pipelineId";
7069
+ readonly type: "string";
7070
+ readonly required: false;
7071
+ readonly description: "A string that uniquely identifies the pipeline. This property is optional when creating a new pipeline.";
7072
+ }, {
7073
+ readonly name: "stages";
7074
+ readonly type: "array";
7075
+ readonly itemType: "object";
7076
+ readonly required: true;
7077
+ readonly description: "An array of PipelineStageInput objects, each representing a stage within the pipeline.";
7078
+ }];
7079
+ };
7080
+ }, {
7081
+ readonly resource: "crm.pipelines";
7082
+ readonly method: "archive";
7083
+ readonly summary: "Archive pipeline";
7084
+ readonly description: "Archive a pipeline selected from pipelines.list when records no longer depend on it. Check current records and stage usage first; resolve references reported by validation before retrying. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
7085
+ readonly http: "DELETE";
7086
+ readonly path: "/crm/v1/pipelines/{objectType}/{pipelineId}";
7087
+ readonly streaming: "no";
7088
+ readonly pagination: false;
7089
+ readonly pathParams: readonly [{
7090
+ readonly name: "objectType";
7091
+ readonly sdkName: "objectType";
7092
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7093
+ }, {
7094
+ readonly name: "pipelineId";
7095
+ readonly sdkName: "pipelineId";
7096
+ readonly description: "Pipeline identifier from pipelines.list for this objectType.";
7097
+ }];
7098
+ readonly query: readonly [{
7099
+ readonly name: "validateDealStageUsagesBeforeDelete";
7100
+ readonly type: "boolean";
7101
+ readonly required: false;
7102
+ readonly description: "A boolean indicating whether to validate deal stage usages before deleting the pipeline. Defaults to true.";
7103
+ }, {
7104
+ readonly name: "validateReferencesBeforeDelete";
7105
+ readonly type: "boolean";
7106
+ readonly required: false;
7107
+ readonly description: "A boolean indicating whether to validate references before deleting the pipeline. Defaults to true.";
7108
+ }];
7109
+ }, {
7110
+ readonly resource: "crm.pipelines";
7111
+ readonly method: "retrieve";
7112
+ readonly summary: "Retrieve pipeline";
7113
+ readonly description: "Inspect the stage ids and metadata of a pipeline before moving a record or editing its workflow. Obtain pipelineId from pipelines.list and use the returned stages array to select a destination. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
7114
+ readonly http: "GET";
7115
+ readonly path: "/crm/v1/pipelines/{objectType}/{pipelineId}";
7116
+ readonly streaming: "no";
7117
+ readonly pagination: false;
7118
+ readonly pathParams: readonly [{
7119
+ readonly name: "objectType";
7120
+ readonly sdkName: "objectType";
7121
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7122
+ }, {
7123
+ readonly name: "pipelineId";
7124
+ readonly sdkName: "pipelineId";
7125
+ readonly description: "Pipeline identifier from pipelines.list for this objectType.";
7126
+ }];
7127
+ readonly query: readonly [];
7128
+ }, {
7129
+ readonly resource: "crm.pipelines";
7130
+ readonly method: "update";
7131
+ readonly summary: "Update pipeline";
7132
+ readonly description: "Change editable pipeline settings selected by pipelineId from pipelines.list. Omit settings that should remain unchanged and inspect current stages with pipelines.retrieve before modifying the workflow. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
7133
+ readonly http: "PATCH";
7134
+ readonly path: "/crm/v1/pipelines/{objectType}/{pipelineId}";
7135
+ readonly streaming: "no";
7136
+ readonly pagination: false;
7137
+ readonly pathParams: readonly [{
7138
+ readonly name: "objectType";
7139
+ readonly sdkName: "objectType";
7140
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7141
+ }, {
7142
+ readonly name: "pipelineId";
7143
+ readonly sdkName: "pipelineId";
7144
+ readonly description: "Pipeline identifier from pipelines.list for this objectType.";
7145
+ }];
7146
+ readonly query: readonly [{
7147
+ readonly name: "validateDealStageUsagesBeforeDelete";
7148
+ readonly type: "boolean";
7149
+ readonly required: false;
7150
+ readonly description: "A boolean indicating whether to validate deal stage usages before deleting. Defaults to true.";
7151
+ }, {
7152
+ readonly name: "validateReferencesBeforeDelete";
7153
+ readonly type: "boolean";
7154
+ readonly required: false;
7155
+ readonly description: "A boolean indicating whether to validate references before deleting. Defaults to true.";
7156
+ }];
7157
+ readonly body: {
7158
+ readonly required: true;
7159
+ readonly fields: readonly [{
7160
+ readonly name: "archived";
7161
+ readonly type: "boolean";
7162
+ readonly required: false;
7163
+ readonly description: "A boolean value that indicates whether the pipeline is archived.";
7164
+ }, {
7165
+ readonly name: "displayOrder";
7166
+ readonly type: "integer";
7167
+ readonly required: false;
7168
+ readonly description: "An integer indicating the position of the pipeline in a list, which determines its display order.";
7169
+ }, {
7170
+ readonly name: "label";
7171
+ readonly type: "string";
7172
+ readonly required: false;
7173
+ readonly description: "The name of the pipeline, represented as a string.";
7174
+ }];
7175
+ };
7176
+ }, {
7177
+ readonly resource: "crm.pipelines.stages";
7178
+ readonly method: "create";
7179
+ readonly summary: "Create pipeline stage";
7180
+ readonly description: "Add an ordered stage to a pipeline from pipelines.list. Provide its display label, displayOrder and metadata; save the returned stage id for record updates. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
7181
+ readonly http: "POST";
7182
+ readonly path: "/crm/v1/pipelines/{objectType}/{pipelineId}/stages";
7183
+ readonly streaming: "no";
7184
+ readonly pagination: false;
7185
+ readonly pathParams: readonly [{
7186
+ readonly name: "objectType";
7187
+ readonly sdkName: "objectType";
7188
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7189
+ }, {
7190
+ readonly name: "pipelineId";
7191
+ readonly sdkName: "pipelineId";
7192
+ readonly description: "Pipeline identifier from pipelines.list for this objectType.";
7193
+ }];
7194
+ readonly query: readonly [];
7195
+ readonly body: {
7196
+ readonly required: true;
7197
+ readonly fields: readonly [{
7198
+ readonly name: "displayOrder";
7199
+ readonly type: "integer";
7200
+ readonly required: true;
7201
+ readonly description: "An integer indicating the position of this stage within the pipeline. Lower numbers indicate earlier stages.";
7202
+ }, {
7203
+ readonly name: "label";
7204
+ readonly type: "string";
7205
+ readonly required: true;
7206
+ readonly description: "The name of the pipeline stage. It is a string that provides a human-readable identifier for the stage.";
7207
+ }, {
7208
+ readonly name: "metadata";
7209
+ readonly type: "object";
7210
+ readonly required: true;
7211
+ readonly description: "String-valued stage settings, including transition and entry requirements. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying.";
7212
+ }, {
7213
+ readonly name: "stageId";
7214
+ readonly type: "string";
7215
+ readonly required: false;
7216
+ readonly description: "A string that uniquely identifies the stage within the pipeline.";
7217
+ }];
7218
+ };
7219
+ }, {
7220
+ readonly resource: "crm.pipelines.stages";
7221
+ readonly method: "archive";
7222
+ readonly summary: "Archive pipeline stage";
7223
+ readonly description: "Archive a stage selected from pipelines.retrieve after checking record usage. A stage that still has records cannot be archived without resolving their assignment; move those records to an allowed stage first. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
7224
+ readonly http: "DELETE";
7225
+ readonly path: "/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}";
7226
+ readonly streaming: "no";
7227
+ readonly pagination: false;
7228
+ readonly pathParams: readonly [{
7229
+ readonly name: "objectType";
7230
+ readonly sdkName: "objectType";
7231
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7232
+ }, {
7233
+ readonly name: "pipelineId";
7234
+ readonly sdkName: "pipelineId";
7235
+ readonly description: "Pipeline identifier from pipelines.list for this objectType.";
7236
+ }, {
7237
+ readonly name: "stageId";
7238
+ readonly sdkName: "stageId";
7239
+ readonly description: "Stage identifier from the stages array returned by pipelines.retrieve for this pipeline.";
7240
+ }];
7241
+ readonly query: readonly [{
7242
+ readonly name: "validateReferencesBeforeDelete";
7243
+ readonly type: "boolean";
7244
+ readonly required: false;
7245
+ readonly description: "A boolean flag indicating whether to validate references before deleting the stage. Defaults to true.";
7246
+ }];
7247
+ }, {
7248
+ readonly resource: "crm.pipelines.stages";
7249
+ readonly method: "update";
7250
+ readonly summary: "Update pipeline stage";
7251
+ readonly description: "Change the label, order or metadata of a stage selected from pipelines.retrieve. Existing records must satisfy entry rules when subsequently moved; omitted settings retain their values. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Example metadata: {\"praxis_category\":\"open\",\"praxis_terminal\":\"false\",\"praxis_allowed_next\":\"[\\\"proposal\\\",\\\"lost\\\"]\",\"praxis_required\":\"[\\\"budget\\\",\\\"decision_maker\\\"]\"}.";
7252
+ readonly http: "PATCH";
7253
+ readonly path: "/crm/v1/pipelines/{objectType}/{pipelineId}/stages/{stageId}";
7254
+ readonly streaming: "no";
7255
+ readonly pagination: false;
7256
+ readonly pathParams: readonly [{
7257
+ readonly name: "objectType";
7258
+ readonly sdkName: "objectType";
7259
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7260
+ }, {
7261
+ readonly name: "pipelineId";
7262
+ readonly sdkName: "pipelineId";
7263
+ readonly description: "Pipeline identifier from pipelines.list for this objectType.";
7264
+ }, {
7265
+ readonly name: "stageId";
7266
+ readonly sdkName: "stageId";
7267
+ readonly description: "Stage identifier from the stages array returned by pipelines.retrieve for this pipeline.";
7268
+ }];
7269
+ readonly query: readonly [];
7270
+ readonly body: {
7271
+ readonly required: true;
7272
+ readonly fields: readonly [{
7273
+ readonly name: "archived";
7274
+ readonly type: "boolean";
7275
+ readonly required: false;
7276
+ readonly description: "A boolean indicating whether the pipeline stage is archived.";
7277
+ }, {
7278
+ readonly name: "displayOrder";
7279
+ readonly type: "integer";
7280
+ readonly required: false;
7281
+ readonly description: "An integer specifying the order in which the stage appears relative to other stages.";
7282
+ }, {
7283
+ readonly name: "label";
7284
+ readonly type: "string";
7285
+ readonly required: false;
7286
+ readonly description: "A string representing the name or title of the pipeline stage.";
7287
+ }, {
7288
+ readonly name: "metadata";
7289
+ readonly type: "object";
7290
+ readonly required: true;
7291
+ readonly description: "String-valued stage settings, including transition and entry requirements. Stage rules are string values in stage.metadata: praxis_category is open (active), won (successful) or lost (unsuccessful); praxis_terminal is \"true\" (no further transition) or \"false\" (transitions allowed); praxis_allowed_next is a JSON-encoded array string of permitted next stage ids, with the string \"null\" meaning unrestricted; praxis_required is a JSON-encoded array string of property names (\"[]\" means none) that must be non-empty on entry (boolean properties must be \"true\"). Rule violations return HTTP 400 VALIDATION_ERROR; errors[0].context.properties lists missing required property names. Correct those values or choose an allowed stage before retrying.";
7292
+ }];
7293
+ };
7294
+ }, {
7295
+ readonly resource: "crm.properties";
7296
+ readonly method: "list";
7297
+ readonly summary: "List properties";
7298
+ readonly description: "Inspect the property definitions available for an object type before writing or filtering records. Obtain objectType from schemas.list; reuse each immutable name in record properties and filters. archived defaults to false.";
7299
+ readonly http: "GET";
7300
+ readonly path: "/crm/v1/properties/{objectType}";
7301
+ readonly streaming: "no";
7302
+ readonly pagination: false;
7303
+ readonly pathParams: readonly [{
7304
+ readonly name: "objectType";
7305
+ readonly sdkName: "objectType";
7306
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7307
+ }];
7308
+ readonly query: readonly [{
7309
+ readonly name: "archived";
7310
+ readonly type: "boolean";
7311
+ readonly required: false;
7312
+ readonly description: "Whether to return only results that have been archived.";
7313
+ }, {
7314
+ readonly name: "dataSensitivity";
7315
+ readonly type: "string";
7316
+ readonly enum: readonly ["highly_sensitive", "non_sensitive", "sensitive"];
7317
+ readonly required: false;
7318
+ readonly description: "Filter properties based on data sensitivity level. Valid values are 'non_sensitive', 'sensitive', and 'highly_sensitive'. Defaults to 'non_sensitive'.";
7319
+ }, {
7320
+ readonly name: "locale";
7321
+ readonly type: "string";
7322
+ readonly required: false;
7323
+ readonly description: "Specify the locale to retrieve properties in a particular language or regional format.";
7324
+ }, {
7325
+ readonly name: "properties";
7326
+ readonly type: "string";
7327
+ readonly required: false;
7328
+ readonly description: "A comma-separated list of property names to include in the response.";
7329
+ }];
7330
+ }, {
7331
+ readonly resource: "crm.properties";
7332
+ readonly method: "create";
7333
+ readonly summary: "Create property";
7334
+ readonly description: "Define a property before setting its values on records. Choose objectType from schemas.list and groupName from properties.groups.list; provide an immutable internal name, display label, type and fieldType. Enumeration properties require their valid options. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
7335
+ readonly http: "POST";
7336
+ readonly path: "/crm/v1/properties/{objectType}";
7337
+ readonly streaming: "no";
7338
+ readonly pagination: false;
7339
+ readonly pathParams: readonly [{
7340
+ readonly name: "objectType";
7341
+ readonly sdkName: "objectType";
7342
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7343
+ }];
7344
+ readonly query: readonly [];
7345
+ readonly body: {
7346
+ readonly required: true;
7347
+ readonly fields: readonly [{
7348
+ readonly name: "calculationFormula";
7349
+ readonly type: "string";
7350
+ readonly required: false;
7351
+ readonly description: "Represents a formula that is used to compute a calculated property.";
7352
+ }, {
7353
+ readonly name: "currencyPropertyName";
7354
+ readonly type: "string";
7355
+ readonly required: false;
7356
+ readonly description: "A string representing the name of the currency property.";
7357
+ }, {
7358
+ readonly name: "dataSensitivity";
7359
+ readonly type: "string";
7360
+ readonly enum: readonly ["highly_sensitive", "non_sensitive", "sensitive"];
7361
+ readonly required: false;
7362
+ readonly description: "Indicates the sensitivity level of the property, with options: highly_sensitive, non_sensitive, or sensitive.";
7363
+ }, {
7364
+ readonly name: "description";
7365
+ readonly type: "string";
7366
+ readonly required: false;
7367
+ readonly description: "A description of the property that will be shown as help text in CRM.";
7368
+ }, {
7369
+ readonly name: "displayOrder";
7370
+ readonly type: "integer";
7371
+ readonly required: false;
7372
+ readonly description: "Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property to be displayed after any positive values.";
7373
+ }, {
7374
+ readonly name: "externalOptions";
7375
+ readonly type: "boolean";
7376
+ readonly required: false;
7377
+ readonly description: "Applicable only for 'enumeration' type properties. Should be set to true in conjunction with a 'referencedObjectType' of 'OWNER'. Otherwise false.";
7378
+ }, {
7379
+ readonly name: "fieldType";
7380
+ readonly type: "string";
7381
+ readonly enum: readonly ["booleancheckbox", "calculation_equation", "checkbox", "date", "file", "html", "number", "phonenumber", "radio", "select", "text", "textarea"];
7382
+ readonly required: true;
7383
+ readonly description: "Controls how the property appears in CRM.";
7384
+ }, {
7385
+ readonly name: "formField";
7386
+ readonly type: "boolean";
7387
+ readonly required: false;
7388
+ readonly description: "Whether or not the property can be used in a CRM form.";
7389
+ }, {
7390
+ readonly name: "groupName";
7391
+ readonly type: "string";
7392
+ readonly required: true;
7393
+ readonly description: "The name of the property group the property belongs to.";
7394
+ }, {
7395
+ readonly name: "hasUniqueValue";
7396
+ readonly type: "boolean";
7397
+ readonly required: false;
7398
+ readonly description: "Whether or not the property's value must be unique. Once set, this can't be changed.";
7399
+ }, {
7400
+ readonly name: "hidden";
7401
+ readonly type: "boolean";
7402
+ readonly required: false;
7403
+ readonly description: "If true, the property won't be visible and can't be used in CRM.";
7404
+ }, {
7405
+ readonly name: "label";
7406
+ readonly type: "string";
7407
+ readonly required: true;
7408
+ readonly description: "A human-readable property label that will be shown in CRM.";
7409
+ }, {
7410
+ readonly name: "name";
7411
+ readonly type: "string";
7412
+ readonly required: true;
7413
+ readonly description: "The internal property name, which must be used when referencing the property via the API.";
7414
+ }, {
7415
+ readonly name: "numberDisplayHint";
7416
+ readonly type: "string";
7417
+ readonly enum: readonly ["currency", "duration", "formatted", "percentage", "probability", "unformatted"];
7418
+ readonly required: false;
7419
+ readonly description: "A string providing a hint on how to display numbers. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', 'probability'.";
7420
+ }, {
7421
+ readonly name: "options";
7422
+ readonly type: "array";
7423
+ readonly itemType: "object";
7424
+ readonly required: false;
7425
+ readonly description: "A list of valid options for the property. This field is required for enumerated properties.";
7426
+ }, {
7427
+ readonly name: "referencedObjectType";
7428
+ readonly type: "string";
7429
+ readonly required: false;
7430
+ readonly description: "Should be set to 'OWNER' when 'externalOptions' is true, which causes the property to dynamically pull option values from the current CRM users.";
7431
+ }, {
7432
+ readonly name: "showCurrencySymbol";
7433
+ readonly type: "boolean";
7434
+ readonly required: false;
7435
+ readonly description: "A boolean indicating whether to show the currency symbol for currency fields.";
7436
+ }, {
7437
+ readonly name: "textDisplayHint";
7438
+ readonly type: "string";
7439
+ readonly enum: readonly ["domain_name", "email", "ip_address", "multi_line", "phone_number", "physical_address", "postal_code", "unformatted_single_line"];
7440
+ readonly required: false;
7441
+ readonly description: "A string providing a hint on how to display text. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', 'postal_code'.";
7442
+ }, {
7443
+ readonly name: "type";
7444
+ readonly type: "string";
7445
+ readonly enum: readonly ["bool", "date", "datetime", "enumeration", "number", "phone_number", "string"];
7446
+ readonly required: true;
7447
+ readonly description: "The data type of the property.";
7448
+ }];
7449
+ };
7450
+ }, {
7451
+ readonly resource: "crm.properties.groups";
7452
+ readonly method: "list";
7453
+ readonly summary: "List property groups";
7454
+ readonly description: "Discover property groups for an object type before creating or organizing property definitions. Obtain objectType from schemas.list and reuse a group name as groupName in properties.create or properties.update.";
7455
+ readonly http: "GET";
7456
+ readonly path: "/crm/v1/properties/{objectType}/groups";
7457
+ readonly streaming: "no";
7458
+ readonly pagination: false;
7459
+ readonly pathParams: readonly [{
7460
+ readonly name: "objectType";
7461
+ readonly sdkName: "objectType";
7462
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7463
+ }];
7464
+ readonly query: readonly [{
7465
+ readonly name: "locale";
7466
+ readonly type: "string";
7467
+ readonly required: false;
7468
+ readonly description: "The language locale to use for property group labels. This can help in displaying labels in the preferred language.";
7469
+ }];
7470
+ }, {
7471
+ readonly resource: "crm.properties.groups";
7472
+ readonly method: "create";
7473
+ readonly summary: "Create property group";
7474
+ readonly description: "Create a named group for related property definitions of one object type. Obtain objectType from schemas.list; choose a unique internal name and display label, then reuse the returned name as groupName when creating properties. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
7475
+ readonly http: "POST";
7476
+ readonly path: "/crm/v1/properties/{objectType}/groups";
7477
+ readonly streaming: "no";
7478
+ readonly pagination: false;
7479
+ readonly pathParams: readonly [{
7480
+ readonly name: "objectType";
7481
+ readonly sdkName: "objectType";
7482
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7483
+ }];
7484
+ readonly query: readonly [];
7485
+ readonly body: {
7486
+ readonly required: true;
7487
+ readonly fields: readonly [{
7488
+ readonly name: "displayOrder";
7489
+ readonly type: "integer";
7490
+ readonly required: false;
7491
+ readonly description: "Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.";
7492
+ }, {
7493
+ readonly name: "label";
7494
+ readonly type: "string";
7495
+ readonly required: true;
7496
+ readonly description: "A human-readable label that will be shown in CRM.";
7497
+ }, {
7498
+ readonly name: "name";
7499
+ readonly type: "string";
7500
+ readonly required: true;
7501
+ readonly description: "The internal property group name, which must be used when referencing the property group via the API.";
7502
+ }];
7503
+ };
7504
+ }, {
7505
+ readonly resource: "crm.properties";
7506
+ readonly method: "archive";
7507
+ readonly summary: "Archive property";
7508
+ readonly description: "Archive a property definition selected by internal name from properties.list. Confirm that record entry and search flows no longer depend on it; archived definitions are excluded from normal property lists. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations. Unlike HubSpot, this own-face archive returns HTTP 200 with a JSON refs body instead of HTTP 204.";
7509
+ readonly http: "DELETE";
7510
+ readonly path: "/crm/v1/properties/{objectType}/{propertyName}";
7511
+ readonly streaming: "no";
7512
+ readonly pagination: false;
7513
+ readonly pathParams: readonly [{
7514
+ readonly name: "objectType";
7515
+ readonly sdkName: "objectType";
7516
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7517
+ }, {
7518
+ readonly name: "propertyName";
7519
+ readonly sdkName: "propertyName";
7520
+ readonly description: "Immutable internal property name from properties.list; do not pass the display label.";
7521
+ }];
7522
+ readonly query: readonly [];
7523
+ }, {
7524
+ readonly resource: "crm.properties";
7525
+ readonly method: "retrieve";
7526
+ readonly summary: "Retrieve property";
7527
+ readonly description: "Inspect the type, options and modification restrictions of a property before changing its definition or record values. Obtain propertyName from properties.list; it is the immutable internal name rather than the label.";
7528
+ readonly http: "GET";
7529
+ readonly path: "/crm/v1/properties/{objectType}/{propertyName}";
7530
+ readonly streaming: "no";
7531
+ readonly pagination: false;
7532
+ readonly pathParams: readonly [{
7533
+ readonly name: "objectType";
7534
+ readonly sdkName: "objectType";
7535
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7536
+ }, {
7537
+ readonly name: "propertyName";
7538
+ readonly sdkName: "propertyName";
7539
+ readonly description: "Immutable internal property name from properties.list; do not pass the display label.";
7540
+ }];
7541
+ readonly query: readonly [{
7542
+ readonly name: "archived";
7543
+ readonly type: "boolean";
7544
+ readonly required: false;
7545
+ readonly description: "Whether to return only results that have been archived.";
7546
+ }, {
7547
+ readonly name: "dataSensitivity";
7548
+ readonly type: "string";
7549
+ readonly enum: readonly ["highly_sensitive", "non_sensitive", "sensitive"];
7550
+ readonly required: false;
7551
+ readonly description: "The level of data sensitivity to filter properties by. Valid values are 'non_sensitive', 'sensitive', and 'highly_sensitive'. Defaults to 'non_sensitive'.";
7552
+ }, {
7553
+ readonly name: "locale";
7554
+ readonly type: "string";
7555
+ readonly required: false;
7556
+ readonly description: "The locale to use for property labels and descriptions.";
7557
+ }, {
7558
+ readonly name: "properties";
7559
+ readonly type: "string";
7560
+ readonly required: false;
7561
+ readonly description: "A comma-separated list of property names to include in the response.";
7562
+ }];
7563
+ }, {
7564
+ readonly resource: "crm.properties";
7565
+ readonly method: "update";
7566
+ readonly summary: "Update property";
7567
+ readonly description: "Change editable settings of a property selected from properties.list, such as its label, group or options. Preserve the immutable internal name; inspect modificationMetadata before editing system-managed definitions. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
7568
+ readonly http: "PATCH";
7569
+ readonly path: "/crm/v1/properties/{objectType}/{propertyName}";
7570
+ readonly streaming: "no";
7571
+ readonly pagination: false;
7572
+ readonly pathParams: readonly [{
7573
+ readonly name: "objectType";
7574
+ readonly sdkName: "objectType";
7575
+ readonly description: "Object type name from schemas.list, such as contacts, companies, deals or a custom p_<name>.";
7576
+ }, {
7577
+ readonly name: "propertyName";
7578
+ readonly sdkName: "propertyName";
7579
+ readonly description: "Immutable internal property name from properties.list; do not pass the display label.";
7580
+ }];
7581
+ readonly query: readonly [];
7582
+ readonly body: {
7583
+ readonly required: true;
7584
+ readonly fields: readonly [{
7585
+ readonly name: "calculationFormula";
7586
+ readonly type: "string";
7587
+ readonly required: false;
7588
+ readonly description: "Represents a formula that is used to compute a calculated property.";
7589
+ }, {
7590
+ readonly name: "currencyPropertyName";
7591
+ readonly type: "string";
7592
+ readonly required: false;
7593
+ readonly description: "A string specifying the name of the property that holds the currency information, applicable when showCurrencySymbol is true.";
7594
+ }, {
7595
+ readonly name: "description";
7596
+ readonly type: "string";
7597
+ readonly required: false;
7598
+ readonly description: "A description of the property that will be shown as help text in CRM.";
7599
+ }, {
7600
+ readonly name: "displayOrder";
7601
+ readonly type: "integer";
7602
+ readonly required: false;
7603
+ readonly description: "Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the Property to be displayed after any positive values.";
7604
+ }, {
7605
+ readonly name: "fieldType";
7606
+ readonly type: "string";
7607
+ readonly enum: readonly ["booleancheckbox", "calculation_equation", "checkbox", "date", "file", "html", "number", "phonenumber", "radio", "select", "text", "textarea"];
7608
+ readonly required: false;
7609
+ readonly description: "Controls how the property appears in CRM.";
7610
+ }, {
7611
+ readonly name: "formField";
7612
+ readonly type: "boolean";
7613
+ readonly required: false;
7614
+ readonly description: "Whether or not the property can be used in a CRM form.";
7615
+ }, {
7616
+ readonly name: "groupName";
7617
+ readonly type: "string";
7618
+ readonly required: false;
7619
+ readonly description: "The name of the property group the property belongs to.";
7620
+ }, {
7621
+ readonly name: "hidden";
7622
+ readonly type: "boolean";
7623
+ readonly required: false;
7624
+ readonly description: "If true, the property won't be visible and can't be used in CRM.";
7625
+ }, {
7626
+ readonly name: "label";
7627
+ readonly type: "string";
7628
+ readonly required: false;
7629
+ readonly description: "A human-readable property label that will be shown in CRM.";
7630
+ }, {
7631
+ readonly name: "numberDisplayHint";
7632
+ readonly type: "string";
7633
+ readonly enum: readonly ["currency", "duration", "formatted", "percentage", "probability", "unformatted"];
7634
+ readonly required: false;
7635
+ readonly description: "A string providing a hint for displaying number values. Valid values include 'unformatted', 'formatted', 'currency', 'percentage', 'duration', and 'probability'.";
7636
+ }, {
7637
+ readonly name: "options";
7638
+ readonly type: "array";
7639
+ readonly itemType: "object";
7640
+ readonly required: false;
7641
+ readonly description: "A list of valid options for the property.";
7642
+ }, {
7643
+ readonly name: "showCurrencySymbol";
7644
+ readonly type: "boolean";
7645
+ readonly required: false;
7646
+ readonly description: "A boolean indicating whether to display a currency symbol for number fields formatted as currency.";
7647
+ }, {
7648
+ readonly name: "textDisplayHint";
7649
+ readonly type: "string";
7650
+ readonly enum: readonly ["domain_name", "email", "ip_address", "multi_line", "phone_number", "physical_address", "postal_code", "unformatted_single_line"];
7651
+ readonly required: false;
7652
+ readonly description: "A string providing a hint for displaying text values. Valid values include 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', and 'postal_code'.";
7653
+ }, {
7654
+ readonly name: "type";
7655
+ readonly type: "string";
7656
+ readonly enum: readonly ["bool", "date", "datetime", "enumeration", "number", "phone_number", "string"];
7657
+ readonly required: false;
7658
+ readonly description: "The data type of the property.";
7659
+ }];
7660
+ };
7661
+ }, {
7662
+ readonly resource: "crm.schemas";
7663
+ readonly method: "list";
7664
+ readonly summary: "List object schemas";
7665
+ readonly description: "Discover available object schemas, display labels, property definitions and association definitions. Reuse the object type identifier or name in record, property and pipeline operations. archived defaults to false; the include parameters control the definition and audit details returned.";
7666
+ readonly http: "GET";
7667
+ readonly path: "/crm/v1/schemas";
7668
+ readonly streaming: "no";
7669
+ readonly pagination: false;
7670
+ readonly pathParams: readonly [];
7671
+ readonly query: readonly [{
7672
+ readonly name: "archived";
7673
+ readonly type: "boolean";
7674
+ readonly required: false;
7675
+ readonly description: "Whether to return only results that have been archived.";
7676
+ }, {
7677
+ readonly name: "includeAssociationDefinitions";
7678
+ readonly type: "boolean";
7679
+ readonly required: false;
7680
+ readonly description: "Whether to include association definitions in the response. Defaults to true.";
7681
+ }, {
7682
+ readonly name: "includeAuditMetadata";
7683
+ readonly type: "boolean";
7684
+ readonly required: false;
7685
+ readonly description: "Whether to include audit metadata in the response. Defaults to true.";
7686
+ }, {
7687
+ readonly name: "includePropertyDefinitions";
7688
+ readonly type: "boolean";
7689
+ readonly required: false;
7690
+ readonly description: "Whether to include property definitions in the response. Defaults to true.";
7691
+ }];
7692
+ }, {
7693
+ readonly resource: "crm.schemas";
7694
+ readonly method: "create";
7695
+ readonly summary: "Create object schema";
7696
+ readonly description: "Define a custom CRM object type before creating its records. Provide its immutable name, singular and plural labels, primaryDisplayProperty, properties and associated object types. Save the returned object type identifier for subsequent record and property operations. Writes return refs (ResourceRef[]) for entity cards and optional property changes in conversations.";
7697
+ readonly http: "POST";
7698
+ readonly path: "/crm/v1/schemas";
7699
+ readonly streaming: "no";
7700
+ readonly pagination: false;
7701
+ readonly pathParams: readonly [];
7702
+ readonly query: readonly [];
7703
+ readonly body: {
7704
+ readonly required: true;
7705
+ readonly fields: readonly [{
7706
+ readonly name: "allowsSensitiveProperties";
7707
+ readonly type: "boolean";
7708
+ readonly required: true;
7709
+ readonly description: "Determines if the object type can include properties that are marked as sensitive.";
7710
+ }, {
7711
+ readonly name: "associatedObjects";
7712
+ readonly type: "array";
7713
+ readonly itemType: "string";
7714
+ readonly required: true;
7715
+ readonly description: "Associations defined for this object type.";
7716
+ }, {
7717
+ readonly name: "description";
7718
+ readonly type: "string";
7719
+ readonly required: false;
7720
+ readonly description: "A brief explanation of the object type.";
7721
+ }, {
7722
+ readonly name: "labels";
7723
+ readonly type: "object";
7724
+ readonly required: true;
7725
+ }, {
7726
+ readonly name: "name";
7727
+ readonly type: "string";
7728
+ readonly required: true;
7729
+ readonly description: "A unique name for this object. For internal use only.";
7730
+ }, {
7731
+ readonly name: "primaryDisplayProperty";
7732
+ readonly type: "string";
7733
+ readonly required: false;
7734
+ readonly description: "The name of the primary property for this object. This will be displayed as primary on the CRM record page for this object type.";
7735
+ }, {
7736
+ readonly name: "properties";
7737
+ readonly type: "array";
7738
+ readonly itemType: "object";
7739
+ readonly required: true;
7740
+ readonly description: "Properties defined for this object type.";
7741
+ }, {
7742
+ readonly name: "requiredProperties";
7743
+ readonly type: "array";
7744
+ readonly itemType: "string";
7745
+ readonly required: true;
7746
+ readonly description: "The names of properties that should be **required** when creating an object of this type.";
7747
+ }, {
7748
+ readonly name: "searchableProperties";
7749
+ readonly type: "array";
7750
+ readonly itemType: "string";
7751
+ readonly required: true;
7752
+ readonly description: "Names of properties that will be indexed for this object type in by CRM's product search.";
7753
+ }, {
7754
+ readonly name: "secondaryDisplayProperties";
7755
+ readonly type: "array";
7756
+ readonly itemType: "string";
7757
+ readonly required: true;
7758
+ readonly description: "The names of secondary properties for this object. These will be displayed as secondary on the CRM record page for this object type.";
7759
+ }, {
7760
+ readonly name: "shouldCreateSameObjectAssociation";
7761
+ readonly type: "boolean";
7762
+ readonly required: true;
7763
+ readonly description: "A boolean indicating whether associations should be created between objects of the same type.";
7764
+ }];
7765
+ };
6420
7766
  }, {
6421
7767
  readonly resource: "cut.exports";
6422
7768
  readonly method: "retrieve";
@@ -6589,7 +7935,7 @@ export declare const operations: readonly [{
6589
7935
  readonly resource: "cut.projects.analysis";
6590
7936
  readonly method: "create";
6591
7937
  readonly summary: "Analyze project media";
6592
- readonly description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible.";
7938
+ readonly description: "Request silence, filler-word or scene analysis for selected bound assets before editing. Omit media to select project sources; ranges returned in segments use source seconds. A pending result is not completion: use retry_after_sec before checking again, and inspect failed or unsupported asset results before deciding which edits are possible. Silence measures transcript-based speech pauses, not music or loudness. A completed transcript without words returns ready with empty segments and reason no_speech; no completed transcript returns unsupported with reason no_transcript. A failed transcription remains failed.";
6593
7939
  readonly http: "POST";
6594
7940
  readonly path: "/cut/v1/projects/{project_id}/analysis";
6595
7941
  readonly streaming: "no";
@@ -6728,6 +8074,16 @@ export declare const operations: readonly [{
6728
8074
  readonly body: {
6729
8075
  readonly required: true;
6730
8076
  readonly fields: readonly [{
8077
+ readonly name: "folder";
8078
+ readonly type: "string";
8079
+ readonly required: false;
8080
+ readonly description: "Optional destination path within the bound media library; omitted uses its default folder.";
8081
+ }, {
8082
+ readonly name: "name";
8083
+ readonly type: "string";
8084
+ readonly required: false;
8085
+ readonly description: "Nonempty display name, frozen with the export. Path separators and control characters become hyphens; limited to 200 characters. Omitted uses project name and timestamp.";
8086
+ }, {
6731
8087
  readonly name: "output";
6732
8088
  readonly type: "object";
6733
8089
  readonly required: false;
@@ -6748,7 +8104,7 @@ export declare const operations: readonly [{
6748
8104
  readonly resource: "cut.projects.frames";
6749
8105
  readonly method: "list";
6750
8106
  readonly summary: "Render preview frames";
6751
- readonly description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Fetch the returned image URLs before expires_at; render again when they expire.";
8107
+ readonly description: "Review the visual result at one or more project times without creating an export. Pass comma-separated seconds in at, such as 12,15.5; scale changes preview size and revision selects a committed project revision. Request at most eight times. Each returned url is an inline PNG data URL (data:image/png;base64,...), not a hosted HTTP image link. The default scale is 0.25; use 0.5 for subtitle layout inspection (1080×1920 renders at 540×960). The maximum is 0.5; values above it return INVALID_PARAMS. Actual width and height are returned per frame. PNGs above 2 MiB or responses above 4 MiB return RESPONSE_TOO_LARGE without silently lowering resolution. The response always includes warnings; FRAME_UNAVAILABLE means a source preview could not be obtained and an offline tile was drawn. Its message identifies a timeout, delivery capacity limit, or unavailable source and contains no source URL. Decode each image's base64 payload to save it. Codemode returns at most four images per call, so request at most four times when reviewing there.";
6752
8108
  readonly http: "GET";
6753
8109
  readonly path: "/cut/v1/projects/{project_id}/frames";
6754
8110
  readonly streaming: "no";
@@ -6767,7 +8123,7 @@ export declare const operations: readonly [{
6767
8123
  readonly name: "scale";
6768
8124
  readonly type: "number";
6769
8125
  readonly required: false;
6770
- readonly description: "Positive image size multiplier; 0.5 renders at half the project dimensions.";
8126
+ readonly description: "Image size multiplier, default 0.25, greater than zero and at most 0.5. Larger values return INVALID_PARAMS; pixel-area limits may reduce actual dimensions, reported as width and height.";
6771
8127
  }, {
6772
8128
  readonly name: "revision";
6773
8129
  readonly type: "integer";
@@ -6922,7 +8278,7 @@ export declare const operations: readonly [{
6922
8278
  readonly resource: "cut.projects";
6923
8279
  readonly method: "execute";
6924
8280
  readonly summary: "Execute editing script";
6925
- readonly description: "Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Use AddTrack, Insert, Update, Delete, Split, Trim, Move, RippleDeleteRange, UpdateTrack, DeleteTrack, SetSettings, AddCaptionsFromTranscript and SetMarker for writes; GetTimeline, GetItem, FindItems, GetMedia, GetTranscript and GetAnalysis read editing context; Print emits text and Preview requests frame previews. All script times are seconds; script object fields use camelCase, for example `media: {libraryId, assetId}`. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project:\n\n```js\nconst t = AddTrack(\"video\");\nInsert(t, {type: \"color\", color: \"#123456\", start: 0, length: 3});\nPrint(t);\n```";
8281
+ readonly description: "Edit the current timeline atomically using synchronous JavaScript source. Read state or timeline first, then pass its revision as expected_revision to detect concurrent changes. Unlike Shotstack, execute applies script edits to a persistent project in one transaction. Provide script or a saved edit_id with literal edits, never both; failures roll back writes. A revision conflict while preparing the response may follow a committed edit: retrieve state before retrying. Minimal script after creating a project: `const t = AddTrack(\"video\"); Insert(t, {type: \"color\", color: \"#123456\", start: 0, length: 3}); Print(t);`\n\n### Script function reference\n\nFunctions are synchronous globals; do not import them. `project` is the current project ID. TrackId and ClipId are strings returned by AddTrack and Insert or read from GetTimeline. JoinId is the string returned by Join or read from GetTimeline().joins. Reads see earlier writes in the same script.\n\n```ts\nGetTimeline(o?: { from?: number; to?: number; tracks?: TrackId[] }): TimelineView;\nGetItem(id: ClipId): ItemView;\nFindItems<T>(visit: (item: ItemView, ctx: { track: TrackView; index: number }) => T | undefined): T[];\nGetMedia(ref: MediaRef): MediaInfo;\nGetTranscript(ref: MediaRef, o?: { from?: number; to?: number }): Word[];\nGetAnalysis(ref: MediaRef, kind: AnalysisKind): Segment[];\nListTransitions(): TransitionInfo[];\nListFonts(): { family: string; weights: number[]; scripts: (\"latin\"|\"cjk\")[]; source: \"bundled\"|\"catalog\" }[];\nInsert(track: TrackId, item: ItemInit, o?: { ripple?: boolean }): ClipId;\nUpdate(id: ClipId, patch: ItemPatchView): void;\nSetSpeed(id: ClipId, rate: number, o: { keep: \"source\" | \"duration\"; ripple?: boolean }): { length: number; sourceOut: number };\nDelete(id: ClipId, o?: { ripple?: boolean }): void;\nJoin(left: ClipId, right: ClipId, o: { length?: number; effect: TransitionInput }): JoinId;\nUpdateJoin(id: JoinId, patch: { length?: number; effect?: TransitionInput }): void;\nDeleteJoin(id: JoinId): void;\nSplit(id: ClipId, at: number): ClipId;\nTrim(id: ClipId, edge: \"in\" | \"out\", delta: number, o?: { ripple?: boolean }): void;\nMove(id: ClipId, start: number, track?: TrackId): void;\nRippleDeleteRange(from: number, to: number, tracks?: TrackId[]): void;\nAddTrack(kind: \"video\" | \"audio\" | \"caption\", init?: { name?: string }, index?: number): TrackId;\nUpdateTrack(id: TrackId, patch: TrackPatch): void;\nDeleteTrack(id: TrackId): void;\nSetSettings(patch: Partial<ProjectSettingsView>): void;\nAddCaptionsFromTranscript(track: TrackId, source: ClipId, o?: { style?: Partial<CaptionStyle>; maxChars?: number }): ClipId[];\nSetMarker(at: number, label: string): string;\nPrint(...values: unknown[]): void;\nPreview(at: number[]): void;\n```\n\n| Functions | Behavior and arguments |\n| --- | --- |\n| GetTimeline, GetItem | Read compact item views: id, track, type, start, end, length, optional media, playback, sourceIn/sourceOut, text and offline reason. GetTimeline returns duration, tracks (id, kind, name, index, locked, items), and joins (id, track, left, right, length in seconds, normalized effect). from/to and tracks narrow the items and joins; joins are selected by their overlap window. |\n| ListTransitions | Discover the shared validation catalog: each entry contains kind (effect ID), name, description and params. Each parameter has name, type (enum/number/integer), default, description, enum values or numeric min/max. Use the returned kind and parameter names inside effect. |\n| FindItems | Visit items with their track and index; return undefined to omit an item, any other value to collect it. |\n| GetMedia | Read metadata for `{libraryId, assetId}` in a bound library: kind, dimensions, fps, hasAudio and durationUs when available. durationUs is microseconds. |\n| GetTranscript, GetAnalysis | Read available transcript words or silence/filler/scenes segments. Transcript filter from/to is seconds; returned word and segment from/to values are source microseconds (divide by 1,000,000 for editing). Words contain text and optional speaker/filler; segments may include label/confidence. Request analysis first if unavailable. |\n| Insert, Update, Delete | Insert returns the new clip ID; Update changes supplied fields; Delete removes the clip. Optional ripple on Insert/Delete closes or opens space on the track. |\n| SetSpeed | Change video/audio rate in 0.25–4; keep is required. source preserves consumed source and changes length, duration preserves output length. Returns actual length and sourceOut in seconds. Optional ripple explicitly shifts same-track followers when keeping source; otherwise overlaps are rejected. |\n| Join, UpdateJoin, DeleteJoin | Join creates an overlap between two butt-adjacent visual clips on the same track and returns its ID. length defaults to 0.5 seconds; effect is required. The right clip and all same-track followers move left by length, shortening that track and potentially the project. UpdateJoin moves those followers by the difference in length; omitted fields are preserved. DeleteJoin moves them right to restore the butt cut. Other tracks stay in place. |\n| Split, Trim, Move | Split at a timeline position and return the new right-hand clip ID. Trim changes the in or out edge by delta seconds. Move sets the timeline start and optionally a new track. |\n| RippleDeleteRange | Delete a timeline interval and close its gap on the specified tracks, or all unlocked tracks when omitted. |\n| AddTrack, UpdateTrack, DeleteTrack | Add video/audio/caption tracks; index selects layer order (0 is top). TrackPatch supports name, locked, hidden, muted, gainDb and style as appropriate to track kind. |\n| SetSettings | Supply any of width/height (pixels), fps (frames per second), background (color). |\n| AddCaptionsFromTranscript | Create captions from an audio/video clip's kept words. Optional maxChars is 1–1000, default 16; style updates the caption track. Returns caption IDs. |\n| SetMarker | Add a label at a timeline time and return its ID. |\n| Print, Preview | Print appends text to prints. Preview requests up to eight times total per execute and puts images in the result's frames. Each url is an inline PNG data URL, not an HTTP image link. Decode the base64 payload to save an image. Codemode returns at most four images per call; request at most four times there. |\n\n#### Joins between clips\n\nEndpoints may be video, image, text, color or shape; audio and caption are rejected. Require 0 < length < each endpoint's length. Each clip allows at most one incoming and one outgoing join; their summed lengths cannot exceed its length. Three-input overlaps, nonadjacent endpoints and cross-track joins are rejected with OPS_REJECTED. Read the rejection's code and message, shorten or remove conflicting joins, and retry the saved edit.\n\nTransitionInput is an object with kind plus the parameters returned by ListTransitions; omitted parameters use catalog defaults. Unknown kinds and invalid parameters return INVALID_TRANSITION_PARAM with available parameters. Effects: dissolve; dip color black/white default black; push and wipe direction left/right/up/down default left; wipe softness 0–1 default 0; iris centerX/centerY 0–1 default 0.5; blinds integer count 2–64 default 8 and orientation vertical/horizontal default vertical; blur radius 0–100 pixels at 1080-pixel frame height default 24; zoom direction in/out default in, amount 0.1–3 default 1, blur 0–1 default 0.5; clock direction clockwise/counterclockwise default clockwise, startAngle 0–360 degrees default 0 (twelve o'clock), softness 0–1 default 0; flash color white/black default white, intensity 0–1 default 1. Zoom blur uses up to eight radial samples per shot and is slower on server rendering. Join options and UpdateJoin patches accept only length and effect. Effect updates replace the effect object and apply defaults for omitted parameters.\n\nMinimal example on an existing visual track with adjacent clips left and right: `Print(ListTransitions()); const j = Join(left, right, {length: 0.5, effect: {kind: \"dissolve\"}}); Print(GetTimeline().joins); Preview([GetItem(right).start + 0.25]);` Use `UpdateJoin(j, {length: 0.8})` to adjust it in a later edit or `DeleteJoin(j)` to restore the cut. Preview uses server-rendered frames and includes joins. Per-clip transitionIn/transitionOut remain separate entrance/exit effects.\n\n#### Insert fields (ItemInit)\n\nEvery item requires `type` and `start`. Times used for editing are seconds and snap to the project frame rate: start, length, sourceIn, fadeIn/fadeOut, transition length, keyframe at, reveal delay/stagger/duration. Keyframe and reveal times are relative to the clip start. Video/audio may omit length to use the remaining source duration; other types require length.\n\n| type | Required fields beyond type/start | Optional fields |\n| --- | --- | --- |\n| video | media | length, sourceIn, playback, volumeDb, transform, fit, animate, transitionIn, transitionOut |\n| image | media, length | transform, fit, animate, transitionIn, transitionOut |\n| text | text, length | style, transform, reveal, animate, transitionIn, transitionOut |\n| color | color, length | transform, fill, animate, transitionIn, transitionOut |\n| shape | shape, length, width, height, fill | radius, stroke, transform, animate, transitionIn, transitionOut |\n| audio | media | length, sourceIn, playback, volumeDb, fadeIn, fadeOut |\n| caption | text, length | — |\n\nVideo tracks accept video/image/text/color/shape; audio and caption tracks accept their corresponding type. Media is `{libraryId: string, assetId: string}` from a bound library. sourceIn defaults to 0, volumeDb to 0 dB, audio fades to 0 seconds. fit defaults to contain: contain fits the whole image, cover fills and crops, fill stretches, none keeps native dimensions.\n\n| Field | Value |\n| --- | --- |\n| transform | Partial `{x, y, scale, rotation, opacity, crop, blur}`. x/y are normalized canvas center coordinates (default 0.5); scale 1 is fitted size; rotation is degrees (default 0); opacity is 0–1 (default 1). crop is `{top,right,bottom,left}`. blur is 0–100 pixels at 1080-pixel frame height. |\n| style | Partial `{fontFamily, fontSize, fontWeight, color, fill, stroke, strokes, shadows, glow, background, align, maxWidth, position, margin}`. fill accepts a color or linear/radial gradient across the entire text bounding box. strokes draw outside to inside; at most 4, width 0–40. shadows accepts at most 4 `{color,x,y,blur}` entries; blur is 0–100. glow is `{color,radius,strength}` with radius 0–100 and strength 0–1. All dimensions use pixels at 1080 frame height and scale with the text. Glow and large shadow blur increase render time. Invalid colors or ranges return actionable INVALID_STYLE errors. `ListFonts()` discovers family, available weights, scripts and bundled/catalog source. Text and captions share the style fields; caption style additionally supports highlightColor and maxLines: 2. |\n| animate | An object keyed by x, y, scale, rotation, opacity or blur. Each value is an array of `{at: number, value: number, ease?: Ease}` sorted by at with distinct frame-snapped times. Values hold before the first and after the last keyframe, overriding the static transform. |\n| Ease | linear, in, out, inOut, `{bezier: [x1,y1,x2,y2]}` or `{spring: {stiffness, damping, mass?}}`. Easing shapes the segment arriving at that keyframe; springs may overshoot. |\n| reveal | `{by, delay?: number, stagger: number, duration: number, from: {y?, opacity?, scale?, blur?}, ease?: Ease}`. by selects char, word or line. Unit k starts at delay + k * stagger and takes duration seconds to reach its resting state; from.y is a fraction of font size. |\n| fill | A color string (#RRGGBB or #RRGGBBAA), `{linear: {angle, stops: [{at,color}, ...]}}` or `{radial: {stops: [{at,color}, ...]}}`. Stop positions are 0–1; angle is degrees, 0 left to right. On color clips, fill replaces color when supplied. |\n| shape, width, height, radius, stroke | shape is rect or ellipse. width/height are fractions of canvas width/height before scaling. radius rounds rect corners in pixels at 1080-pixel frame height. stroke is `{color: string, width: number}`. |\n| transitionIn, transitionOut | `{kind, length: number}` at the clip's beginning/end. length is seconds. fade changes opacity; dissolve blends; push_left/push_right move horizontally; wipe_left reveals horizontally. |\n\n#### Update fields (ItemPatchView)\n\nAll fields are optional; use only fields relevant to the item's type. Supported fields: start, length, sourceIn, playback, volumeDb, transform, fit, text, style, color, fadeIn, fadeOut, animate, reveal, fill, stroke, shape, width, height, radius, transitionIn, transitionOut. Values and units match Insert. Set animate, reveal, fill, stroke, transitionIn or transitionOut to null to remove that effect; omitting a field preserves it. For example: `Update(id, {volumeDb: -12})` or `Update(id, {transitionIn: null})`.\n\n#### Speed, reverse and freeze\n\nVideo/audio Insert and Update accept playback as `{kind: \"rate\", rate: number, direction: \"forward\" | \"reverse\", audio: \"preservePitch\" | \"resample\" | \"mute\"}` or `{kind: \"freeze\"}`. Rate is finite and inclusive 0.25–4. Omitted playback defaults to 1× forward with preservePitch; supply the complete rate object when changing playback. preservePitch keeps pitch, resample changes pitch with speed, mute removes audio. Reverse requires explicit audio: \"mute\"; preservePitch/resample are rejected with UNSUPPORTED_PLAYBACK rather than silently muted. Freeze holds sourceIn and is silent. GetItem/GetTimeline echo playback and the source interval in seconds; sourceOut is exclusive even for reverse and equals sourceIn for freeze.\n\nUpdate of playback keeps output length unless length is also supplied. SetSpeed preserves direction/audio, rejects frozen and non-video/audio clips, and requires keep: \"source\" or \"duration\". keep: \"source\" computes round(consumed source / new rate × fps) frames, falling back to floor if rounding would exceed the source end; the returned length/sourceOut are actual frame-rounded seconds. keep: \"duration\" keeps output length and changes source consumption. Length conflicts fail with OVERLAP; move/shorten the conflicting clip, keep duration, or explicitly use ripple: true to shift following clips on the same track. Source overflow fails with OUT_OF_SOURCE; rate limits fail with RATE_OUT_OF_RANGE. Unknown playback fields and SetSpeed options are rejected with UNKNOWN_FIELD; options only accept keep and boolean ripple.\n\nExample for an existing four-second video/audio clip id: `Print(SetSpeed(id, 0.5, {keep: \"source\"})); Print(SetSpeed(id, 2, {keep: \"source\"}));` returns lengths 8 then 2, keeping the same source interval. Reverse: `Update(id, {playback: {kind: \"rate\", rate: 1, direction: \"reverse\", audio: \"mute\"}})`. Freeze: `Update(id, {playback: {kind: \"freeze\"}})`. Ensure enough source remains for the chosen length/rate. Browser reverse playback currently displays a placeholder; server-rendered Preview/frames and exports support reverse normally. Speed-adjusted audio is generated asynchronously after the edit transaction commits; exports wait for that audio before rendering.\n\n#### Script names versus HTTP response names\n\nUse camelCase inside scripts, including nested objects. HTTP request/response JSON outside script source uses snake_case. Map media.library_id → media.libraryId, media.asset_id → media.assetId, source_in → sourceIn, volume_db → volumeDb, fade_in/fade_out → fadeIn/fadeOut, transition_in/transition_out → transitionIn/transitionOut, font_family/font_size/font_weight/max_width → fontFamily/fontSize/fontWeight/maxWidth, gain_db → gainDb, highlight_color/max_lines → highlightColor/maxLines. Fields such as animate, reveal, fill, stroke, at and length retain their spelling. GetTimeline/GetItem already return camelCase compact views; the expanded retrieveTimeline HTTP response is not an Insert object.\n\nUnrecognized script fields fail with OPS_REJECTED and rejection code UNKNOWN_FIELD; snake_case mistakes suggest the corresponding camelCase name. The error message lists each rejection's #opIndex, code and reason. Correct the named fields and retry the saved edit; do not assume an ignored field applied an effect.\n";
6926
8282
  readonly http: "POST";
6927
8283
  readonly path: "/cut/v1/projects/{project_id}:execute";
6928
8284
  readonly streaming: "no";
@@ -7818,7 +9174,7 @@ export declare const operations: readonly [{
7818
9174
  readonly resource: "file.files";
7819
9175
  readonly method: "create";
7820
9176
  readonly summary: "Upload file";
7821
- readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.";
9177
+ readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–7776000). Without expiry, the file persists until deleted.";
7822
9178
  readonly http: "POST";
7823
9179
  readonly path: "/file/v1/files";
7824
9180
  readonly streaming: "no";
@@ -7836,9 +9192,9 @@ export declare const operations: readonly [{
7836
9192
  }, {
7837
9193
  readonly name: "purpose";
7838
9194
  readonly type: "string";
7839
- readonly enum: readonly ["user_data", "vision"];
9195
+ readonly enum: readonly ["user_data", "assistants", "vision"];
7840
9196
  readonly required: true;
7841
- readonly description: "Purpose label stored with the file: user_data or vision. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data.";
9197
+ readonly description: "Purpose label stored with the file: user_data, assistants or vision. The label is stored and returned unchanged; assistants follows the same rules as user_data. The vision purpose accepts only PNG, JPEG, GIF and WebP images. Conversation image references require user_data.";
7842
9198
  }, {
7843
9199
  readonly name: "expires_after";
7844
9200
  readonly type: "object";
@@ -7895,7 +9251,7 @@ export declare const operations: readonly [{
7895
9251
  readonly resource: "file.files.contentLinks";
7896
9252
  readonly method: "revoke";
7897
9253
  readonly summary: "Revoke a file content link";
7898
- readonly description: "Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within 30 seconds; the file and other links remain available. Only current IAM capability tokens can be revoked; legacy content links expire at the migration deadline. Example body: {\"token\":\"<token from /c/>\"}.";
9254
+ readonly description: "Stop a previously issued content link from reading a file. Obtain the link with files.contentUrl.create. Use file_id from file creation or listing and the token path component from a content URL (/c/<token>), not the complete URL. The caller must own the file and have write access; a read-only binding is refused. Revocation propagates through the capability deny list within 15 minutes; the file and other links remain available. Only current IAM capability tokens can be revoked; legacy content links expire at the migration deadline. Example body: {\"token\":\"<token from /c/>\"}.";
7899
9255
  readonly http: "POST";
7900
9256
  readonly path: "/file/v1/files/{file_id}/content_links:revoke";
7901
9257
  readonly streaming: "no";
@@ -7919,7 +9275,7 @@ export declare const operations: readonly [{
7919
9275
  readonly resource: "file.files.contentUrl";
7920
9276
  readonly method: "create";
7921
9277
  readonly summary: "Create a download URL";
7922
- readonly description: "Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to 3600 seconds and is at most 604800 seconds. Issuance requires the same credential and file-read access as files.retrieveContent; a processing file returns 409 FILE_NOT_READY, so poll files.retrieve until active before retrying. A missing, expired or other-organization file returns 404. Each issuance creates a new link. OpenAI Files has no signed download URL; this follows S3 presigned GET semantics. Example body: {\"ttl_seconds\":3600}.";
9278
+ readonly description: "Download a file's bytes to a local disk from a coding agent without sending them through the model. Use file_id from file creation or listing, then run curl -fsSL -o <filename> '<url>' locally with the returned URL; GET needs no Authorization header. The link is reusable until expiry and supports a single byte Range (for example Range: bytes=0-9 returns 206). Revoke it with files.contentLinks.revoke, passing the token after /c/ in the URL. Expired, revoked, invalid or cross-organization URLs return 404. Lifetime defaults to 900 seconds and is at most 604800 seconds. Issuance requires the same credential and file-read access as files.retrieveContent; a processing file returns 409 FILE_NOT_READY, so poll files.retrieve until active before retrying. A missing, expired or other-organization file returns 404. Each issuance creates a new link. OpenAI Files has no signed download URL; this follows S3 presigned GET semantics. Example body: {\"ttl_seconds\":3600}.";
7923
9279
  readonly http: "POST";
7924
9280
  readonly path: "/file/v1/files/{file_id}/content_url";
7925
9281
  readonly streaming: "no";
@@ -7936,14 +9292,14 @@ export declare const operations: readonly [{
7936
9292
  readonly name: "ttl_seconds";
7937
9293
  readonly type: "integer";
7938
9294
  readonly required: false;
7939
- readonly description: "Download link lifetime in seconds, from 1 through 604800; omitted means 3600. This does not change the file's own expiry.";
9295
+ readonly description: "Download link lifetime in seconds, from 1 through 604800; omitted means 900. This does not change the file's own expiry.";
7940
9296
  }];
7941
9297
  };
7942
9298
  }, {
7943
9299
  readonly resource: "file.uploads";
7944
9300
  readonly method: "create";
7945
9301
  readonly summary: "Create an upload";
7946
- readonly description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.";
9302
+ readonly description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.";
7947
9303
  readonly http: "POST";
7948
9304
  readonly path: "/file/v1/uploads";
7949
9305
  readonly streaming: "no";
@@ -7970,9 +9326,9 @@ export declare const operations: readonly [{
7970
9326
  }, {
7971
9327
  readonly name: "purpose";
7972
9328
  readonly type: "string";
7973
- readonly enum: readonly ["user_data", "vision"];
9329
+ readonly enum: readonly ["user_data", "assistants", "vision"];
7974
9330
  readonly required: true;
7975
- readonly description: "Use user_data for conversation attachments, or vision for PNG, JPEG, GIF and WebP images.";
9331
+ readonly description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images.";
7976
9332
  }, {
7977
9333
  readonly name: "expires_after";
7978
9334
  readonly type: "object";
@@ -8016,9 +9372,9 @@ export declare const operations: readonly [{
8016
9372
  }, {
8017
9373
  readonly name: "purpose";
8018
9374
  readonly type: "string";
8019
- readonly enum: readonly ["user_data", "vision"];
9375
+ readonly enum: readonly ["user_data", "assistants", "vision"];
8020
9376
  readonly required: false;
8021
- readonly description: "user_data stores ordinary files and conversation images; vision accepts PNG, JPEG, GIF or WebP images only. Omitted means user_data.";
9377
+ readonly description: "user_data and assistants store ordinary files and conversation images with their original purpose label; vision accepts PNG, JPEG, GIF or WebP images only. Omitted means user_data.";
8022
9378
  }, {
8023
9379
  readonly name: "expires_in";
8024
9380
  readonly type: "integer";
@@ -8148,7 +9504,7 @@ export declare const operations: readonly [{
8148
9504
  readonly resource: "knowledge.vectorStores";
8149
9505
  readonly method: "create";
8150
9506
  readonly summary: "Create knowledge base";
8151
- readonly description: "Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. Each file accepts up to 52428800 bytes and 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {\"name\":\"Refund policies\"}.";
9507
+ readonly description: "Create a knowledge base, optionally starting ingestion of uploaded file_ids in the same call; no separate attachment or batch is needed for those files. Use the returned id with vectorStores.files.retrieve to poll each attachment until completed, failed or cancelled; store status=completed alone does not mean every file succeeded. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; each account holds up to 100 active/nondeleted stores. Minimal body: {\"name\":\"Refund policies\"}.";
8152
9508
  readonly http: "POST";
8153
9509
  readonly path: "/knowledge/v1/vector_stores";
8154
9510
  readonly streaming: "no";
@@ -8182,7 +9538,7 @@ export declare const operations: readonly [{
8182
9538
  readonly name: "chunking_strategy";
8183
9539
  readonly type: "object";
8184
9540
  readonly required: false;
8185
- readonly description: "auto resolves to static with 800 estimated tokens and 400 overlap tokens. Unlike OpenAI vector stores, token counts are estimates; each Han character counts as one, and other whitespace-delimited words count as their UTF-16 length divided by four, rounded up.";
9541
+ readonly description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy.";
8186
9542
  }, {
8187
9543
  readonly name: "description";
8188
9544
  readonly type: "string";
@@ -8452,7 +9808,7 @@ export declare const operations: readonly [{
8452
9808
  readonly resource: "knowledge.vectorStores.files";
8453
9809
  readonly method: "create";
8454
9810
  readonly summary: "Add file";
8455
- readonly description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. Each file accepts up to 52428800 bytes and 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.";
9811
+ readonly description: "Attach an uploaded File for asynchronous ingestion, then poll this attachment until status is completed, failed or cancelled before searching. PDF files accept up to 536870912 bytes (512 MiB), while other formats accept up to 52428800 bytes (50 MiB), constrained by Router conversion; every file is limited to 5000000 estimated tokens; chunk sizes use estimated tokens rather than a model tokenizer. Text, Markdown, CSV, JSON, HTML, PDF, DOCX, PPTX, XLSX and PNG/JPEG/GIF/WebP images can be extracted; audio and video uploads are not knowledge documents. Images may yield generated descriptions rather than verbatim OCR. auto chunking resolves to static 800/400; explicit sizes are 100–4096 with overlap at most half the size. Each store holds at most 10000 attached files. Reattaching the same file returns its existing record without applying new attributes or chunking; inspect last_error after failure.";
8456
9812
  readonly http: "POST";
8457
9813
  readonly path: "/knowledge/v1/vector_stores/{vector_store_id}/files";
8458
9814
  readonly streaming: "no";
@@ -8479,7 +9835,7 @@ export declare const operations: readonly [{
8479
9835
  readonly name: "chunking_strategy";
8480
9836
  readonly type: "object";
8481
9837
  readonly required: false;
8482
- readonly description: "auto resolves to static with 800 estimated tokens and 400 overlap tokens. Unlike OpenAI vector stores, token counts are estimates; each Han character counts as one, and other whitespace-delimited words count as their UTF-16 length divided by four, rounded up.";
9838
+ readonly description: "Native attachment strategy. auto uses static chunks of 800 estimated tokens with 400 overlap; static supplies explicit chunk sizes; hierarchical indexes child chunks and supplies bounded parent context. Existing attachments are reused unchanged; remove and reattach a file to change its strategy.";
8483
9839
  }];
8484
9840
  };
8485
9841
  }, {
@@ -8733,7 +10089,7 @@ export declare const operations: readonly [{
8733
10089
  readonly resource: "media.libraries";
8734
10090
  readonly method: "list";
8735
10091
  readonly summary: "List libraries";
8736
- readonly description: "List libraries owned by the caller, newest first. By default, deleting and deleted libraries are excluded; use status=deleting to find libraries awaiting purge. All supplied label pairs must match.";
10092
+ readonly description: "Read a caller-owned library’s current settings, usage and lifecycle status. A deleting library remains readable; missing, foreign or purged libraries return LIBRARY_NOT_FOUND.";
8737
10093
  readonly http: "GET";
8738
10094
  readonly path: "/media/v1/libraries";
8739
10095
  readonly streaming: "no";
@@ -8800,7 +10156,7 @@ export declare const operations: readonly [{
8800
10156
  readonly resource: "media.libraries";
8801
10157
  readonly method: "delete";
8802
10158
  readonly summary: "Delete library";
8803
- readonly description: "Soft-delete an active library, returning its deleting status and purge_at deadline. Asset operations and delivery become unavailable; the library can be restored before purge_at. Repeated deletion while deleting returns the current library.";
10159
+ readonly description: "Restore a deleting library before its purge_at deadline. The library becomes active again and deleted_at and purge_at are cleared; expired or non-deleting libraries cannot be restored.";
8804
10160
  readonly http: "DELETE";
8805
10161
  readonly path: "/media/v1/libraries/{library_id}";
8806
10162
  readonly streaming: "no";
@@ -8815,7 +10171,7 @@ export declare const operations: readonly [{
8815
10171
  readonly resource: "media.libraries";
8816
10172
  readonly method: "retrieve";
8817
10173
  readonly summary: "Get library";
8818
- readonly description: "Read a caller-owned library’s current settings, usage and lifecycle status. A deleting library remains readable; missing, foreign or purged libraries return LIBRARY_NOT_FOUND.";
10174
+ readonly description: "Update an active library’s supplied settings. Labels replace the complete map; understanding settings and model roles merge with current values. Changing the embedding model is rejected while assets exist.";
8819
10175
  readonly http: "GET";
8820
10176
  readonly path: "/media/v1/libraries/{library_id}";
8821
10177
  readonly streaming: "no";
@@ -8830,7 +10186,7 @@ export declare const operations: readonly [{
8830
10186
  readonly resource: "media.libraries";
8831
10187
  readonly method: "update";
8832
10188
  readonly summary: "Update library";
8833
- readonly description: "Update an active library’s supplied settings. Labels replace the complete map; understanding settings and model roles merge with current values. Changing the embedding model is rejected while assets exist.";
10189
+ readonly description: "Update an active library. Set hotwords for spelling evidence in subsequent transcripts; [] disables inferred vocabulary. Transcript understanding calls the timestamped ASR, optional reference ASR and correction model through the existing metered model path. Reprocess assets to apply new settings to existing transcripts.";
8834
10190
  readonly http: "PATCH";
8835
10191
  readonly path: "/media/v1/libraries/{library_id}";
8836
10192
  readonly streaming: "no";
@@ -8844,6 +10200,12 @@ export declare const operations: readonly [{
8844
10200
  readonly body: {
8845
10201
  readonly required: true;
8846
10202
  readonly fields: readonly [{
10203
+ readonly name: "hotwords";
10204
+ readonly type: "array";
10205
+ readonly itemType: "string";
10206
+ readonly required: false;
10207
+ readonly description: "Correction vocabulary, at most 200 nonblank terms of at most 32 Unicode characters each. Omitted on an unconfigured library: correction derives up to 200 distinct names from the library name and every folder level, excluding generic names such as 原始素材 and 混剪成品. An explicit empty array disables this vocabulary. Updating affects subsequent understanding and explicit reprocessing, not existing results.";
10208
+ }, {
8847
10209
  readonly name: "models";
8848
10210
  readonly type: "object";
8849
10211
  readonly required: false;
@@ -8869,7 +10231,7 @@ export declare const operations: readonly [{
8869
10231
  readonly resource: "media.libraries.assets";
8870
10232
  readonly method: "list";
8871
10233
  readonly summary: "List assets";
8872
- readonly description: "List assets in an active library, newest first, optionally filtering by exact folder and stored resource type. Continue using next_cursor; video includes audio-only assets.";
10234
+ readonly description: "Upload content into an active library and return a Cloudinary-compatible resource. Use file for a multipart file, data URI, public HTTPS URL or same-owner file identifier. Reusing public_id overwrites by default; overwrite=false returns the existing resource. Chunk uploads require both chunk headers.";
8873
10235
  readonly http: "GET";
8874
10236
  readonly path: "/media/v1/libraries/{library_id}/assets";
8875
10237
  readonly streaming: "no";
@@ -8905,7 +10267,7 @@ export declare const operations: readonly [{
8905
10267
  readonly resource: "media.libraries.assets";
8906
10268
  readonly method: "create";
8907
10269
  readonly summary: "Upload asset";
8908
- readonly description: "Upload content into an active library and return a Cloudinary-compatible resource. Use file for a multipart file, data URI, public HTTPS URL or same-owner file identifier. Reusing public_id overwrites by default; overwrite=false returns the existing resource. Chunk uploads require both chunk headers.";
10270
+ readonly description: " For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
8909
10271
  readonly http: "POST";
8910
10272
  readonly path: "/media/v1/libraries/{library_id}/assets";
8911
10273
  readonly streaming: "no";
@@ -8943,7 +10305,7 @@ export declare const operations: readonly [{
8943
10305
  readonly name: "asset_folder";
8944
10306
  readonly type: "string";
8945
10307
  readonly required: false;
8946
- readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
10308
+ readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
8947
10309
  }, {
8948
10310
  readonly name: "use_filename";
8949
10311
  readonly type: "boolean";
@@ -9002,7 +10364,7 @@ export declare const operations: readonly [{
9002
10364
  readonly resource: "media.libraries.assets.import";
9003
10365
  readonly method: "create";
9004
10366
  readonly summary: "Import file";
9005
- readonly description: "Copy source content into an active library using upload options and return the full native Asset. The imported asset is independent of the source after copying. Reusing public_id follows overwrite semantics.";
10367
+ readonly description: "Copy a File into an independent Media asset. New assets default to organization-private delivery (type=authenticated); explicitly set type=upload for public originals and derivatives. Omitting type on overwrite preserves the current type. Deleting the source File does not delete this copy. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
9006
10368
  readonly http: "POST";
9007
10369
  readonly path: "/media/v1/libraries/{library_id}/assets/import";
9008
10370
  readonly streaming: "no";
@@ -9019,7 +10381,7 @@ export declare const operations: readonly [{
9019
10381
  readonly name: "file_id";
9020
10382
  readonly type: "string";
9021
10383
  readonly required: true;
9022
- readonly description: "File ID to copy into this library instead of file bytes. This independent copy defaults to public delivery; set type=authenticated for private delivery. Deleting the source File does not delete this asset.";
10384
+ readonly description: "File ID to copy into this library instead of file bytes. This independent copy defaults to organization-private delivery (type=authenticated); explicitly set type=upload for public delivery. Deleting the source File does not delete this asset.";
9023
10385
  }, {
9024
10386
  readonly name: "public_id";
9025
10387
  readonly type: "string";
@@ -9039,7 +10401,7 @@ export declare const operations: readonly [{
9039
10401
  readonly name: "asset_folder";
9040
10402
  readonly type: "string";
9041
10403
  readonly required: false;
9042
- readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
10404
+ readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
9043
10405
  }, {
9044
10406
  readonly name: "use_filename";
9045
10407
  readonly type: "boolean";
@@ -9098,7 +10460,7 @@ export declare const operations: readonly [{
9098
10460
  readonly resource: "media.libraries.assets";
9099
10461
  readonly method: "delete";
9100
10462
  readonly summary: "Delete asset";
9101
- readonly description: "Delete an asset from the library so it is no longer readable, searchable or deliverable. This removes the asset rather than placing it in the library’s restoration window; a missing asset returns ASSET_NOT_FOUND.";
10463
+ readonly description: "Queue reprocessing of the asset’s current version and return its updated state immediately. Omit kinds to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable completed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Replaced understandings become superseded, and processing finishes asynchronously.";
9102
10464
  readonly http: "DELETE";
9103
10465
  readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
9104
10466
  readonly streaming: "no";
@@ -9117,7 +10479,7 @@ export declare const operations: readonly [{
9117
10479
  readonly resource: "media.libraries.assets";
9118
10480
  readonly method: "retrieve";
9119
10481
  readonly summary: "Get asset";
9120
- readonly description: "Read a non-deleted asset by its asset_id in an active library, including content hashes, processing progress and available previews. Missing or deleted assets return ASSET_NOT_FOUND.";
10482
+ readonly description: "Update an asset’s supplied metadata fields. Tags and context replace their current collections; an empty collection clears them. Moving asset_folder or changing display_name preserves public_id and delivery URLs.";
9121
10483
  readonly http: "GET";
9122
10484
  readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
9123
10485
  readonly streaming: "no";
@@ -9136,7 +10498,7 @@ export declare const operations: readonly [{
9136
10498
  readonly resource: "media.libraries.assets";
9137
10499
  readonly method: "update";
9138
10500
  readonly summary: "Update asset";
9139
- readonly description: "Update an asset’s supplied metadata fields. Tags and context replace their current collections; an empty collection clears them. Moving asset_folder or changing display_name preserves public_id and delivery URLs.";
10501
+ readonly description: "Delete an asset from the library so it is no longer readable, searchable or deliverable. This removes the asset rather than placing it in the library’s restoration window; a missing asset returns ASSET_NOT_FOUND.";
9140
10502
  readonly http: "PATCH";
9141
10503
  readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}";
9142
10504
  readonly streaming: "no";
@@ -9162,7 +10524,7 @@ export declare const operations: readonly [{
9162
10524
  readonly name: "asset_folder";
9163
10525
  readonly type: "string";
9164
10526
  readonly required: false;
9165
- readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected.";
10527
+ readonly description: "Organizational folder path, separate from public_id. Empty selects the root; leading or trailing slashes, empty path segments, and . or .. segments are rejected. New path segments containing U+FFFD or consisting only of question marks are rejected with INVALID_PARAMS; send UTF-8 names. Existing affected folders remain readable and assets can be moved out.";
9166
10528
  }, {
9167
10529
  readonly name: "tags";
9168
10530
  readonly type: "array";
@@ -9176,11 +10538,46 @@ export declare const operations: readonly [{
9176
10538
  readonly description: "Replacement custom string-metadata map. Nonempty keys are required and serialized JSON must fit within 1024 UTF-8 bytes; an empty object clears the metadata.";
9177
10539
  }];
9178
10540
  };
10541
+ }, {
10542
+ readonly resource: "media.libraries.assets.frames";
10543
+ readonly method: "create";
10544
+ readonly summary: "Create frame URLs";
10545
+ readonly description: "Media creates JPEG frame URLs for inspecting one or more moments in a video without downloading the original. Obtain library_id from libraries and asset_id plus duration from assets. Send 1–20 integer microsecond timestamps strictly below duration, for example {\"at_micros\":[0,1000000],\"width\":640}. Only video assets are supported; audio and images return INVALID_PARAMS. Width defaults to 640 and accepts 160, 320 or 640. This read operation does not store a new asset or rerun understanding. Fetch each returned URL to obtain the frame; delivery usage follows media pricing. Authenticated links expire after 300 seconds; upload links remain public and permanent. Reissue expired links. Foreign libraries and assets return 404 without revealing their existence.";
10546
+ readonly http: "POST";
10547
+ readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/frames";
10548
+ readonly streaming: "no";
10549
+ readonly pagination: false;
10550
+ readonly pathParams: readonly [{
10551
+ readonly name: "library_id";
10552
+ readonly sdkName: "library_id";
10553
+ readonly description: "Library identifier returned by library creation or listing; must be accessible to the current credential.";
10554
+ }, {
10555
+ readonly name: "asset_id";
10556
+ readonly sdkName: "asset_id";
10557
+ readonly description: "Video asset identifier returned by asset upload or listing in this library; read its duration before choosing timestamps.";
10558
+ }];
10559
+ readonly query: readonly [];
10560
+ readonly body: {
10561
+ readonly required: true;
10562
+ readonly fields: readonly [{
10563
+ readonly name: "at_micros";
10564
+ readonly type: "array";
10565
+ readonly itemType: "integer";
10566
+ readonly required: true;
10567
+ readonly description: "One to twenty timestamps in microseconds from the start of the video. Each must be a nonnegative safe integer strictly below the video duration; order and duplicates are preserved.";
10568
+ }, {
10569
+ readonly name: "width";
10570
+ readonly type: "integer";
10571
+ readonly enum: readonly [160, 320, 640];
10572
+ readonly required: false;
10573
+ readonly description: "Maximum JPEG width in pixels: 160 is a small thumbnail, 320 a preview and 640 a larger preview. Defaults to 640; larger widths are unavailable.";
10574
+ }];
10575
+ };
9179
10576
  }, {
9180
10577
  readonly resource: "media.libraries.assets.reprocess";
9181
10578
  readonly method: "create";
9182
10579
  readonly summary: "Reprocess asset";
9183
- readonly description: "Queue reprocessing of the asset’s current version and return its updated state immediately. Omit kinds to retry failed tasks; explicit kinds rerun applicable completed tasks. Replaced understandings become superseded, and processing finishes asynchronously.";
10580
+ readonly description: " For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
9184
10581
  readonly http: "POST";
9185
10582
  readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess";
9186
10583
  readonly streaming: "no";
@@ -9203,14 +10600,14 @@ export declare const operations: readonly [{
9203
10600
  readonly itemType: "string";
9204
10601
  readonly enum: readonly ["visual", "frames", "transcript", "embedding"];
9205
10602
  readonly required: false;
9206
- readonly description: "Processing tasks to rerun. Omit to retry failed tasks only; explicit kinds rerun applicable ready, failed or unsupported tasks. Pending and running tasks are unchanged; an empty array does nothing.";
10603
+ readonly description: "Processing tasks to rerun. Omit to retry failed tasks and legacy source-size unsupported tasks; explicit kinds rerun applicable ready or failed tasks and recoverable source-size unsupported tasks. Other unsupported causes remain unchanged. Pending and running tasks are unchanged; an empty array does nothing.";
9207
10604
  }];
9208
10605
  };
9209
10606
  }, {
9210
10607
  readonly resource: "media.libraries.assets.understandings";
9211
10608
  readonly method: "list";
9212
10609
  readonly summary: "List understandings";
9213
- readonly description: "List an asset’s understanding results in creation order. By default only current, non-superseded results are returned; use include_superseded=true for history or kind to select an output type.";
10610
+ readonly description: "List understanding results for an asset, ordered by creation time. Use the cursor to continue; include_superseded also returns replaced records. The optional shots array contains current-version shot boundaries and per-shot captions, scene, location guesses, visible text and confidence flags; it is absent on legacy records. Location guesses and folder mismatch are unverified hints. Correction-enabled transcripts expose text_original, corrected text and a correction audit. Their timed data array remains suitable for subtitles. Reference failure is marked missing; correction failure returns the original verbatim. Model inference uses the existing metered model path.";
9214
10611
  readonly http: "GET";
9215
10612
  readonly path: "/media/v1/libraries/{library_id}/assets/{asset_id}/understandings";
9216
10613
  readonly streaming: "no";
@@ -9232,9 +10629,9 @@ export declare const operations: readonly [{
9232
10629
  }, {
9233
10630
  readonly name: "kind";
9234
10631
  readonly type: "string";
9235
- readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame"];
10632
+ readonly enum: readonly ["caption", "tags", "ocr", "transcript", "frame", "overview", "audio", "embedding"];
9236
10633
  readonly required: false;
9237
- readonly description: "Filter result kind: caption is a visual description, tags are recognized labels, ocr is recognized image text, transcript is speech text, and frame describes a video segment.";
10634
+ readonly description: "Return one output kind: caption is a visual description, tags are generated labels, ocr is visible text, transcript is speech, frame is a video shot, overview is a video summary, audio is sampled audio understanding, and embedding reports a failed embedding step.";
9238
10635
  }, {
9239
10636
  readonly name: "cursor";
9240
10637
  readonly type: "string";
@@ -9250,7 +10647,7 @@ export declare const operations: readonly [{
9250
10647
  readonly resource: "media.libraries.assets";
9251
10648
  readonly method: "batch";
9252
10649
  readonly summary: "Batch assets alias";
9253
- readonly description: "Alias of batch creation. Apply one metadata or deletion action to ids or a frozen expression selection asynchronously; poll the returned job id to inspect completion and item failures.";
10650
+ readonly description: "Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {\"action\":\"reprocess\",\"selector\":{\"expression\":\"processing_state=failed AND failure_code=UPSTREAM_FAILED\"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
9254
10651
  readonly http: "POST";
9255
10652
  readonly path: "/media/v1/libraries/{library_id}/assets:batch";
9256
10653
  readonly streaming: "no";
@@ -9268,13 +10665,18 @@ export declare const operations: readonly [{
9268
10665
  readonly type: "object";
9269
10666
  readonly required: true;
9270
10667
  readonly description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created.";
10668
+ }, {
10669
+ readonly name: "reason";
10670
+ readonly type: "string";
10671
+ readonly required: false;
10672
+ readonly description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters.";
9271
10673
  }];
9272
10674
  };
9273
10675
  }, {
9274
10676
  readonly resource: "media.libraries.batches";
9275
10677
  readonly method: "create";
9276
10678
  readonly summary: "Create batch";
9277
- readonly description: "Create an asynchronous batch for tagging, untagging, replacing context, moving or deleting assets. Select ids or an expression; selection is frozen at creation. Poll the returned job id for completion and per-item failures.";
10679
+ readonly description: "Queue a frozen selection for tagging, untagging, context replacement, moving, deleting or reprocessing. IDs are limited to 1000; use an expression for larger selections, subject to the search scan budget. reprocess starts at most 30 assets per rolling minute per library. Only retryable failed steps and legacy source-size unsupported steps rerun. Omit kinds to inspect all recoverable steps, or supply kinds to narrow them. Other unsupported, permanent and completed steps remain unchanged; a permanent output blocks only its own step. Assets without any selected recoverable step count as failed items without starting understanding. Poll the returned job id; done counts accepted launches, not successful model inference. Staff Admin only permits reprocess and requires a nonblank reason. Example: {\"action\":\"reprocess\",\"selector\":{\"expression\":\"processing_state=failed AND failure_code=UPSTREAM_FAILED\"}}. For understanding, Media generates proxies for video sources of 25 MB or more and audio-only sources of 100 MB or more; originals remain available unchanged. The duration limit is 10 minutes. A video proxy still above 95 MB after recompression, or a source exceeding the duration limit, is reported as UNSUPPORTED with the limit in the failure message. Proxy preparation uses the organization’s metered sandbox resources.";
9278
10680
  readonly http: "POST";
9279
10681
  readonly path: "/media/v1/libraries/{library_id}/batches";
9280
10682
  readonly streaming: "no";
@@ -9292,13 +10694,18 @@ export declare const operations: readonly [{
9292
10694
  readonly type: "object";
9293
10695
  readonly required: true;
9294
10696
  readonly description: "Select assets by ids or by expression, never both. Expression results and exclusions are resolved when the job is created.";
10697
+ }, {
10698
+ readonly name: "reason";
10699
+ readonly type: "string";
10700
+ readonly required: false;
10701
+ readonly description: "Audit reason for the operation; required for staff Admin reprocessing and recorded with the initiating actor. Nonblank, at most 2000 characters.";
9295
10702
  }];
9296
10703
  };
9297
10704
  }, {
9298
10705
  readonly resource: "media.libraries.batches";
9299
10706
  readonly method: "retrieve";
9300
10707
  readonly summary: "Get batch";
9301
- readonly description: "Read a batch job’s status, successful and failed item counts, and a bounded list of failed items. Use the id returned by batch creation; a job outside this library is not found.";
10708
+ readonly description: "Alias of batch creation. Apply one metadata or deletion action to ids or a frozen expression selection asynchronously; poll the returned job id to inspect completion and item failures.";
9302
10709
  readonly http: "GET";
9303
10710
  readonly path: "/media/v1/libraries/{library_id}/batches/{job_id}";
9304
10711
  readonly streaming: "no";
@@ -9317,7 +10724,7 @@ export declare const operations: readonly [{
9317
10724
  readonly resource: "media.libraries.deliveryTokens";
9318
10725
  readonly method: "create";
9319
10726
  readonly summary: "Create delivery token";
9320
- readonly description: "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is 3600 seconds; narrow acl and expires_in before sharing. Anyone holding the token can read matching paths until expires_at.";
10727
+ readonly description: "Issue a time-limited bearer token for originals and transformed authenticated assets in an active library. Use library_id from library creation or listing; read access is sufficient. Append token as the __cld_token__ query parameter on a matching delivery URL. The default ACL covers this library and the default lifetime is 900 seconds; narrow acl and expires_in before sharing. Anyone holding the token can read matching paths until expires_at.";
9321
10728
  readonly http: "POST";
9322
10729
  readonly path: "/media/v1/libraries/{library_id}/delivery_tokens";
9323
10730
  readonly streaming: "no";
@@ -9339,14 +10746,14 @@ export declare const operations: readonly [{
9339
10746
  readonly name: "expires_in";
9340
10747
  readonly type: "integer";
9341
10748
  readonly required: false;
9342
- readonly description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 3600.";
10749
+ readonly description: "Token lifetime in seconds, from 1 to 604800 inclusive; defaults to 900.";
9343
10750
  }];
9344
10751
  };
9345
10752
  }, {
9346
10753
  readonly resource: "media.libraries.events";
9347
10754
  readonly method: "list";
9348
10755
  readonly summary: "List events";
9349
- readonly description: "Read library events in sequence order, including while the library is deleting. Page forward with asc and after_seq, or backward with desc and before_seq; never combine the two sequence cursors.";
10756
+ readonly description: "Read library events in sequence order for observing asset writes and understanding progress. Obtain library_id from creation or listing; continue with after_seq for asc or before_seq for desc, without combining both. Use next_cursor when supplied. Reads do not start or retry understanding.";
9350
10757
  readonly http: "GET";
9351
10758
  readonly path: "/media/v1/libraries/{library_id}/events";
9352
10759
  readonly streaming: "no";
@@ -9382,7 +10789,7 @@ export declare const operations: readonly [{
9382
10789
  readonly resource: "media.libraries.folders";
9383
10790
  readonly method: "list";
9384
10791
  readonly summary: "List folders";
9385
- readonly description: "List all immediate child folders under parent, or under the root when parent is omitted. Counts include descendant assets. The result is unpaginated; limit and cursor are rejected.";
10792
+ readonly description: "undefined understood_count includes ready and partial assets; failed_count includes failed assets. Both accumulate descendants. counts_complete is false during historical backfill.";
9386
10793
  readonly http: "GET";
9387
10794
  readonly path: "/media/v1/libraries/{library_id}/folders";
9388
10795
  readonly streaming: "no";
@@ -9402,7 +10809,7 @@ export declare const operations: readonly [{
9402
10809
  readonly resource: "media.libraries.jobs";
9403
10810
  readonly method: "retrieve";
9404
10811
  readonly summary: "Get job alias";
9405
- readonly description: "Alias of batch retrieval. Read the job returned by a batch request, including terminal status, successful and failed counts, and individual failure codes.";
10812
+ readonly description: "Read library events in sequence order, including while the library is deleting. Page forward with asc and after_seq, or backward with desc and before_seq; never combine the two sequence cursors.";
9406
10813
  readonly http: "GET";
9407
10814
  readonly path: "/media/v1/libraries/{library_id}/jobs/{job_id}";
9408
10815
  readonly streaming: "no";
@@ -9421,7 +10828,7 @@ export declare const operations: readonly [{
9421
10828
  readonly resource: "media.libraries.purge";
9422
10829
  readonly method: "create";
9423
10830
  readonly summary: "Purge library";
9424
- readonly description: "Permanently remove a library that is already deleting, without waiting for purge_at. Its assets and related resources are removed and cannot be restored; first soft-delete an active library.";
10831
+ readonly description: "List assets in an active library, newest first, optionally filtering by exact folder and stored resource type. Continue using next_cursor; video includes audio-only assets.";
9425
10832
  readonly http: "POST";
9426
10833
  readonly path: "/media/v1/libraries/{library_id}/purge";
9427
10834
  readonly streaming: "no";
@@ -9436,7 +10843,7 @@ export declare const operations: readonly [{
9436
10843
  readonly resource: "media.libraries";
9437
10844
  readonly method: "restore";
9438
10845
  readonly summary: "Restore library";
9439
- readonly description: "Restore a deleting library before its purge_at deadline. The library becomes active again and deleted_at and purge_at are cleared; expired or non-deleting libraries cannot be restored.";
10846
+ readonly description: "Permanently remove a library that is already deleting, without waiting for purge_at. Its assets and related resources are removed and cannot be restored; first soft-delete an active library.";
9440
10847
  readonly http: "POST";
9441
10848
  readonly path: "/media/v1/libraries/{library_id}/restore";
9442
10849
  readonly streaming: "no";
@@ -9451,7 +10858,7 @@ export declare const operations: readonly [{
9451
10858
  readonly resource: "media.libraries.search";
9452
10859
  readonly method: "create";
9453
10860
  readonly summary: "Semantic search alias";
9454
- readonly description: "Alias of semantic search. Search assets with a nonblank text query, optional expression filter and top_k; hybrid combines semantic and keyword matches, while semantic uses vector similarity only.";
10861
+ readonly description: "List all immediate child folders under parent, or under the root when parent is omitted. Counts include descendant assets. The result is unpaginated; limit and cursor are rejected.";
9455
10862
  readonly http: "POST";
9456
10863
  readonly path: "/media/v1/libraries/{library_id}/search";
9457
10864
  readonly streaming: "no";
@@ -9491,7 +10898,7 @@ export declare const operations: readonly [{
9491
10898
  readonly resource: "media.libraries.search.expression";
9492
10899
  readonly method: "create";
9493
10900
  readonly summary: "Expression search";
9494
- readonly description: "Search active assets using the supported filter-expression syntax, sorting and cursor pagination. Empty expression matches all assets. Tags and context require with_field; inspect the exactness flags before treating counts as complete.";
10901
+ readonly description: "Find visually similar assets using exactly one of asset_id or an inline base64 image. The library must support image search; an asset query needs a current image embedding and excludes that source asset from results.";
9495
10902
  readonly http: "POST";
9496
10903
  readonly path: "/media/v1/libraries/{library_id}/search/expression";
9497
10904
  readonly streaming: "no";
@@ -9508,7 +10915,7 @@ export declare const operations: readonly [{
9508
10915
  readonly name: "expression";
9509
10916
  readonly type: "string";
9510
10917
  readonly required: false;
9511
- readonly description: "Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: [\"context\"] to include context.";
10918
+ readonly description: "Asset filter expression supporting field comparisons, AND, OR, NOT, parentheses and suffix wildcards. An empty expression matches all assets. For business metadata use context.sku=KETTLE-RED AND context.revision=2; request with_field: [\"context\"] to include context. Quality filters: flags:watermark matches any current shot with a watermark; flags.watermark:false requires an assessed video with no positive watermark judgment. The same syntax supports slideshow, hand_frame, text_sticker and low_quality. folder_mismatch:true selects lexical folder/location hints. Geometry filters support width, height, resolution:1920x1080, numeric aspect_ratio (width/height), and orientation:landscape, portrait or square. Missing geometry or unassessed legacy flags do not match positive filters. has_music:true AND audio_genre:jazz AND audio_mood:calm selects current-version audio profiles with music and matching model labels; has_music:false applies only to sampled ranges, not the entire source. failure_code=UPSTREAM_FAILED selects assets with a current failed understanding carrying that code; combine with processing_state=failed or processing_state=partial.";
9512
10919
  }, {
9513
10920
  readonly name: "sort_by";
9514
10921
  readonly type: "array";
@@ -9545,7 +10952,7 @@ export declare const operations: readonly [{
9545
10952
  readonly resource: "media.libraries.search.semantic";
9546
10953
  readonly method: "create";
9547
10954
  readonly summary: "Semantic search";
9548
- readonly description: "Search assets with a nonblank text query and optional expression filter. Hybrid mode combines semantic and keyword matches; semantic mode uses vector similarity only. Results are ranked and limited by top_k.";
10955
+ readonly description: "Alias of semantic search. Search assets with a nonblank text query, optional expression filter and top_k; hybrid combines semantic and keyword matches, while semantic uses vector similarity only.";
9549
10956
  readonly http: "POST";
9550
10957
  readonly path: "/media/v1/libraries/{library_id}/search/semantic";
9551
10958
  readonly streaming: "no";
@@ -9585,7 +10992,7 @@ export declare const operations: readonly [{
9585
10992
  readonly resource: "media.libraries.search.visual";
9586
10993
  readonly method: "create";
9587
10994
  readonly summary: "Visual search";
9588
- readonly description: "Find visually similar assets using exactly one of asset_id or an inline base64 image. The library must support image search; an asset query needs a current image embedding and excludes that source asset from results.";
10995
+ readonly description: "Search assets with a nonblank text query and optional expression filter. Hybrid mode combines semantic and keyword matches; semantic mode uses vector similarity only. Results are ranked and limited by top_k.";
9589
10996
  readonly http: "POST";
9590
10997
  readonly path: "/media/v1/libraries/{library_id}/search/visual";
9591
10998
  readonly streaming: "no";
@@ -9620,6 +11027,56 @@ export declare const operations: readonly [{
9620
11027
  readonly description: "Expression filter restricting eligible result assets.";
9621
11028
  }];
9622
11029
  };
11030
+ }, {
11031
+ readonly resource: "media.libraries.understandings";
11032
+ readonly method: "list";
11033
+ readonly summary: "List understanding results across a library";
11034
+ readonly description: "Read current understanding entries across one library without fetching every asset separately. Use library_id from creation or listing. folder includes descendants; kinds is a comma-separated list of output kinds. Entries are ordered by asset_id and then understanding id. Continue with next_cursor and the same folder and kinds; limit defaults to 100 and cannot exceed 100. Superseded, deleted and old-version entries are excluded. During historical backfill, this method returns 503 CAPACITY rather than incomplete pages; poll failureSummary until counts_complete is true, then start pagination. Example: GET /media/v1/libraries/lib_example/understandings?folder=travel&kinds=caption,transcript&limit=100.";
11035
+ readonly http: "GET";
11036
+ readonly path: "/media/v1/libraries/{library_id}/understandings";
11037
+ readonly streaming: "no";
11038
+ readonly pagination: true;
11039
+ readonly pathParams: readonly [{
11040
+ readonly name: "library_id";
11041
+ readonly sdkName: "library_id";
11042
+ readonly description: "Library ID returned by creation.";
11043
+ }];
11044
+ readonly query: readonly [{
11045
+ readonly name: "folder";
11046
+ readonly type: "string";
11047
+ readonly required: false;
11048
+ readonly description: "Folder path including all descendants; omitted or empty selects the entire library.";
11049
+ }, {
11050
+ readonly name: "kinds";
11051
+ readonly type: "string";
11052
+ readonly required: false;
11053
+ readonly description: "Comma-separated output kinds: caption, tags, ocr, frame, transcript, overview, audio, embedding. Omit or empty to include every kind.";
11054
+ }, {
11055
+ readonly name: "cursor";
11056
+ readonly type: "string";
11057
+ readonly required: false;
11058
+ readonly description: "Cursor from the previous next_cursor.";
11059
+ }, {
11060
+ readonly name: "limit";
11061
+ readonly type: "integer";
11062
+ readonly required: false;
11063
+ readonly description: "Maximum entries in this page, from 1 through 100; defaults to 100.";
11064
+ }];
11065
+ }, {
11066
+ readonly resource: "media.libraries.understandings";
11067
+ readonly method: "retrieveFailureSummary";
11068
+ readonly summary: "Summarize understanding failures";
11069
+ readonly description: "Inspect current understanding failures before retrying. Use library_id from library creation or listing. Groups include code, output kind, actual producer model, retryability and up to five sample asset IDs. At most 1024 detailed groups plus two overflow groups are returned; overflow groups separate retryable and unrecoverable entries and mark overflow=true. Unknown failure codes remain retryable. Historical counts are provisional while counts_complete is false. Example: GET /media/v1/libraries/lib_example/understandings/failure_summary.";
11070
+ readonly http: "GET";
11071
+ readonly path: "/media/v1/libraries/{library_id}/understandings/failure_summary";
11072
+ readonly streaming: "no";
11073
+ readonly pagination: false;
11074
+ readonly pathParams: readonly [{
11075
+ readonly name: "library_id";
11076
+ readonly sdkName: "library_id";
11077
+ readonly description: "Library ID returned by creation.";
11078
+ }];
11079
+ readonly query: readonly [];
9623
11080
  }, {
9624
11081
  readonly resource: "meta.docs";
9625
11082
  readonly method: "search";
@@ -9833,35 +11290,35 @@ export declare const operations: readonly [{
9833
11290
  readonly name: "model";
9834
11291
  readonly type: "string";
9835
11292
  readonly required: true;
9836
- readonly description: "Transcription model id, for example `whisper-large-v3-turbo` or `qwen3-asr-flash`; list candidates with listModels?type=transcription. Router support (supported): Verified to take effect.";
11293
+ readonly description: "Model catalog identifier declaring openai.audio.transcriptions; use it unchanged, including any creator prefix.";
9837
11294
  }, {
9838
11295
  readonly name: "file";
9839
11296
  readonly type: "string";
9840
11297
  readonly required: true;
9841
- readonly description: "Audio file to transcribe, uploaded as multipart/form-data. Router support (supported): Verified to take effect.";
11298
+ readonly description: "Audio bytes uploaded as a multipart file; supported formats and input limits depend on the selected model.";
9842
11299
  }, {
9843
11300
  readonly name: "language";
9844
11301
  readonly type: "string";
9845
11302
  readonly required: false;
9846
- readonly description: "Language of the audio as an ISO-639-1 code such as `en` or `zh`. Router support (partial): Both models accept ISO language codes. qwen3-asr-flash may translate output to that language; whisper-large-v3-turbo treats it as an input hint. Non-ISO names may return 502.";
11303
+ readonly description: "Source language code when known; omit to let the model detect the language.";
9847
11304
  }, {
9848
11305
  readonly name: "prompt";
9849
11306
  readonly type: "string";
9850
11307
  readonly required: false;
9851
- readonly description: "Text that primes the model with vocabulary or context. Router support (partial): Vocabulary hints work on whisper-large-v3-turbo only; qwen3-asr-flash returns 400.";
11308
+ readonly description: "Optional vocabulary or contextual guidance for recognizing the audio; support depends on the selected model.";
9852
11309
  }, {
9853
11310
  readonly name: "response_format";
9854
11311
  readonly type: "string";
9855
- readonly enum: readonly ["json", "text", "verbose_json"];
11312
+ readonly enum: readonly ["json", "text", "verbose_json", "diarized_json"];
9856
11313
  readonly required: false;
9857
- readonly description: "Format of the response body. `json` and `text` are the commonly supported formats. Router support (partial): json/text work on both; verbose_json works only on whisper-large-v3-turbo. srt/vtt return 400.";
11314
+ readonly description: "Output format: json returns text in JSON; text returns plain text; verbose_json includes requested timestamps; diarized_json includes speaker-labelled segments when supported. Defaults to json.";
9858
11315
  }, {
9859
11316
  readonly name: "timestamp_granularities[]";
9860
11317
  readonly type: "array";
9861
11318
  readonly itemType: "string";
9862
- readonly enum: readonly ["segment"];
11319
+ readonly enum: readonly ["word", "segment"];
9863
11320
  readonly required: false;
9864
- readonly description: "Timestamp levels to include with `verbose_json`; only `segment` exists in this schema. Router support (partial): Only whisper-large-v3-turbo supports segment with verbose_json. word returns 400; qwen3-asr-flash does not support timestamps.";
11321
+ readonly description: "Timestamp levels to request as repeated multipart fields: word returns per-word times; segment returns segment times. Omit for the model default. Use verbose_json, or diarized_json on supporting models.";
9865
11322
  }, {
9866
11323
  readonly name: "temperature";
9867
11324
  readonly type: "number";
@@ -11721,6 +13178,27 @@ export declare const operations: readonly [{
11721
13178
  readonly description: "Up to five attachments; decoded bytes must not exceed 10 MiB each or 20 MiB in total.";
11722
13179
  }];
11723
13180
  };
13181
+ }, {
13182
+ readonly resource: "organization.members";
13183
+ readonly method: "list";
13184
+ readonly summary: "List organization members";
13185
+ readonly description: "Concepts follow GitHub org members: find a person's user id, for example to assign an approver to an approval task. Lists only members of the organization behind your API key or runtime token, ordered by joined_at ascending (membership id breaks ties). Ask the user who should approve, then use that member's id. Emails are visible only within this organization. The request cannot select another organization. Pass next_page unchanged as page; null means the end. Read-only; no usage charge. Example: GET /organization/v1/members?limit=20.";
13186
+ readonly http: "GET";
13187
+ readonly path: "/organization/v1/members";
13188
+ readonly streaming: "no";
13189
+ readonly pagination: false;
13190
+ readonly pathParams: readonly [];
13191
+ readonly query: readonly [{
13192
+ readonly name: "limit";
13193
+ readonly type: "integer";
13194
+ readonly required: false;
13195
+ readonly description: "Maximum members per page, from 1 to 100; defaults to 20.";
13196
+ }, {
13197
+ readonly name: "page";
13198
+ readonly type: "string";
13199
+ readonly required: false;
13200
+ readonly description: "Opaque next_page cursor returned by the previous response; omit for the first page.";
13201
+ }];
11724
13202
  }, {
11725
13203
  readonly resource: "organization.usage";
11726
13204
  readonly method: "list";
@@ -13752,7 +15230,7 @@ export declare const operations: readonly [{
13752
15230
  readonly name: "filter";
13753
15231
  readonly type: "string";
13754
15232
  readonly required: false;
13755
- readonly description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort; unknown qualifiers return INVALID_PARAMS. Passed unchanged to the service.";
15233
+ readonly description: "Search qualifier subset: is/state, reason, label/-label, no, assignee, author, mentions, milestone, type, kind, assignee-kind, in and sort; write each qualifier as field:value (for example, is:open milestone:5), never field=value. Unknown qualifiers return INVALID_PARAMS. Passed unchanged to the service.";
13756
15234
  }];
13757
15235
  }, {
13758
15236
  readonly resource: "ticket.tickets";