getricky 0.1.18 → 0.1.20

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.
@@ -498,7 +498,7 @@ export declare class RickyApi extends HeyApiClient {
498
498
  /**
499
499
  * Set the AI agent of a conversation
500
500
  *
501
- * Makes an agent answer the conversation, or turns the AI off with `null`. Either way the conversation is no longer assigned to a member; the contact owner stays.
501
+ * Makes an agent answer the conversation, or turns the AI off with `null`. Either way the conversation is no longer assigned to a member.
502
502
  *
503
503
  * Scope: `conversations:write`.
504
504
  */
@@ -930,7 +930,7 @@ export declare class RickyApi extends HeyApiClient {
930
930
  /**
931
931
  * Assign many conversations
932
932
  *
933
- * Makes members responsible for up to 100 conversations, as assigning each one does, and answers one result per conversation, in order. Each member also becomes the contact's owner. A member outside the organization refuses the whole request before any conversation changes.
933
+ * Makes members responsible for up to 100 conversations, as assigning each one does, and answers one result per conversation, in order. A member outside the organization refuses the whole request before any conversation changes.
934
934
  *
935
935
  * Scope: `conversations:write`.
936
936
  */
@@ -966,7 +966,7 @@ class RickyApi extends HeyApiClient {
966
966
  /**
967
967
  * Set the AI agent of a conversation
968
968
  *
969
- * Makes an agent answer the conversation, or turns the AI off with `null`. Either way the conversation is no longer assigned to a member; the contact owner stays.
969
+ * Makes an agent answer the conversation, or turns the AI off with `null`. Either way the conversation is no longer assigned to a member.
970
970
  *
971
971
  * Scope: `conversations:write`.
972
972
  */
@@ -1876,7 +1876,7 @@ class RickyApi extends HeyApiClient {
1876
1876
  /**
1877
1877
  * Assign many conversations
1878
1878
  *
1879
- * Makes members responsible for up to 100 conversations, as assigning each one does, and answers one result per conversation, in order. Each member also becomes the contact's owner. A member outside the organization refuses the whole request before any conversation changes.
1879
+ * Makes members responsible for up to 100 conversations, as assigning each one does, and answers one result per conversation, in order. A member outside the organization refuses the whole request before any conversation changes.
1880
1880
  *
1881
1881
  * Scope: `conversations:write`.
1882
1882
  */
@@ -553,15 +553,16 @@ export type Contact = {
553
553
  * Free-form notes.
554
554
  */
555
555
  notes: string | null;
556
+ /**
557
+ * Deprecated: contacts no longer have an owner; the member responsible is each conversation's `assigned_user_id`. Always `null`.
558
+ *
559
+ * @deprecated
560
+ */
556
561
  owner_user_id: string | null;
557
562
  /**
558
563
  * Sales lead status.
559
564
  */
560
565
  lead_status: 'new' | 'open' | 'in_progress' | 'attempted' | 'connected' | 'unqualified' | 'bad_timing' | null;
561
- /**
562
- * Lifecycle stage.
563
- */
564
- lifecycle_stage: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other' | null;
565
566
  /**
566
567
  * Custom field values keyed by contact field ID. See `GET /contact-fields`.
567
568
  */
@@ -945,10 +946,6 @@ export type Broadcast = {
945
946
  audience: {
946
947
  type: 'filter';
947
948
  tag_id: string | null;
948
- /**
949
- * Only contacts at this stage; null for any.
950
- */
951
- lifecycle_stage: string | null;
952
949
  /**
953
950
  * Only contacts whose name, phone, email or company contains it.
954
951
  */
@@ -3130,7 +3127,7 @@ export type TemplateFieldMappings = {
3130
3127
  /**
3131
3128
  * A field every contact has.
3132
3129
  */
3133
- field: 'first_name' | 'last_name' | 'primary_phone' | 'primary_email' | 'company' | 'job_title' | 'birthday' | 'street_address' | 'city' | 'region' | 'postal_code' | 'country' | 'website_url' | 'linkedin_url' | 'lifecycle_stage' | 'lead_status' | 'source' | 'notes';
3130
+ field: 'first_name' | 'last_name' | 'primary_phone' | 'primary_email' | 'company' | 'job_title' | 'birthday' | 'street_address' | 'city' | 'region' | 'postal_code' | 'country' | 'website_url' | 'linkedin_url' | 'lead_status' | 'source' | 'notes';
3134
3131
  } | {
3135
3132
  kind: 'custom';
3136
3133
  /**
@@ -3371,7 +3368,7 @@ export type ResolveHandoff = {
3371
3368
  resolution: 'returned_to_ai' | 'stayed_with_human';
3372
3369
  };
3373
3370
  /**
3374
- * Makes members responsible for many conversations at once. Each member also becomes the contact's owner.
3371
+ * Makes members responsible for many conversations at once.
3375
3372
  */
3376
3373
  export type AssignConversations = {
3377
3374
  /**
@@ -3457,11 +3454,12 @@ export type CreateContact = {
3457
3454
  */
3458
3455
  notes?: string | null;
3459
3456
  /**
3460
- * Member who owns the contact.
3457
+ * Deprecated: contacts no longer have an owner. Accepted and ignored.
3458
+ *
3459
+ * @deprecated
3461
3460
  */
3462
3461
  owner_user_id?: string | null;
3463
3462
  lead_status?: 'new' | 'open' | 'in_progress' | 'attempted' | 'connected' | 'unqualified' | 'bad_timing' | null;
3464
- lifecycle_stage?: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other' | null;
3465
3463
  /**
3466
3464
  * Values keyed by contact field ID. Keys you omit keep their value.
3467
3465
  */
@@ -3542,11 +3540,12 @@ export type UpdateContact = {
3542
3540
  */
3543
3541
  notes?: string | null;
3544
3542
  /**
3545
- * Member who owns the contact.
3543
+ * Deprecated: contacts no longer have an owner. Accepted and ignored.
3544
+ *
3545
+ * @deprecated
3546
3546
  */
3547
3547
  owner_user_id?: string | null;
3548
3548
  lead_status?: 'new' | 'open' | 'in_progress' | 'attempted' | 'connected' | 'unqualified' | 'bad_timing' | null;
3549
- lifecycle_stage?: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other' | null;
3550
3549
  /**
3551
3550
  * Values keyed by contact field ID. Keys you omit keep their value.
3552
3551
  */
@@ -3697,7 +3696,9 @@ export type AssignConversation = {
3697
3696
  */
3698
3697
  assigned_user_id: string | null;
3699
3698
  /**
3700
- * Also make that member the contact owner.
3699
+ * Deprecated: contacts no longer have an owner. Accepted and ignored.
3700
+ *
3701
+ * @deprecated
3701
3702
  */
3702
3703
  sync_contact_owner?: boolean;
3703
3704
  };
@@ -3754,10 +3755,6 @@ export type CreateBroadcast = {
3754
3755
  * Only contacts with this tag.
3755
3756
  */
3756
3757
  tag_id?: string;
3757
- /**
3758
- * Only contacts at this stage.
3759
- */
3760
- lifecycle_stage?: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other';
3761
3758
  /**
3762
3759
  * Only contacts whose name, phone, email or company contains it.
3763
3760
  */
@@ -3795,7 +3792,7 @@ export type CreateBroadcast = {
3795
3792
  /**
3796
3793
  * A field of the contact.
3797
3794
  */
3798
- field: 'birthday' | 'city' | 'company' | 'country' | 'first_name' | 'job_title' | 'last_name' | 'lead_status' | 'lifecycle_stage' | 'linkedin_url' | 'notes' | 'postal_code' | 'primary_email' | 'primary_phone' | 'region' | 'source' | 'street_address' | 'website_url';
3795
+ field: 'birthday' | 'city' | 'company' | 'country' | 'first_name' | 'job_title' | 'last_name' | 'lead_status' | 'linkedin_url' | 'notes' | 'postal_code' | 'primary_email' | 'primary_phone' | 'region' | 'source' | 'street_address' | 'website_url';
3799
3796
  } | {
3800
3797
  type: 'custom_field';
3801
3798
  /**
@@ -3822,10 +3819,6 @@ export type PreviewBroadcastAudience = {
3822
3819
  * Only contacts with this tag.
3823
3820
  */
3824
3821
  tag_id?: string;
3825
- /**
3826
- * Only contacts at this stage.
3827
- */
3828
- lifecycle_stage?: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other';
3829
3822
  /**
3830
3823
  * Only contacts whose name, phone, email or company contains it.
3831
3824
  */
@@ -4719,7 +4712,7 @@ export type ReplaceTemplateFieldMappings = {
4719
4712
  /**
4720
4713
  * A field every contact has.
4721
4714
  */
4722
- field: 'first_name' | 'last_name' | 'primary_phone' | 'primary_email' | 'company' | 'job_title' | 'birthday' | 'street_address' | 'city' | 'region' | 'postal_code' | 'country' | 'website_url' | 'linkedin_url' | 'lifecycle_stage' | 'lead_status' | 'source' | 'notes';
4715
+ field: 'first_name' | 'last_name' | 'primary_phone' | 'primary_email' | 'company' | 'job_title' | 'birthday' | 'street_address' | 'city' | 'region' | 'postal_code' | 'country' | 'website_url' | 'linkedin_url' | 'lead_status' | 'source' | 'notes';
4723
4716
  } | {
4724
4717
  kind: 'custom';
4725
4718
  /**
@@ -5116,13 +5109,11 @@ export type ListContactsData = {
5116
5109
  */
5117
5110
  tag_id?: string;
5118
5111
  /**
5119
- * Only contacts this member owns.
5112
+ * Deprecated: contacts no longer have an owner, so no contact matches.
5113
+ *
5114
+ * @deprecated
5120
5115
  */
5121
5116
  owner_user_id?: string;
5122
- /**
5123
- * Only contacts at this stage.
5124
- */
5125
- lifecycle_stage?: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other';
5126
5117
  /**
5127
5118
  * Only contacts reachable on this channel.
5128
5119
  */
@@ -498,7 +498,7 @@ export declare class RickyApi extends HeyApiClient {
498
498
  /**
499
499
  * Set the AI agent of a conversation
500
500
  *
501
- * Makes an agent answer the conversation, or turns the AI off with `null`. Either way the conversation is no longer assigned to a member; the contact owner stays.
501
+ * Makes an agent answer the conversation, or turns the AI off with `null`. Either way the conversation is no longer assigned to a member.
502
502
  *
503
503
  * Scope: `conversations:write`.
504
504
  */
@@ -930,7 +930,7 @@ export declare class RickyApi extends HeyApiClient {
930
930
  /**
931
931
  * Assign many conversations
932
932
  *
933
- * Makes members responsible for up to 100 conversations, as assigning each one does, and answers one result per conversation, in order. Each member also becomes the contact's owner. A member outside the organization refuses the whole request before any conversation changes.
933
+ * Makes members responsible for up to 100 conversations, as assigning each one does, and answers one result per conversation, in order. A member outside the organization refuses the whole request before any conversation changes.
934
934
  *
935
935
  * Scope: `conversations:write`.
936
936
  */
@@ -963,7 +963,7 @@ export class RickyApi extends HeyApiClient {
963
963
  /**
964
964
  * Set the AI agent of a conversation
965
965
  *
966
- * Makes an agent answer the conversation, or turns the AI off with `null`. Either way the conversation is no longer assigned to a member; the contact owner stays.
966
+ * Makes an agent answer the conversation, or turns the AI off with `null`. Either way the conversation is no longer assigned to a member.
967
967
  *
968
968
  * Scope: `conversations:write`.
969
969
  */
@@ -1873,7 +1873,7 @@ export class RickyApi extends HeyApiClient {
1873
1873
  /**
1874
1874
  * Assign many conversations
1875
1875
  *
1876
- * Makes members responsible for up to 100 conversations, as assigning each one does, and answers one result per conversation, in order. Each member also becomes the contact's owner. A member outside the organization refuses the whole request before any conversation changes.
1876
+ * Makes members responsible for up to 100 conversations, as assigning each one does, and answers one result per conversation, in order. A member outside the organization refuses the whole request before any conversation changes.
1877
1877
  *
1878
1878
  * Scope: `conversations:write`.
1879
1879
  */
@@ -553,15 +553,16 @@ export type Contact = {
553
553
  * Free-form notes.
554
554
  */
555
555
  notes: string | null;
556
+ /**
557
+ * Deprecated: contacts no longer have an owner; the member responsible is each conversation's `assigned_user_id`. Always `null`.
558
+ *
559
+ * @deprecated
560
+ */
556
561
  owner_user_id: string | null;
557
562
  /**
558
563
  * Sales lead status.
559
564
  */
560
565
  lead_status: 'new' | 'open' | 'in_progress' | 'attempted' | 'connected' | 'unqualified' | 'bad_timing' | null;
561
- /**
562
- * Lifecycle stage.
563
- */
564
- lifecycle_stage: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other' | null;
565
566
  /**
566
567
  * Custom field values keyed by contact field ID. See `GET /contact-fields`.
567
568
  */
@@ -945,10 +946,6 @@ export type Broadcast = {
945
946
  audience: {
946
947
  type: 'filter';
947
948
  tag_id: string | null;
948
- /**
949
- * Only contacts at this stage; null for any.
950
- */
951
- lifecycle_stage: string | null;
952
949
  /**
953
950
  * Only contacts whose name, phone, email or company contains it.
954
951
  */
@@ -3130,7 +3127,7 @@ export type TemplateFieldMappings = {
3130
3127
  /**
3131
3128
  * A field every contact has.
3132
3129
  */
3133
- field: 'first_name' | 'last_name' | 'primary_phone' | 'primary_email' | 'company' | 'job_title' | 'birthday' | 'street_address' | 'city' | 'region' | 'postal_code' | 'country' | 'website_url' | 'linkedin_url' | 'lifecycle_stage' | 'lead_status' | 'source' | 'notes';
3130
+ field: 'first_name' | 'last_name' | 'primary_phone' | 'primary_email' | 'company' | 'job_title' | 'birthday' | 'street_address' | 'city' | 'region' | 'postal_code' | 'country' | 'website_url' | 'linkedin_url' | 'lead_status' | 'source' | 'notes';
3134
3131
  } | {
3135
3132
  kind: 'custom';
3136
3133
  /**
@@ -3371,7 +3368,7 @@ export type ResolveHandoff = {
3371
3368
  resolution: 'returned_to_ai' | 'stayed_with_human';
3372
3369
  };
3373
3370
  /**
3374
- * Makes members responsible for many conversations at once. Each member also becomes the contact's owner.
3371
+ * Makes members responsible for many conversations at once.
3375
3372
  */
3376
3373
  export type AssignConversations = {
3377
3374
  /**
@@ -3457,11 +3454,12 @@ export type CreateContact = {
3457
3454
  */
3458
3455
  notes?: string | null;
3459
3456
  /**
3460
- * Member who owns the contact.
3457
+ * Deprecated: contacts no longer have an owner. Accepted and ignored.
3458
+ *
3459
+ * @deprecated
3461
3460
  */
3462
3461
  owner_user_id?: string | null;
3463
3462
  lead_status?: 'new' | 'open' | 'in_progress' | 'attempted' | 'connected' | 'unqualified' | 'bad_timing' | null;
3464
- lifecycle_stage?: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other' | null;
3465
3463
  /**
3466
3464
  * Values keyed by contact field ID. Keys you omit keep their value.
3467
3465
  */
@@ -3542,11 +3540,12 @@ export type UpdateContact = {
3542
3540
  */
3543
3541
  notes?: string | null;
3544
3542
  /**
3545
- * Member who owns the contact.
3543
+ * Deprecated: contacts no longer have an owner. Accepted and ignored.
3544
+ *
3545
+ * @deprecated
3546
3546
  */
3547
3547
  owner_user_id?: string | null;
3548
3548
  lead_status?: 'new' | 'open' | 'in_progress' | 'attempted' | 'connected' | 'unqualified' | 'bad_timing' | null;
3549
- lifecycle_stage?: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other' | null;
3550
3549
  /**
3551
3550
  * Values keyed by contact field ID. Keys you omit keep their value.
3552
3551
  */
@@ -3697,7 +3696,9 @@ export type AssignConversation = {
3697
3696
  */
3698
3697
  assigned_user_id: string | null;
3699
3698
  /**
3700
- * Also make that member the contact owner.
3699
+ * Deprecated: contacts no longer have an owner. Accepted and ignored.
3700
+ *
3701
+ * @deprecated
3701
3702
  */
3702
3703
  sync_contact_owner?: boolean;
3703
3704
  };
@@ -3754,10 +3755,6 @@ export type CreateBroadcast = {
3754
3755
  * Only contacts with this tag.
3755
3756
  */
3756
3757
  tag_id?: string;
3757
- /**
3758
- * Only contacts at this stage.
3759
- */
3760
- lifecycle_stage?: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other';
3761
3758
  /**
3762
3759
  * Only contacts whose name, phone, email or company contains it.
3763
3760
  */
@@ -3795,7 +3792,7 @@ export type CreateBroadcast = {
3795
3792
  /**
3796
3793
  * A field of the contact.
3797
3794
  */
3798
- field: 'birthday' | 'city' | 'company' | 'country' | 'first_name' | 'job_title' | 'last_name' | 'lead_status' | 'lifecycle_stage' | 'linkedin_url' | 'notes' | 'postal_code' | 'primary_email' | 'primary_phone' | 'region' | 'source' | 'street_address' | 'website_url';
3795
+ field: 'birthday' | 'city' | 'company' | 'country' | 'first_name' | 'job_title' | 'last_name' | 'lead_status' | 'linkedin_url' | 'notes' | 'postal_code' | 'primary_email' | 'primary_phone' | 'region' | 'source' | 'street_address' | 'website_url';
3799
3796
  } | {
3800
3797
  type: 'custom_field';
3801
3798
  /**
@@ -3822,10 +3819,6 @@ export type PreviewBroadcastAudience = {
3822
3819
  * Only contacts with this tag.
3823
3820
  */
3824
3821
  tag_id?: string;
3825
- /**
3826
- * Only contacts at this stage.
3827
- */
3828
- lifecycle_stage?: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other';
3829
3822
  /**
3830
3823
  * Only contacts whose name, phone, email or company contains it.
3831
3824
  */
@@ -4719,7 +4712,7 @@ export type ReplaceTemplateFieldMappings = {
4719
4712
  /**
4720
4713
  * A field every contact has.
4721
4714
  */
4722
- field: 'first_name' | 'last_name' | 'primary_phone' | 'primary_email' | 'company' | 'job_title' | 'birthday' | 'street_address' | 'city' | 'region' | 'postal_code' | 'country' | 'website_url' | 'linkedin_url' | 'lifecycle_stage' | 'lead_status' | 'source' | 'notes';
4715
+ field: 'first_name' | 'last_name' | 'primary_phone' | 'primary_email' | 'company' | 'job_title' | 'birthday' | 'street_address' | 'city' | 'region' | 'postal_code' | 'country' | 'website_url' | 'linkedin_url' | 'lead_status' | 'source' | 'notes';
4723
4716
  } | {
4724
4717
  kind: 'custom';
4725
4718
  /**
@@ -5116,13 +5109,11 @@ export type ListContactsData = {
5116
5109
  */
5117
5110
  tag_id?: string;
5118
5111
  /**
5119
- * Only contacts this member owns.
5112
+ * Deprecated: contacts no longer have an owner, so no contact matches.
5113
+ *
5114
+ * @deprecated
5120
5115
  */
5121
5116
  owner_user_id?: string;
5122
- /**
5123
- * Only contacts at this stage.
5124
- */
5125
- lifecycle_stage?: 'subscriber' | 'lead' | 'marketing_qualified' | 'sales_qualified' | 'opportunity' | 'customer' | 'evangelist' | 'other';
5126
5117
  /**
5127
5118
  * Only contacts reachable on this channel.
5128
5119
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "getricky",
3
- "version": "0.1.18",
3
+ "version": "0.1.20",
4
4
  "description": "Official TypeScript SDK for the Ricky REST API",
5
5
  "keywords": [
6
6
  "api",