@b-jones-rfd/qualtrics-api-tasks 0.3.3 → 0.3.5

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 +3 -3
  3. package/dist/index.d.mts +6 -6
  4. package/dist/index.d.ts +6 -6
  5. package/dist/index.js +6 -3
  6. package/dist/index.mjs +6 -3
  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.5
4
+
5
+ ### Patch Changes
6
+
7
+ - 6d085dc: Update list distribution to make survey id optional
8
+
9
+ ## 0.3.4
10
+
11
+ ### Patch Changes
12
+
13
+ - da8c841: Update required props listDistributions
14
+
3
15
  ## 0.3.3
4
16
 
5
17
  ### Patch Changes
package/README.md CHANGED
@@ -341,11 +341,11 @@ Implements [List Distributions](https://api.qualtrics.com/234bb6b16cf6d-list-dis
341
341
 
342
342
  | Property | Type | Description | Required | Default |
343
343
  | ----------------------- | ------- | ------------------------------- | -------- | ------- |
344
- | surveyId | string | Quatrics Survey ID | Y | |
345
- | distributionRequestType | string | Distribution Request Type | Y | |
346
- | mailingListId | string | Mailing List ID | Y | |
347
344
  | sendStartDate | Date | Export start date and time | Y | |
348
345
  | sendEndDate | Date | Export end date and time | Y | |
346
+ | surveyId | string | Quatrics Survey ID | N | |
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
@@ -118,11 +118,11 @@ type Connection = {
118
118
  }, FileProgressResponse>;
119
119
  importContacts: Action<StartContactsImportOptions, ContactsImportSummaryResponse>;
120
120
  listDistributions: Action<{
121
- surveyId: string;
122
- distributionRequestType: DistributionRequestType;
123
- mailingListId: string;
124
121
  sendStartDate: Date;
125
122
  sendEndDate: Date;
123
+ surveyId?: string;
124
+ distributionRequestType?: DistributionRequestType;
125
+ mailingListId?: string;
126
126
  skipToken?: string;
127
127
  useNewPaginationScheme?: boolean;
128
128
  pageSize?: number;
@@ -431,11 +431,11 @@ declare const importContacts: ActionFactory<StartContactsImportOptions, Contacts
431
431
  * @see https://api.qualtrics.com/234bb6b16cf6d-list-distributions
432
432
  */
433
433
  declare const listDistributions: ActionFactory<{
434
- surveyId: string;
435
- distributionRequestType: DistributionRequestType;
436
- mailingListId: string;
437
434
  sendStartDate: Date;
438
435
  sendEndDate: Date;
436
+ surveyId?: string;
437
+ distributionRequestType?: DistributionRequestType;
438
+ mailingListId?: string;
439
439
  skipToken?: string;
440
440
  useNewPaginationScheme?: boolean;
441
441
  pageSize?: number;
package/dist/index.d.ts CHANGED
@@ -118,11 +118,11 @@ type Connection = {
118
118
  }, FileProgressResponse>;
119
119
  importContacts: Action<StartContactsImportOptions, ContactsImportSummaryResponse>;
120
120
  listDistributions: Action<{
121
- surveyId: string;
122
- distributionRequestType: DistributionRequestType;
123
- mailingListId: string;
124
121
  sendStartDate: Date;
125
122
  sendEndDate: Date;
123
+ surveyId?: string;
124
+ distributionRequestType?: DistributionRequestType;
125
+ mailingListId?: string;
126
126
  skipToken?: string;
127
127
  useNewPaginationScheme?: boolean;
128
128
  pageSize?: number;
@@ -431,11 +431,11 @@ declare const importContacts: ActionFactory<StartContactsImportOptions, Contacts
431
431
  * @see https://api.qualtrics.com/234bb6b16cf6d-list-distributions
432
432
  */
433
433
  declare const listDistributions: ActionFactory<{
434
- surveyId: string;
435
- distributionRequestType: DistributionRequestType;
436
- mailingListId: string;
437
434
  sendStartDate: Date;
438
435
  sendEndDate: Date;
436
+ surveyId?: string;
437
+ distributionRequestType?: DistributionRequestType;
438
+ mailingListId?: string;
439
439
  skipToken?: string;
440
440
  useNewPaginationScheme?: boolean;
441
441
  pageSize?: number;
package/dist/index.js CHANGED
@@ -656,12 +656,15 @@ var listDistributions = (connectionOptions) => async ({
656
656
  try {
657
657
  const headers = getAuthHeaders(connectionOptions.apiToken, bearerToken);
658
658
  const qs = new URLSearchParams({
659
- surveyId,
660
- distributionRequestType,
661
- mailingListId,
662
659
  sendStartDate: sendStartDate.toISOString(),
663
660
  sendEndDate: sendEndDate.toISOString()
664
661
  });
662
+ if (surveyId)
663
+ qs.append("surveyId", surveyId);
664
+ if (mailingListId)
665
+ qs.append("mailingListId", mailingListId);
666
+ if (distributionRequestType)
667
+ qs.append("distributionRequestType", distributionRequestType);
665
668
  if (skipToken)
666
669
  qs.append("skipToken", skipToken);
667
670
  if (useNewPaginationScheme)
package/dist/index.mjs CHANGED
@@ -613,12 +613,15 @@ var listDistributions = (connectionOptions) => async ({
613
613
  try {
614
614
  const headers = getAuthHeaders(connectionOptions.apiToken, bearerToken);
615
615
  const qs = new URLSearchParams({
616
- surveyId,
617
- distributionRequestType,
618
- mailingListId,
619
616
  sendStartDate: sendStartDate.toISOString(),
620
617
  sendEndDate: sendEndDate.toISOString()
621
618
  });
619
+ if (surveyId)
620
+ qs.append("surveyId", surveyId);
621
+ if (mailingListId)
622
+ qs.append("mailingListId", mailingListId);
623
+ if (distributionRequestType)
624
+ qs.append("distributionRequestType", distributionRequestType);
622
625
  if (skipToken)
623
626
  qs.append("skipToken", skipToken);
624
627
  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.3",
3
+ "version": "0.3.5",
4
4
  "description": "Perform common tasks using the Qualtrics API",
5
5
  "private": false,
6
6
  "main": "./dist/index.js",