@b-jones-rfd/qualtrics-api-tasks 0.3.2 → 0.3.4

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.
Files changed (7) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +2 -2
  3. package/dist/index.d.mts +4 -4
  4. package/dist/index.d.ts +4 -4
  5. package/dist/index.js +6 -6
  6. package/dist/index.mjs +6 -6
  7. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @b-jones-rfd/qualtrics-api-tasks
2
2
 
3
+ ## 0.3.4
4
+
5
+ ### Patch Changes
6
+
7
+ - da8c841: Update required props listDistributions
8
+
9
+ ## 0.3.3
10
+
11
+ ### Patch Changes
12
+
13
+ - e64a943: Fix export responses date range
14
+
3
15
  ## 0.3.2
4
16
 
5
17
  ### Patch Changes
package/README.md CHANGED
@@ -342,10 +342,10 @@ Implements [List Distributions](https://api.qualtrics.com/234bb6b16cf6d-list-dis
342
342
  | Property | Type | Description | Required | Default |
343
343
  | ----------------------- | ------- | ------------------------------- | -------- | ------- |
344
344
  | surveyId | string | Quatrics Survey ID | Y | |
345
- | distributionRequestType | string | Distribution Request Type | Y | |
346
- | mailingListId | string | Mailing List ID | Y | |
347
345
  | sendStartDate | Date | Export start date and time | Y | |
348
346
  | sendEndDate | Date | Export end date and time | Y | |
347
+ | mailingListId | string | Mailing List ID | N | |
348
+ | distributionRequestType | string | Distribution Request Type | N | |
349
349
  | skipToken | string | Pagination offset | N | |
350
350
  | useNewPaginationScheme | boolean | Use updated pagination | N | false |
351
351
  | pageSize | number | Distribution elements to return | N | 100 |
package/dist/index.d.mts CHANGED
@@ -119,10 +119,10 @@ type Connection = {
119
119
  importContacts: Action<StartContactsImportOptions, ContactsImportSummaryResponse>;
120
120
  listDistributions: Action<{
121
121
  surveyId: string;
122
- distributionRequestType: DistributionRequestType;
123
- mailingListId: string;
124
122
  sendStartDate: Date;
125
123
  sendEndDate: Date;
124
+ distributionRequestType?: DistributionRequestType;
125
+ mailingListId?: string;
126
126
  skipToken?: string;
127
127
  useNewPaginationScheme?: boolean;
128
128
  pageSize?: number;
@@ -432,10 +432,10 @@ declare const importContacts: ActionFactory<StartContactsImportOptions, Contacts
432
432
  */
433
433
  declare const listDistributions: ActionFactory<{
434
434
  surveyId: string;
435
- distributionRequestType: DistributionRequestType;
436
- mailingListId: string;
437
435
  sendStartDate: Date;
438
436
  sendEndDate: Date;
437
+ distributionRequestType?: DistributionRequestType;
438
+ mailingListId?: string;
439
439
  skipToken?: string;
440
440
  useNewPaginationScheme?: boolean;
441
441
  pageSize?: number;
package/dist/index.d.ts CHANGED
@@ -119,10 +119,10 @@ type Connection = {
119
119
  importContacts: Action<StartContactsImportOptions, ContactsImportSummaryResponse>;
120
120
  listDistributions: Action<{
121
121
  surveyId: string;
122
- distributionRequestType: DistributionRequestType;
123
- mailingListId: string;
124
122
  sendStartDate: Date;
125
123
  sendEndDate: Date;
124
+ distributionRequestType?: DistributionRequestType;
125
+ mailingListId?: string;
126
126
  skipToken?: string;
127
127
  useNewPaginationScheme?: boolean;
128
128
  pageSize?: number;
@@ -432,10 +432,10 @@ declare const importContacts: ActionFactory<StartContactsImportOptions, Contacts
432
432
  */
433
433
  declare const listDistributions: ActionFactory<{
434
434
  surveyId: string;
435
- distributionRequestType: DistributionRequestType;
436
- mailingListId: string;
437
435
  sendStartDate: Date;
438
436
  sendEndDate: Date;
437
+ distributionRequestType?: DistributionRequestType;
438
+ mailingListId?: string;
439
439
  skipToken?: string;
440
440
  useNewPaginationScheme?: boolean;
441
441
  pageSize?: number;
package/dist/index.js CHANGED
@@ -501,10 +501,8 @@ var startResponseExport = (connectionOptions) => async ({
501
501
  try {
502
502
  const headers = getAuthHeaders(connectionOptions.apiToken, bearerToken);
503
503
  const body = JSON.stringify({
504
- startDate: "2024-03-01T06:00:00Z",
505
- //startDate.toISOString(),
506
- endDate: "2024-03-05T06:00:00Z",
507
- //endDate.toISOString(),
504
+ startDate: startDate.toISOString(),
505
+ endDate: endDate.toISOString(),
508
506
  format,
509
507
  ...rest
510
508
  });
@@ -659,11 +657,13 @@ var listDistributions = (connectionOptions) => async ({
659
657
  const headers = getAuthHeaders(connectionOptions.apiToken, bearerToken);
660
658
  const qs = new URLSearchParams({
661
659
  surveyId,
662
- distributionRequestType,
663
- mailingListId,
664
660
  sendStartDate: sendStartDate.toISOString(),
665
661
  sendEndDate: sendEndDate.toISOString()
666
662
  });
663
+ if (mailingListId)
664
+ qs.append("mailingListId", mailingListId);
665
+ if (distributionRequestType)
666
+ qs.append("distributionRequestType", distributionRequestType);
667
667
  if (skipToken)
668
668
  qs.append("skipToken", skipToken);
669
669
  if (useNewPaginationScheme)
package/dist/index.mjs CHANGED
@@ -458,10 +458,8 @@ var startResponseExport = (connectionOptions) => async ({
458
458
  try {
459
459
  const headers = getAuthHeaders(connectionOptions.apiToken, bearerToken);
460
460
  const body = JSON.stringify({
461
- startDate: "2024-03-01T06:00:00Z",
462
- //startDate.toISOString(),
463
- endDate: "2024-03-05T06:00:00Z",
464
- //endDate.toISOString(),
461
+ startDate: startDate.toISOString(),
462
+ endDate: endDate.toISOString(),
465
463
  format,
466
464
  ...rest
467
465
  });
@@ -616,11 +614,13 @@ var listDistributions = (connectionOptions) => async ({
616
614
  const headers = getAuthHeaders(connectionOptions.apiToken, bearerToken);
617
615
  const qs = new URLSearchParams({
618
616
  surveyId,
619
- distributionRequestType,
620
- mailingListId,
621
617
  sendStartDate: sendStartDate.toISOString(),
622
618
  sendEndDate: sendEndDate.toISOString()
623
619
  });
620
+ if (mailingListId)
621
+ qs.append("mailingListId", mailingListId);
622
+ if (distributionRequestType)
623
+ qs.append("distributionRequestType", distributionRequestType);
624
624
  if (skipToken)
625
625
  qs.append("skipToken", skipToken);
626
626
  if (useNewPaginationScheme)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@b-jones-rfd/qualtrics-api-tasks",
3
- "version": "0.3.2",
3
+ "version": "0.3.4",
4
4
  "description": "Perform common tasks using the Qualtrics API",
5
5
  "private": false,
6
6
  "main": "./dist/index.js",