feat: add use type to necessary resources

Author: BennyKitchell

__tests__/PostcardsApi.spec.ts

@@ -7,7 +7,7 @@ import {
 } from "./testFixtures";
 
 describe("postcardsApi", () => {
-  jest.setTimeout(60000); // 60 seconds
+  jest.setTimeout(90000); // 90 seconds
 
   let postcardsApi: PostcardsApi;
 

__tests__/SelfMailersApi.spec.ts

@@ -7,7 +7,7 @@ import {
 } from "./testFixtures";
 
 describe("smApi", () => {
-  jest.setTimeout(60000); // 60 seconds
+  jest.setTimeout(90000); // 90 seconds
 
   const dummySelfMailer = new SelfMailerEditable({
     to: ADDRESSES_EDITABLE[0],
@@ -82,6 +82,7 @@ describe("smApi", () => {
         from: ADDRESSES_EDITABLE[5],
         inside: FILE_LOCATION_6X18,
         outside: FILE_LOCATION_6X18,
+        use_type: "marketing",
       });
       const c1 = await smApi.create(sfm1);
       const c2 = await smApi.create(sfm2);

models/campaign-writable.ts

@@ -127,7 +127,7 @@ export class CampaignWritable {
    * @type {CmpUseType}
    * @memberof CampaignWritable
    */
-  "use_type"?: CmpUseType | null;
+  "use_type": CmpUseType | null;
 
   /**
    * Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA.

models/campaign.ts

@@ -152,7 +152,7 @@ export class Campaign {
    * @type {CmpUseType}
    * @memberof Campaign
    */
-  "use_type"?: CmpUseType | null;
+  "use_type": CmpUseType | null;
 
   /**
    * Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA.

models/check-editable.ts

@@ -14,6 +14,8 @@
 
 import * as Models from "./index";
 
+import { ChkUseType } from "./chk-use-type";
+
 /**
  *
  * @export
@@ -69,23 +71,26 @@ export class CheckEditable {
     if (typeof input?.billing_group_id !== "undefined") {
       this.billing_group_id = input.billing_group_id;
     }
+    if (typeof input?.use_type !== "undefined") {
+      this.use_type = input.use_type;
+    }
   }
 
   /**
    * Must either be an address ID or an inline object with correct address parameters.
-   * @type {string}
+   * @type {any}
    * @memberof CheckEditable
    */
 
-  "from": string | Models.AddressDomestic;
+  "from": string | Models.AddressDomestic | null;
 
   /**
    * Must either be an address ID or an inline object with correct address parameters.
-   * @type {string}
+   * @type {any}
    * @memberof CheckEditable
    */
 
-  "to": string | Models.AddressDomestic;
+  "to": string | Models.AddressDomestic | null;
 
   /**
    *
@@ -185,6 +190,13 @@ export class CheckEditable {
    */
   "billing_group_id"?: string;
 
+  /**
+   *
+   * @type {ChkUseType}
+   * @memberof CheckEditable
+   */
+  "use_type": ChkUseType | null;
+
   public toJSON() {
     let out = {};
     for (const [key, value] of Object.entries(this)) {

models/check.ts

@@ -16,6 +16,7 @@ import * as Models from "./index";
 
 import { Address } from "./address";
 import { BankAccount } from "./bank-account";
+import { ChkUseType } from "./chk-use-type";
 import { Thumbnail } from "./thumbnail";
 import { TrackingEventNormal } from "./tracking-event-normal";
 
@@ -106,6 +107,9 @@ export class Check {
     if (typeof input?.deleted !== "undefined") {
       this.deleted = input.deleted;
     }
+    if (typeof input?.use_type !== "undefined") {
+      this.use_type = input.use_type;
+    }
   }
 
   /**
@@ -349,6 +353,13 @@ export class Check {
    */
   "deleted"?: boolean;
 
+  /**
+   *
+   * @type {ChkUseType}
+   * @memberof Check
+   */
+  "use_type": ChkUseType | null;
+
   public toJSON() {
     let out = {};
     for (const [key, value] of Object.entries(this)) {

models/chk-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";
+
+/**
+ * TThe use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our  [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type).
+ * @export
+ * @enum {string}
+ */
+
+export enum ChkUseType {
+  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/cmp-use-type.ts

@@ -15,7 +15,7 @@
 import * as Models from "./index";
 
 /**
- * The usage type of this campaign. Can be one of `marketing` or `operational`.
+ * The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our  [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type).
  * @export
  * @enum {string}
  */

models/country-extended.ts

@@ -21,6 +21,7 @@ import * as Models from "./index";
  */
 
 export enum CountryExtended {
+  Empty = "",
   Ad = "AD",
   Ae = "AE",
   Af = "AF",

models/index.ts

@@ -41,6 +41,7 @@ export * from "./check";
 export * from "./check-deletion";
 export * from "./check-editable";
 export * from "./check-list";
+export * from "./chk-use-type";
 export * from "./cmp-schedule-type";
 export * from "./cmp-use-type";
 export * from "./country-extended";
@@ -81,11 +82,13 @@ export * from "./lob-confidence-score";
 export * from "./lob-error";
 export * from "./location";
 export * from "./location-analysis";
+export * from "./ltr-use-type";
 export * from "./mail-type";
 export * from "./multi-line-address";
 export * from "./multiple-components";
 export * from "./multiple-components-intl";
 export * from "./multiple-components-list";
+export * from "./optional-address-column-mapping";
 export * from "./placeholder-model";
 export * from "./postcard";
 export * from "./postcard-deletion";
@@ -94,14 +97,17 @@ export * from "./postcard-details-writable";
 export * from "./postcard-editable";
 export * from "./postcard-list";
 export * from "./postcard-size";
+export * from "./psc-use-type";
 export * from "./qr-code";
+export * from "./required-address-column-mapping";
 export * from "./return-envelope";
 export * from "./reverse-geocode";
 export * from "./self-mailer";
 export * from "./self-mailer-deletion";
 export * from "./self-mailer-editable";
 export * from "./self-mailer-list";
 export * from "./self-mailer-size";
+export * from "./sfm-use-type";
 export * from "./sort-by";
 export * from "./sort-by1";
 export * from "./sort-by2";
@@ -128,6 +134,7 @@ export * from "./upload-file";
 export * from "./upload-state";
 export * from "./upload-updatable";
 export * from "./upload-writable";
+export * from "./uploads-metadata";
 export * from "./us-autocompletions";
 export * from "./us-autocompletions-writable";
 export * from "./us-components";