Merge pull request #245 from lob/DXP-1374

Dxp 1374

Author: BennyKitchell

__tests__/CardsApi.unit.ts

@@ -465,9 +465,7 @@ describe("CardsApi", () => {
         1,
         "fake",
         "id",
-        {
-          id: "asc",
-        }
+        ["asc"]
       );
       expect(cardsApi).toBeDefined();
       expect(cardsApi.data?.length).toEqual(1);

__tests__/LettersApi.spec.ts

@@ -69,6 +69,8 @@ describe("CardsApi", () => {
         file: FILE_LOCATION_8X11,
       });
       const letter = await lettersApi.create(registeredLetter);
+      console.log("benny!!");
+      console.log({ letter });
       expect(letter.id).toBeDefined();
       expect(letter.extra_service).toEqual("registered");
       if (letter.id) {

__tests__/MiscellaneousModels.unit.ts

@@ -9,8 +9,6 @@ import {
   SortBy1,
   SortBy2,
   SortBy3,
-  SortBy4,
-  SortBy5,
   SortByDateCreatedEnum,
   SortBySendDateEnum,
   SortBy1DateCreatedEnum,
@@ -19,12 +17,7 @@ import {
   SortBy2SendDateEnum,
   SortBy3DateCreatedEnum,
   SortBy3SendDateEnum,
-  SortBy4DateCreatedEnum,
-  SortBy4SendDateEnum,
-  SortBy5DateCreatedEnum,
-  SortBy5SendDateEnum,
   Thumbnail,
-  CountryExtended,
   TrackingEventCertified,
   TrackingEventCertifiedTypeEnum,
   TrackingEventCertifiedNameEnum,
@@ -579,20 +572,20 @@ describe("Sort Criteria", () => {
 
   describe("SortBy4", () => {
     it("can be created", () => {
-      const rec = new SortBy4();
+      const rec = new SortBy3();
       expect(rec).toBeDefined();
     });
 
     it.each([
-      ["date_created", SortBy4DateCreatedEnum.Asc],
-      ["date_created", SortBy4DateCreatedEnum.Desc],
-      ["send_date", SortBy4SendDateEnum.Asc],
-      ["send_date", SortBy4SendDateEnum.Desc],
+      ["date_created", SortBySendDateEnum.Asc],
+      ["date_created", SortBySendDateEnum.Desc],
+      ["send_date", SortBySendDateEnum.Asc],
+      ["send_date", SortBySendDateEnum.Desc],
     ])("can be created with a provided %s value", (prop, val) => {
       const input = {};
       (input as any)[prop] = val;
 
-      const rec = new SortBy4(input);
+      const rec = new SortBy3(input);
 
       expect(rec).toBeDefined();
       expect((rec as any)[prop]).toEqual(val);
@@ -601,20 +594,20 @@ describe("Sort Criteria", () => {
 
   describe("SortBy5", () => {
     it("can be created", () => {
-      const rec = new SortBy5();
+      const rec = new SortBy3();
       expect(rec).toBeDefined();
     });
 
     it.each([
-      ["date_created", SortBy5DateCreatedEnum.Asc],
-      ["date_created", SortBy5DateCreatedEnum.Desc],
-      ["send_date", SortBy5SendDateEnum.Asc],
-      ["send_date", SortBy5SendDateEnum.Desc],
+      ["date_created", SortBySendDateEnum.Asc],
+      ["date_created", SortBySendDateEnum.Desc],
+      ["send_date", SortBySendDateEnum.Asc],
+      ["send_date", SortBySendDateEnum.Desc],
     ])("can be created with a provided %s value", (prop, val) => {
       const input = {};
       (input as any)[prop] = val;
 
-      const rec = new SortBy5(input);
+      const rec = new SortBy3(input);
 
       expect(rec).toBeDefined();
       expect((rec as any)[prop]).toEqual(val);

api/billing-groups-api.ts

@@ -239,7 +239,7 @@ export const BillingGroupsApiAxiosParamCreator = function (
      * @param {Array<string>} [include] Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.
      * @param {{ [key: string]: string; }} [dateCreated] Filter by date created.
      * @param {{ [key: string]: string; }} [dateModified] Filter by date modified.
-     * @param {object} [sortBy] Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both.
+     * @param {object} [sortByDateModified] Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;date_modfied&#x60;, not both.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -249,7 +249,7 @@ export const BillingGroupsApiAxiosParamCreator = function (
       include?: Array<string>,
       dateCreated?: { [key: string]: string },
       dateModified?: { [key: string]: string },
-      sortBy?: object,
+      sortByDateModified?: object,
       options: AxiosRequestConfig = {}
     ): Promise<RequestArgs> => {
       const localVarPath = `/billing_groups`;
@@ -292,8 +292,8 @@ export const BillingGroupsApiAxiosParamCreator = function (
         localVarQueryParameter["date_modified"] = valueToString(dateModified);
       }
 
-      if (sortBy !== undefined) {
-        localVarQueryParameter["sort_by"] = valueToString(sortBy);
+      if (sortByDateModified !== undefined) {
+        localVarQueryParameter["sort_by"] = valueToString(sortByDateModified);
       }
 
       setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -404,7 +404,7 @@ export const BillingGroupsApiFp = function (configuration?: Configuration) {
      * @param {Array<string>} [include] Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.
      * @param {{ [key: string]: string; }} [dateCreated] Filter by date created.
      * @param {{ [key: string]: string; }} [dateModified] Filter by date modified.
-     * @param {object} [sortBy] Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both.
+     * @param {object} [sortByDateModified] Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;date_modfied&#x60;, not both.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -414,7 +414,7 @@ export const BillingGroupsApiFp = function (configuration?: Configuration) {
       include?: Array<string>,
       dateCreated?: { [key: string]: string },
       dateModified?: { [key: string]: string },
-      sortBy?: object,
+      sortByDateModified?: object,
       options?: AxiosRequestConfig
     ): Promise<
       (
@@ -429,7 +429,7 @@ export const BillingGroupsApiFp = function (configuration?: Configuration) {
           include,
           dateCreated,
           dateModified,
-          sortBy,
+          sortByDateModified,
           options
         );
       return createRequestFunction(
@@ -534,7 +534,7 @@ export class BillingGroupsApi extends BaseAPI {
    * @param {Array<string>} [include] Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.
    * @param {{ [key: string]: string; }} [dateCreated] Filter by date created.
    * @param {{ [key: string]: string; }} [dateModified] Filter by date modified.
-   * @param {object} [sortBy] Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both.
+   * @param {object} [sortByDateModified] Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;date_modfied&#x60;, not both.
    * @param {*} [options] Override http request option.
    * @throws {RequiredError}
    * @memberof BillingGroupsApi
@@ -545,7 +545,7 @@ export class BillingGroupsApi extends BaseAPI {
     include?: Array<string>,
     dateCreated?: { [key: string]: string },
     dateModified?: { [key: string]: string },
-    sortBy?: object,
+    sortByDateModified?: object,
     options?: AxiosRequestConfig
   ) {
     return BillingGroupsApiFp(this.configuration)
@@ -555,7 +555,7 @@ export class BillingGroupsApi extends BaseAPI {
         include,
         dateCreated,
         dateModified,
-        sortBy,
+        sortByDateModified,
         options
       )
       .then((request) => request(this.axios, this.basePath))

api/cards-api.ts

@@ -283,15 +283,15 @@ export const CardsApiAxiosParamCreator = function (
      * @param {number} [limit] How many results to return.
      * @param {string} [before] A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response.
      * @param {string} [after] A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response.
-     * @param {object} [sortBy] Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
+     * @param {Array<string>} [include] Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     cardsList: async (
       limit?: number,
       before?: string,
       after?: string,
-      sortBy?: object,
+      include?: Array<string>,
       options: AxiosRequestConfig = {}
     ): Promise<RequestArgs> => {
       const localVarPath = `/cards`;
@@ -326,8 +326,8 @@ export const CardsApiAxiosParamCreator = function (
         localVarQueryParameter["after"] = after;
       }
 
-      if (sortBy !== undefined) {
-        localVarQueryParameter["sort_by"] = valueToString(sortBy);
+      if (include) {
+        localVarQueryParameter["include"] = valueToString(include);
       }
 
       setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -459,15 +459,15 @@ export const CardsApiFp = function (configuration?: Configuration) {
      * @param {number} [limit] How many results to return.
      * @param {string} [before] A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.
      * @param {string} [after] A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.
-     * @param {object} [sortBy] Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both.
+     * @param {Array<string>} [include] Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     async cardsList(
       limit?: number,
       before?: string,
       after?: string,
-      sortBy?: object,
+      include?: Array<string>,
       options?: AxiosRequestConfig
     ): Promise<
       (axios?: AxiosInstance, basePath?: string) => AxiosPromise<CardList>
@@ -476,7 +476,7 @@ export const CardsApiFp = function (configuration?: Configuration) {
         limit,
         before,
         after,
-        sortBy,
+        include,
         options
       );
       return createRequestFunction(
@@ -599,7 +599,7 @@ export class CardsApi extends BaseAPI {
    * @param {number} [limit] How many results to return.
    * @param {string} [before] A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.
    * @param {string} [after] A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.
-   * @param {object} [sortBy] Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both.
+   * @param {Array<string>} [include] Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.
    * @param {*} [options] Override http request option.
    * @throws {RequiredError}
    * @memberof CardsApi
@@ -608,11 +608,11 @@ export class CardsApi extends BaseAPI {
     limit?: number,
     before?: string,
     after?: string,
-    sortBy?: object,
+    include?: Array<string>,
     options?: AxiosRequestConfig
   ) {
     return CardsApiFp(this.configuration)
-      .cardsList(limit, before, after, sortBy, options)
+      .cardsList(limit, before, after, include, options)
       .then((request) => request(this.axios, this.basePath))
       .then(function (response) {
         return new CardList(response.data);

models/cmp-schedule-type.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Lob
+ * The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
+ *
+ * The version of the OpenAPI document: 1.3.0
+ * Contact: [email protected]
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as Models from "./index";
+
+/**
+ * How the campaign should be scheduled. Only value available today is `immediate`.
+ * @export
+ * @enum {string}
+ */
+
+export enum CmpScheduleType {
+  Immediate = "immediate",
+}
+
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */

models/cmp-use-type.ts

@@ -0,0 +1,33 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Lob
+ * The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
+ *
+ * The version of the OpenAPI document: 1.3.0
+ * Contact: [email protected]
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as Models from "./index";
+
+/**
+ * The usage type of this campaign. Can be one of `marketing` or `operational`.
+ * @export
+ * @enum {string}
+ */
+
+export enum CmpUseType {
+  Marketing = "marketing",
+  Operational = "operational",
+  Null = "null",
+}
+
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */

models/country-extended-expanded.ts

@@ -21,6 +21,7 @@ import * as Models from "./index";
  */
 
 export enum CountryExtendedExpanded {
+  Empty = "",
   Afghanistan = "AFGHANISTAN",
   Albania = "ALBANIA",
   Algeria = "ALGERIA",

models/letter-editable-custom-envelope.ts renamed to models/custom-envelope-returned.ts

@@ -15,11 +15,11 @@
 import * as Models from "./index";
 
 /**
- * A nested custom envelope object containing more information about the custom envelope used or `null` if a custom envelope was not used.  Accepts an envelope ID for any customized envelope with available inventory. If no inventory is available for the specified ID, the letter will not be sent, and an error will be returned. If the letter has more than 6 sheets, it will be sent in a blank flat envelope. Custom envelopes may be created and ordered from the dashboard. This feature is exclusive to certain customers. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access.
+ * A nested custom envelope object containing more information about the custom envelope used or `null` if a custom envelope was not used.
  * @export
- * @class LetterEditableCustomEnvelope
+ * @class CustomEnvelopeReturned
  */
-export class LetterEditableCustomEnvelope {
+export class CustomEnvelopeReturned {
   constructor(input?: any) {
     if (typeof input?.id !== "undefined") {
       this.id = input.id;
@@ -35,23 +35,23 @@ export class LetterEditableCustomEnvelope {
   /**
    * The unique identifier of the custom envelope used.
    * @type {string}
-   * @memberof LetterEditableCustomEnvelope
+   * @memberof CustomEnvelopeReturned
    */
   "id": string;
 
   /**
    * The url of the envelope asset used.
    * @type {string}
-   * @memberof LetterEditableCustomEnvelope
+   * @memberof CustomEnvelopeReturned
    */
   "url": string;
 
   /**
    *
    * @type {string}
-   * @memberof LetterEditableCustomEnvelope
+   * @memberof CustomEnvelopeReturned
    */
-  "object": LetterEditableCustomEnvelopeObjectEnum;
+  "object": CustomEnvelopeReturnedObjectEnum;
 
   public toJSON() {
     let out = {};
@@ -68,7 +68,7 @@ export class LetterEditableCustomEnvelope {
  * @export
  * @enum {string}
  */
-export enum LetterEditableCustomEnvelopeObjectEnum {
+export enum CustomEnvelopeReturnedObjectEnum {
   Envelope = "envelope",
 }