@graph8/sdk 0.7.1 → 0.7.2
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/dist/index.d.mts +33 -15
- package/dist/index.d.ts +33 -15
- package/dist/index.js +34 -15
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +34 -15
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +33 -15
- package/dist/react.d.ts +33 -15
- package/dist/react.js +34 -15
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +34 -15
- package/dist/react.mjs.map +1 -1
- package/package.json +1 -1
package/dist/react.d.mts
CHANGED
|
@@ -2757,22 +2757,40 @@ declare const createSequencesClient: (apiKey: string, apiUrl?: string) => {
|
|
|
2757
2757
|
data: SequenceContactItem[];
|
|
2758
2758
|
pagination?: PaginationMeta;
|
|
2759
2759
|
}>;
|
|
2760
|
-
/**
|
|
2761
|
-
|
|
2762
|
-
|
|
2763
|
-
|
|
2760
|
+
/**
|
|
2761
|
+
* Add contacts to a sequence (V2 queuing). Live or drafted sequences only.
|
|
2762
|
+
* Pass `idempotencyKey` to make a retry safe — the same key returns the
|
|
2763
|
+
* first result instead of re-enrolling on a 5xx-then-success (A6).
|
|
2764
|
+
*/
|
|
2765
|
+
add(config: AddToSequenceConfig, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
2766
|
+
/**
|
|
2767
|
+
* Create a new sequence with optional steps + channels. Pass `idempotencyKey`
|
|
2768
|
+
* to make a retry safe — the same key returns the first result instead of
|
|
2769
|
+
* creating a duplicate sequence on a 5xx-then-success (A6).
|
|
2770
|
+
*/
|
|
2771
|
+
create(payload: SequenceCreateParams, idempotencyKey?: string): Promise<SequenceCreateResult>;
|
|
2764
2772
|
/** Update sequence metadata. Rejected (409) if sequence is in a transitional status. */
|
|
2765
2773
|
update(sequenceId: string, fields: SequenceUpdateParams): Promise<SequenceActionResult>;
|
|
2766
2774
|
/** Update a single step within a sequence. */
|
|
2767
2775
|
updateStep(sequenceId: string, stepId: string, fields: SequenceStepUpdateParams): Promise<SequenceActionResult>;
|
|
2768
2776
|
/** Soft-delete (archive) a sequence. */
|
|
2769
2777
|
delete(sequenceId: string): Promise<SequenceActionResult>;
|
|
2770
|
-
/**
|
|
2771
|
-
|
|
2772
|
-
|
|
2773
|
-
|
|
2774
|
-
|
|
2775
|
-
|
|
2778
|
+
/**
|
|
2779
|
+
* Run/start a DRAFTED sequence (V2 orchestration). Pass `idempotencyKey` to
|
|
2780
|
+
* make a retry safe — the same key won't re-trigger the run on a
|
|
2781
|
+
* 5xx-then-success (A6).
|
|
2782
|
+
*/
|
|
2783
|
+
run(sequenceId: string, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
2784
|
+
/**
|
|
2785
|
+
* Pause a live sequence. Pass `idempotencyKey` to make a retry safe — the
|
|
2786
|
+
* same key won't double-apply on a 5xx-then-success (A6).
|
|
2787
|
+
*/
|
|
2788
|
+
pause(sequenceId: string, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
2789
|
+
/**
|
|
2790
|
+
* Resume a paused sequence. Pass `idempotencyKey` to make a retry safe — the
|
|
2791
|
+
* same key won't double-apply on a 5xx-then-success (A6).
|
|
2792
|
+
*/
|
|
2793
|
+
resume(sequenceId: string, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
2776
2794
|
/** Read-only sequence preview with all steps + channels (no enrollment). */
|
|
2777
2795
|
preview(sequenceId: string): Promise<SequencePreview>;
|
|
2778
2796
|
/** Comprehensive analytics for a sequence. */
|
|
@@ -3184,14 +3202,14 @@ declare const useG8: () => {
|
|
|
3184
3202
|
data: SequenceContactItem[];
|
|
3185
3203
|
pagination?: PaginationMeta;
|
|
3186
3204
|
}>;
|
|
3187
|
-
add(config: AddToSequenceConfig): Promise<SequenceActionResult>;
|
|
3188
|
-
create(payload: SequenceCreateParams): Promise<SequenceCreateResult>;
|
|
3205
|
+
add(config: AddToSequenceConfig, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
3206
|
+
create(payload: SequenceCreateParams, idempotencyKey?: string): Promise<SequenceCreateResult>;
|
|
3189
3207
|
update(sequenceId: string, fields: SequenceUpdateParams): Promise<SequenceActionResult>;
|
|
3190
3208
|
updateStep(sequenceId: string, stepId: string, fields: SequenceStepUpdateParams): Promise<SequenceActionResult>;
|
|
3191
3209
|
delete(sequenceId: string): Promise<SequenceActionResult>;
|
|
3192
|
-
run(sequenceId: string): Promise<SequenceActionResult>;
|
|
3193
|
-
pause(sequenceId: string): Promise<SequenceActionResult>;
|
|
3194
|
-
resume(sequenceId: string): Promise<SequenceActionResult>;
|
|
3210
|
+
run(sequenceId: string, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
3211
|
+
pause(sequenceId: string, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
3212
|
+
resume(sequenceId: string, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
3195
3213
|
preview(sequenceId: string): Promise<SequencePreview>;
|
|
3196
3214
|
analytics(sequenceId: string): Promise<SequenceAnalytics>;
|
|
3197
3215
|
};
|
package/dist/react.d.ts
CHANGED
|
@@ -2757,22 +2757,40 @@ declare const createSequencesClient: (apiKey: string, apiUrl?: string) => {
|
|
|
2757
2757
|
data: SequenceContactItem[];
|
|
2758
2758
|
pagination?: PaginationMeta;
|
|
2759
2759
|
}>;
|
|
2760
|
-
/**
|
|
2761
|
-
|
|
2762
|
-
|
|
2763
|
-
|
|
2760
|
+
/**
|
|
2761
|
+
* Add contacts to a sequence (V2 queuing). Live or drafted sequences only.
|
|
2762
|
+
* Pass `idempotencyKey` to make a retry safe — the same key returns the
|
|
2763
|
+
* first result instead of re-enrolling on a 5xx-then-success (A6).
|
|
2764
|
+
*/
|
|
2765
|
+
add(config: AddToSequenceConfig, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
2766
|
+
/**
|
|
2767
|
+
* Create a new sequence with optional steps + channels. Pass `idempotencyKey`
|
|
2768
|
+
* to make a retry safe — the same key returns the first result instead of
|
|
2769
|
+
* creating a duplicate sequence on a 5xx-then-success (A6).
|
|
2770
|
+
*/
|
|
2771
|
+
create(payload: SequenceCreateParams, idempotencyKey?: string): Promise<SequenceCreateResult>;
|
|
2764
2772
|
/** Update sequence metadata. Rejected (409) if sequence is in a transitional status. */
|
|
2765
2773
|
update(sequenceId: string, fields: SequenceUpdateParams): Promise<SequenceActionResult>;
|
|
2766
2774
|
/** Update a single step within a sequence. */
|
|
2767
2775
|
updateStep(sequenceId: string, stepId: string, fields: SequenceStepUpdateParams): Promise<SequenceActionResult>;
|
|
2768
2776
|
/** Soft-delete (archive) a sequence. */
|
|
2769
2777
|
delete(sequenceId: string): Promise<SequenceActionResult>;
|
|
2770
|
-
/**
|
|
2771
|
-
|
|
2772
|
-
|
|
2773
|
-
|
|
2774
|
-
|
|
2775
|
-
|
|
2778
|
+
/**
|
|
2779
|
+
* Run/start a DRAFTED sequence (V2 orchestration). Pass `idempotencyKey` to
|
|
2780
|
+
* make a retry safe — the same key won't re-trigger the run on a
|
|
2781
|
+
* 5xx-then-success (A6).
|
|
2782
|
+
*/
|
|
2783
|
+
run(sequenceId: string, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
2784
|
+
/**
|
|
2785
|
+
* Pause a live sequence. Pass `idempotencyKey` to make a retry safe — the
|
|
2786
|
+
* same key won't double-apply on a 5xx-then-success (A6).
|
|
2787
|
+
*/
|
|
2788
|
+
pause(sequenceId: string, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
2789
|
+
/**
|
|
2790
|
+
* Resume a paused sequence. Pass `idempotencyKey` to make a retry safe — the
|
|
2791
|
+
* same key won't double-apply on a 5xx-then-success (A6).
|
|
2792
|
+
*/
|
|
2793
|
+
resume(sequenceId: string, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
2776
2794
|
/** Read-only sequence preview with all steps + channels (no enrollment). */
|
|
2777
2795
|
preview(sequenceId: string): Promise<SequencePreview>;
|
|
2778
2796
|
/** Comprehensive analytics for a sequence. */
|
|
@@ -3184,14 +3202,14 @@ declare const useG8: () => {
|
|
|
3184
3202
|
data: SequenceContactItem[];
|
|
3185
3203
|
pagination?: PaginationMeta;
|
|
3186
3204
|
}>;
|
|
3187
|
-
add(config: AddToSequenceConfig): Promise<SequenceActionResult>;
|
|
3188
|
-
create(payload: SequenceCreateParams): Promise<SequenceCreateResult>;
|
|
3205
|
+
add(config: AddToSequenceConfig, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
3206
|
+
create(payload: SequenceCreateParams, idempotencyKey?: string): Promise<SequenceCreateResult>;
|
|
3189
3207
|
update(sequenceId: string, fields: SequenceUpdateParams): Promise<SequenceActionResult>;
|
|
3190
3208
|
updateStep(sequenceId: string, stepId: string, fields: SequenceStepUpdateParams): Promise<SequenceActionResult>;
|
|
3191
3209
|
delete(sequenceId: string): Promise<SequenceActionResult>;
|
|
3192
|
-
run(sequenceId: string): Promise<SequenceActionResult>;
|
|
3193
|
-
pause(sequenceId: string): Promise<SequenceActionResult>;
|
|
3194
|
-
resume(sequenceId: string): Promise<SequenceActionResult>;
|
|
3210
|
+
run(sequenceId: string, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
3211
|
+
pause(sequenceId: string, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
3212
|
+
resume(sequenceId: string, idempotencyKey?: string): Promise<SequenceActionResult>;
|
|
3195
3213
|
preview(sequenceId: string): Promise<SequencePreview>;
|
|
3196
3214
|
analytics(sequenceId: string): Promise<SequenceAnalytics>;
|
|
3197
3215
|
};
|
package/dist/react.js
CHANGED
|
@@ -487,21 +487,30 @@ var createSequencesClient = (apiKey, apiUrl) => {
|
|
|
487
487
|
query: params
|
|
488
488
|
});
|
|
489
489
|
},
|
|
490
|
-
/**
|
|
491
|
-
|
|
490
|
+
/**
|
|
491
|
+
* Add contacts to a sequence (V2 queuing). Live or drafted sequences only.
|
|
492
|
+
* Pass `idempotencyKey` to make a retry safe — the same key returns the
|
|
493
|
+
* first result instead of re-enrolling on a 5xx-then-success (A6).
|
|
494
|
+
*/
|
|
495
|
+
async add(config, idempotencyKey) {
|
|
492
496
|
const resp = await request(
|
|
493
497
|
baseUrl,
|
|
494
498
|
`/api/v1/sequences/${config.sequenceId}/contacts`,
|
|
495
499
|
apiKey,
|
|
496
|
-
{ method: "POST", body: { contact_ids: config.contactIds, list_id: config.listId } }
|
|
500
|
+
{ method: "POST", body: { contact_ids: config.contactIds, list_id: config.listId }, idempotencyKey }
|
|
497
501
|
);
|
|
498
502
|
return resp.data ?? resp;
|
|
499
503
|
},
|
|
500
|
-
/**
|
|
501
|
-
|
|
504
|
+
/**
|
|
505
|
+
* Create a new sequence with optional steps + channels. Pass `idempotencyKey`
|
|
506
|
+
* to make a retry safe — the same key returns the first result instead of
|
|
507
|
+
* creating a duplicate sequence on a 5xx-then-success (A6).
|
|
508
|
+
*/
|
|
509
|
+
async create(payload, idempotencyKey) {
|
|
502
510
|
const resp = await request(baseUrl, "/api/v1/sequences", apiKey, {
|
|
503
511
|
method: "POST",
|
|
504
|
-
body: payload
|
|
512
|
+
body: payload,
|
|
513
|
+
idempotencyKey
|
|
505
514
|
});
|
|
506
515
|
return resp.data ?? resp;
|
|
507
516
|
},
|
|
@@ -530,33 +539,43 @@ var createSequencesClient = (apiKey, apiUrl) => {
|
|
|
530
539
|
});
|
|
531
540
|
return resp.data ?? resp;
|
|
532
541
|
},
|
|
533
|
-
/**
|
|
534
|
-
|
|
542
|
+
/**
|
|
543
|
+
* Run/start a DRAFTED sequence (V2 orchestration). Pass `idempotencyKey` to
|
|
544
|
+
* make a retry safe — the same key won't re-trigger the run on a
|
|
545
|
+
* 5xx-then-success (A6).
|
|
546
|
+
*/
|
|
547
|
+
async run(sequenceId, idempotencyKey) {
|
|
535
548
|
const resp = await request(
|
|
536
549
|
baseUrl,
|
|
537
550
|
`/api/v1/sequences/${sequenceId}/run`,
|
|
538
551
|
apiKey,
|
|
539
|
-
{ method: "POST" }
|
|
552
|
+
{ method: "POST", idempotencyKey }
|
|
540
553
|
);
|
|
541
554
|
return resp.data ?? resp;
|
|
542
555
|
},
|
|
543
|
-
/**
|
|
544
|
-
|
|
556
|
+
/**
|
|
557
|
+
* Pause a live sequence. Pass `idempotencyKey` to make a retry safe — the
|
|
558
|
+
* same key won't double-apply on a 5xx-then-success (A6).
|
|
559
|
+
*/
|
|
560
|
+
async pause(sequenceId, idempotencyKey) {
|
|
545
561
|
const resp = await request(
|
|
546
562
|
baseUrl,
|
|
547
563
|
`/api/v1/sequences/${sequenceId}/pause`,
|
|
548
564
|
apiKey,
|
|
549
|
-
{ method: "POST" }
|
|
565
|
+
{ method: "POST", idempotencyKey }
|
|
550
566
|
);
|
|
551
567
|
return resp.data ?? resp;
|
|
552
568
|
},
|
|
553
|
-
/**
|
|
554
|
-
|
|
569
|
+
/**
|
|
570
|
+
* Resume a paused sequence. Pass `idempotencyKey` to make a retry safe — the
|
|
571
|
+
* same key won't double-apply on a 5xx-then-success (A6).
|
|
572
|
+
*/
|
|
573
|
+
async resume(sequenceId, idempotencyKey) {
|
|
555
574
|
const resp = await request(
|
|
556
575
|
baseUrl,
|
|
557
576
|
`/api/v1/sequences/${sequenceId}/resume`,
|
|
558
577
|
apiKey,
|
|
559
|
-
{ method: "POST" }
|
|
578
|
+
{ method: "POST", idempotencyKey }
|
|
560
579
|
);
|
|
561
580
|
return resp.data ?? resp;
|
|
562
581
|
},
|