@deepraxis/sdk 0.1.1-dev.de0a917 → 0.1.1-dev.e5614a0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/METHODS.md +113 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +217 -1
- package/dist/generated/sdk.gen.js +590 -0
- package/dist/generated/types.gen.d.ts +31762 -28101
- package/dist/operations.generated.d.ts +1346 -0
- package/dist/operations.generated.js +1711 -0
- package/dist/resources.generated.d.ts +61 -0
- package/dist/resources.generated.js +63 -0
- package/package.json +1 -1
|
@@ -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";
|