@talqing/sdk 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,39 @@
1
1
  export type ClientOptions = {
2
2
  baseUrl: `${string}://${string}` | (string & {});
3
3
  };
4
+ /**
5
+ * AddEmailRecipientsRequest
6
+ */
7
+ export type AddEmailRecipientsRequest = {
8
+ /**
9
+ * Recipients
10
+ */
11
+ recipients: Array<EmailRecipientInput>;
12
+ };
13
+ /**
14
+ * AddEmailRecipientsResponse
15
+ *
16
+ * `standing_send_id` is the send of every row that will mail the new rows
17
+ * without review, or null when they wait for review.
18
+ */
19
+ export type AddEmailRecipientsResponse = {
20
+ /**
21
+ * Added
22
+ */
23
+ added: number;
24
+ /**
25
+ * Skipped
26
+ */
27
+ skipped: Array<SkippedEmailRecipient>;
28
+ /**
29
+ * Standing Send Id
30
+ */
31
+ standing_send_id: string | null;
32
+ /**
33
+ * Total Recipients
34
+ */
35
+ total_recipients: number;
36
+ };
4
37
  /**
5
38
  * AddMessageConfig
6
39
  */
@@ -38,9 +71,10 @@ export type AddRecipientsRequest = {
38
71
  *
39
72
  * What appending to a batch did.
40
73
  *
41
- * Numbers already in the batch are skipped and reported rather than rejected:
42
- * re-uploading a list the operator re-exported is the normal case, and the
43
- * never-call-twice guarantee doing its job is not a user error.
74
+ * Numbers already in the batch, or repeated in the request, are skipped and
75
+ * reported rather than rejected: re-uploading a list the operator re-exported
76
+ * is the normal case, and the never-call-twice guarantee doing its job is not a
77
+ * user error.
44
78
  */
45
79
  export type AddRecipientsResponse = {
46
80
  /**
@@ -82,6 +116,32 @@ export type AddVoiceResponse = {
82
116
  */
83
117
  voice_id: string;
84
118
  };
119
+ /**
120
+ * AddWhatsAppRecipientsRequest
121
+ */
122
+ export type AddWhatsAppRecipientsRequest = {
123
+ /**
124
+ * Recipients
125
+ */
126
+ recipients: Array<WhatsAppRecipientInput>;
127
+ };
128
+ /**
129
+ * AddWhatsAppRecipientsResponse
130
+ */
131
+ export type AddWhatsAppRecipientsResponse = {
132
+ /**
133
+ * Added
134
+ */
135
+ added: number;
136
+ /**
137
+ * Skipped
138
+ */
139
+ skipped: Array<SkippedWhatsAppRecipient>;
140
+ /**
141
+ * Total Recipients
142
+ */
143
+ total_recipients: number;
144
+ };
85
145
  /**
86
146
  * AgentConfig
87
147
  *
@@ -7600,7 +7660,7 @@ export type PageWhatsAppRecipientResponse = {
7600
7660
  /**
7601
7661
  * PatchCallBatchRequest
7602
7662
  *
7603
- * Policy edits, allowed while a batch is `scheduled`, `running` or `paused`.
7663
+ * Policy edits, allowed while a batch is `scheduled`, `running`, `paused` or `completed`.
7604
7664
  *
7605
7665
  * ``calling_window`` and ``start_at`` accept an explicit ``null`` to *clear*
7606
7666
  * them — "dial at any hour", "start on the next pass" — which is why the
@@ -9886,6 +9946,26 @@ export type SilenceSpecOverride = {
9886
9946
  */
9887
9947
  timeout?: number | null;
9888
9948
  };
9949
+ /**
9950
+ * SkippedEmailRecipient
9951
+ *
9952
+ * A row of the request that will not be drafted. `row_number` is its 1-based
9953
+ * position in the request; `recipient_id` is null when it was not stored.
9954
+ */
9955
+ export type SkippedEmailRecipient = {
9956
+ /**
9957
+ * Reason
9958
+ */
9959
+ reason: string;
9960
+ /**
9961
+ * Recipient Id
9962
+ */
9963
+ recipient_id: string | null;
9964
+ /**
9965
+ * Row Number
9966
+ */
9967
+ row_number: number;
9968
+ };
9889
9969
  /**
9890
9970
  * SkippedRecipient
9891
9971
  */
@@ -9903,6 +9983,26 @@ export type SkippedRecipient = {
9903
9983
  */
9904
9984
  to: string;
9905
9985
  };
9986
+ /**
9987
+ * SkippedWhatsAppRecipient
9988
+ *
9989
+ * A row of the request that will not be sent. `row_number` is its 1-based
9990
+ * position in the request; `recipient_id` is null when it was not stored.
9991
+ */
9992
+ export type SkippedWhatsAppRecipient = {
9993
+ /**
9994
+ * Reason
9995
+ */
9996
+ reason: string;
9997
+ /**
9998
+ * Recipient Id
9999
+ */
10000
+ recipient_id: string | null;
10001
+ /**
10002
+ * Row Number
10003
+ */
10004
+ row_number: number;
10005
+ };
9906
10006
  /**
9907
10007
  * StoredAgentPlan
9908
10008
  *
@@ -15965,6 +16065,55 @@ export type EmailBatchesRecipientsListResults = {
15965
16065
  200: PageEmailRecipientResponse;
15966
16066
  };
15967
16067
  export type EmailBatchesRecipientsListResult = EmailBatchesRecipientsListResults[keyof EmailBatchesRecipientsListResults];
16068
+ export type EmailBatchesRecipientsAddData = {
16069
+ body: AddEmailRecipientsRequest;
16070
+ path: {
16071
+ /**
16072
+ * Batch Id
16073
+ */
16074
+ batch_id: string;
16075
+ };
16076
+ query?: never;
16077
+ url: '/v1/email/batches/{batch_id}/recipients';
16078
+ };
16079
+ export type EmailBatchesRecipientsAddErrors = {
16080
+ /**
16081
+ * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
16082
+ */
16083
+ 400: ErrorResponse;
16084
+ /**
16085
+ * Missing credential, or one that is revoked or no longer a member of this organization.
16086
+ */
16087
+ 401: ErrorResponse;
16088
+ /**
16089
+ * Authenticated, but this organization role may not perform the operation.
16090
+ */
16091
+ 403: ErrorResponse;
16092
+ /**
16093
+ * No such resource in this organization.
16094
+ */
16095
+ 404: ErrorResponse;
16096
+ /**
16097
+ * The resource's current state forbids this — a name already taken, a job already running.
16098
+ */
16099
+ 409: ErrorResponse;
16100
+ /**
16101
+ * The request did not match this operation's schema; `detail.errors` lists each field.
16102
+ */
16103
+ 422: ErrorResponse;
16104
+ /**
16105
+ * Unexpected error. Every error this API returns carries this body.
16106
+ */
16107
+ default: ErrorResponse;
16108
+ };
16109
+ export type EmailBatchesRecipientsAddError = EmailBatchesRecipientsAddErrors[keyof EmailBatchesRecipientsAddErrors];
16110
+ export type EmailBatchesRecipientsAddResults = {
16111
+ /**
16112
+ * Successful Response
16113
+ */
16114
+ 200: AddEmailRecipientsResponse;
16115
+ };
16116
+ export type EmailBatchesRecipientsAddResult = EmailBatchesRecipientsAddResults[keyof EmailBatchesRecipientsAddResults];
15968
16117
  export type EmailBatchesRecipientsUpdateData = {
15969
16118
  body: PatchEmailRecipientRequest;
15970
16119
  path: {
@@ -20431,6 +20580,55 @@ export type WhatsappBatchesRecipientsListResults = {
20431
20580
  200: PageWhatsAppRecipientResponse;
20432
20581
  };
20433
20582
  export type WhatsappBatchesRecipientsListResult = WhatsappBatchesRecipientsListResults[keyof WhatsappBatchesRecipientsListResults];
20583
+ export type WhatsappBatchesRecipientsAddData = {
20584
+ body: AddWhatsAppRecipientsRequest;
20585
+ path: {
20586
+ /**
20587
+ * Batch Id
20588
+ */
20589
+ batch_id: string;
20590
+ };
20591
+ query?: never;
20592
+ url: '/v1/whatsapp/batches/{batch_id}/recipients';
20593
+ };
20594
+ export type WhatsappBatchesRecipientsAddErrors = {
20595
+ /**
20596
+ * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
20597
+ */
20598
+ 400: ErrorResponse;
20599
+ /**
20600
+ * Missing credential, or one that is revoked or no longer a member of this organization.
20601
+ */
20602
+ 401: ErrorResponse;
20603
+ /**
20604
+ * Authenticated, but this organization role may not perform the operation.
20605
+ */
20606
+ 403: ErrorResponse;
20607
+ /**
20608
+ * No such resource in this organization.
20609
+ */
20610
+ 404: ErrorResponse;
20611
+ /**
20612
+ * The resource's current state forbids this — a name already taken, a job already running.
20613
+ */
20614
+ 409: ErrorResponse;
20615
+ /**
20616
+ * The request did not match this operation's schema; `detail.errors` lists each field.
20617
+ */
20618
+ 422: ErrorResponse;
20619
+ /**
20620
+ * Unexpected error. Every error this API returns carries this body.
20621
+ */
20622
+ default: ErrorResponse;
20623
+ };
20624
+ export type WhatsappBatchesRecipientsAddError = WhatsappBatchesRecipientsAddErrors[keyof WhatsappBatchesRecipientsAddErrors];
20625
+ export type WhatsappBatchesRecipientsAddResults = {
20626
+ /**
20627
+ * Successful Response
20628
+ */
20629
+ 200: AddWhatsAppRecipientsResponse;
20630
+ };
20631
+ export type WhatsappBatchesRecipientsAddResult = WhatsappBatchesRecipientsAddResults[keyof WhatsappBatchesRecipientsAddResults];
20434
20632
  export type WhatsappBatchesRecipientsRestoreData = {
20435
20633
  body: SelectRecipientsRequest;
20436
20634
  path: {