CMB-435: add snap packs to the public docs

lob-api-public.yml

@@ -2342,6 +2342,7 @@ x-tagGroups:
       - Self Mailers
       - Letters
       - Checks
+      - Snap Packs
       - Bank Accounts
       - Templates
       - Template Versions
@@ -2493,6 +2494,8 @@ paths:
     $ref: resources/self_mailers/self_mailer.yml
   /self_mailers:
     $ref: resources/self_mailers/self_mailers.yml
+  /snap_packs:
+    $ref: resources/snap_packs/snap_packs.yml
   /templates/{tmpl_id}/versions/{vrsn_id}:
     $ref: resources/templates/template_versions/template_version.yml
   /templates/{tmpl_id}/versions:

resources/snap_packs/attributes/color.yml

@@ -0,0 +1,4 @@
+type: boolean
+description: >-
+  Set this key to `true` if you would like to print in color.
+  Set to `false` if you would like to print in black and white.

resources/snap_packs/attributes/snap_pack_id.yml

@@ -0,0 +1,5 @@
+type: string
+
+description: Unique identifier prefixed with `ord_`.
+
+pattern: "^ord_[0-9a-f]{26}$"

resources/snap_packs/attributes/snap_pack_size.yml

@@ -0,0 +1,8 @@
+type: string
+
+enum:
+  - 8.5x11
+
+description: Specifies the size of the snap pack.
+
+default: 8.5x11

resources/snap_packs/attributes/snap_pack_use_type.yml

@@ -0,0 +1,7 @@
+description: 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).
+type: string
+enum:
+  - marketing
+  - operational
+  - null
+nullable: true

resources/snap_packs/models/snap_pack.yml

@@ -0,0 +1,82 @@
+allOf:
+  - $ref: "snap_pack_base.yml"
+  - $ref: "../../../shared/models/form_factor/generated.yml"
+  - $ref: "../../../shared/models/form_factor/from_us.yml"
+
+  - type: object
+
+    required:
+      - id
+      - url
+      - use_type
+
+    properties:
+      id:
+        $ref: "../attributes/snap_pack_id.yml"
+
+      outside_template_id:
+        description: The unique ID of the HTML template used for the outside of the snap pack.
+        allOf:
+          - $ref: "../../../shared/attributes/model_ids/tmpl_id.yml"
+          - type: string
+            nullable: true
+
+      inside_template_id:
+        description: The unique ID of the HTML template used for the inside of the snap pack.
+        allOf:
+          - $ref: "../../../shared/attributes/model_ids/tmpl_id.yml"
+          - type: string
+            nullable: true
+
+      outside_template_version_id:
+        description: The unique ID of the specific version of the HTML template used for the outside of the snap pack.
+        allOf:
+          - $ref: "../../../shared/attributes/model_ids/vrsn_id.yml"
+          - type: string
+            nullable: true
+
+      inside_template_version_id:
+        description: The unique ID of the specific version of the HTML template used for the inside of the snap pack.
+        allOf:
+          - $ref: "../../../shared/attributes/model_ids/vrsn_id.yml"
+          - type: string
+            nullable: true
+
+      object:
+        type: string
+        description: Value is resource type.
+        enum:
+          - snap_pack
+        default: snap_pack
+
+      tracking_events:
+        description: >-
+          An array of tracking events ordered by ascending `time`. Not populated in test mode.
+        type: array
+        items:
+          $ref: "../../../shared/resources/tracking_events/models/tracking_event_normal.yml"
+
+      use_type:
+        $ref: "../attributes/snap_pack_use_type.yml"
+
+      url:
+        $ref: "../../../shared/attributes/signed_link.yml"
+
+      fsc:
+        type: boolean
+        description: Contact [email protected] or your account contact to learn more. Not available for snap_pack currently.
+        default: false
+
+      status:
+        $ref: "../../../shared/attributes/status.yml"
+
+      campaign_id:
+        $ref: "../../../shared/attributes/campaign_id.yml"
+
+      failure_reason:
+        allOf:
+          - $ref: "../../../shared/models/failure_reason/failure_reason.yml"
+          - nullable: true
+
+      color:
+        $ref: "../attributes/color.yml"

resources/snap_packs/models/snap_pack_base.yml

@@ -0,0 +1,8 @@
+allOf:
+  - $ref: "../../../shared/models/form_factor/editable.yml"
+
+  - type: object
+
+    properties:
+      size:
+        $ref: "../attributes/snap_pack_size.yml"

resources/snap_packs/models/snap_pack_editable.yml

@@ -0,0 +1,68 @@
+allOf:
+  - $ref: "snap_pack_base.yml"
+  - $ref: "../../../shared/models/form_factor/input_to.yml"
+  - $ref: "../../../shared/models/form_factor/input_from_us.yml"
+
+  - type: object
+
+    required:
+      - to
+      - inside
+      - outside
+      - use_type
+
+    properties:
+      inside:
+        description: >
+          The artwork to use as the inside of your snap pack.
+
+
+          Notes:
+
+          - HTML merge variables should not include delimiting whitespace.
+
+          - PDF, PNG, and JPGs must be sized at 8.5"x11" at 300 DPI, while supplied
+          HTML will be rendered to the specified `size`.
+
+          - Be sure to leave room for address and postage information by following
+          the template provided here:
+            - <a href="https://s3.us-west-2.amazonaws.com/public.lob.com/assets/8.5x11_Snappack_template_address.pdf" target="_blank">8.5x11 snap pack template</a>
+
+
+          See [here](#section/HTML-Examples) for HTML examples.
+        oneOf:
+          - $ref: "../../../shared/attributes/html_string.yml"
+          - $ref: "../../../shared/attributes/model_ids/tmpl_id.yml"
+          - $ref: "../../../shared/attributes/remote_file_url.yml"
+          - $ref: "../../../shared/attributes/local_file_path.yml"
+
+      outside:
+        description: >
+          The artwork to use as the outside of your snap pack.
+
+
+          Notes:
+
+          - HTML merge variables should not include delimiting whitespace.
+
+          - PDF, PNG, and JPGs must be sized at 6"x18" at 300 DPI, while supplied
+          HTML will be rendered to the specified `size`.
+
+
+          See [here](#section/HTML-Examples) for HTML examples.
+        oneOf:
+          - $ref: "../../../shared/attributes/html_string.yml"
+          - $ref: "../../../shared/attributes/model_ids/tmpl_id.yml"
+          - $ref: "../../../shared/attributes/remote_file_url.yml"
+          - $ref: "../../../shared/attributes/local_file_path.yml"
+
+      billing_group_id:
+        $ref: "../../../shared/attributes/billing_group_id.yml"
+
+      use_type:
+        $ref: "../attributes/snap_pack_use_type.yml"
+
+      color:
+        allOf:
+          - $ref: "../attributes/color.yml"
+          - default: false

resources/snap_packs/parameters/lob_version.yml

@@ -0,0 +1,16 @@
+lob-version:
+  in: header
+
+  name: Lob-Version
+
+  required: true
+
+  description: >
+    A string representing the version of the API being used. Please note that attempting to use snap packs with the `Lob-Version` header predating to `2024-01-01` will result in an error.
+
+    For more information on versioning, refer to our [Versioning and Changelog]((#tag/Versioning-and-Changelog) documentation.
+
+  schema:
+    type: string
+    example: 2024-01-01
+    pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"

resources/snap_packs/responses/post_snap_pack.yml

@@ -0,0 +1,12 @@
+description: Returns a snap_pack object
+
+headers:
+  ratelimit-limit:
+    $ref: "../../../shared/headers/ratelimit.yml#/ratelimit-limit"
+  ratelimit-remaining:
+    $ref: "../../../shared/headers/ratelimit.yml#/ratelimit-remaining"
+  ratelimit-reset:
+    $ref: "../../../shared/headers/ratelimit.yml#/ratelimit-reset"
+
+content:
+  $ref: "snap_pack.yml"

resources/snap_packs/responses/snap_pack.yml

@@ -0,0 +1,68 @@
+application/json:
+  schema:
+    $ref: "../models/snap_pack.yml"
+  example:
+    id: ord_0d6a16a3fff6318ac8f8008dc1
+    description: April Campaign
+    to:
+      id: adr_bae820679f3f536b
+      description:
+      name: HARRY ZHANG
+      company:
+      phone:
+      email:
+      address_line1: 210 KING ST STE 6100
+      address_line2:
+      address_city: SAN FRANCISCO
+      address_state: CA
+      address_zip: 94107-1741
+      address_country: UNITED STATES
+      metadata: {}
+      date_created: "2017-09-05T17:47:53.767Z"
+      date_modified: "2017-09-05T17:47:53.767Z"
+      deleted: true
+      object: address
+    from:
+      id: adr_210a8d4b0b76d77b
+      description:
+      name: LEORE AVIDAR
+      company:
+      phone:
+      email:
+      address_line1: 210 KING ST STE 6100
+      address_line2:
+      address_city: SAN FRANCISCO
+      address_state: CA
+      address_zip: 94107-1741
+      address_country: UNITED STATES
+      metadata: {}
+      date_created: "2017-09-05T17:47:53.767Z"
+      date_modified: "2017-09-05T17:47:53.767Z"
+      deleted: true
+      object: address
+    url: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d.pdf?version=v1&expires=1618512040&signature=qvyCqXI1ndBvc4AjvG8FlirqLXEcfmYo4sDrRtabaXMOsX88to9G3K49uIk_aqevvZXe8HoRYD_nWydbQHqaCA
+    outside_template_id: tmpl_a3cb937f26d7eec
+    inside_template_id: tmpl_a3cb937f26d7eec
+    inside_template_version_id: vrsn_bfdf70893b00a85
+    outside_template_version_id: vrsn_bfdf70893b00a85
+    carrier: USPS
+    tracking_events: []
+    thumbnails:
+      - small: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d_thumb_small_1.png?version=v1&expires=1618512040&signature=-bipeUHP-hAMcCBSrWM0ZH1VwRdSPNVGGZN9hAZKr6Lh4ly6uxvratVd5LXJCK_zOEMYk_mTWASt0ge7OY6SDA
+        medium: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d_thumb_medium_1.png?version=v1&expires=1618512040&signature=ryxN7bsXGtw_GRFSP3Cs3A3IYjxZi3cW9BHDCNgMt6p3nobVmsc_iFHt2e-S7ndAXhhN7nP-MQVov3bt3r37BQ
+        large: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d_thumb_large_1.png?version=v1&expires=1618512040&signature=kBrm00xkyCkJNJRHxH8HshFaebtOxnzjVWOs1VVmGMuw8H6OBNcMAMxt9s49K0jlpHoh3Nr9uSncEZMQaaNjAg
+      - small: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d_thumb_small_2.png?version=v1&expires=1618512040&signature=3gTgU7Fd3KoT_vNlQnTGptRps5ZgnkhSnPrAwk7L98higIzSwfKoLvuu_DIpMM48dHbxckKT9waR8euJ4KSDBQ
+        medium: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d_thumb_medium_2.png?version=v1&expires=1618512040&signature=Ue1lw5CMj7KRx6cMQL8xPeazaHCdJzWcACd1w3acuYPnWkVIpSt62OIO7hAtpAQK9xm1dhhlFj0rqRZMdRMMBA
+        large: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d_thumb_large_2.png?version=v1&expires=1618512040&signature=cICc7HEm1xG_eyM4a_wtvPk2FqoLRmtgGa29kJisWnMIYBL0OkyzG4ZCYGMhp-5cZpJlSpXfTgGKh_Qmeo1TDw
+    merge_variables:
+      name:
+    size: 8.5x11
+    mail_type: usps_first_class
+    expected_delivery_date: "2021-03-24"
+    date_created: "2021-03-16T18:40:40.504Z"
+    date_modified: "2021-03-16T18:40:40.504Z"
+    send_date: "2021-03-16T18:45:40.493Z"
+    use_type: marketing
+    fsc: false
+    color: false
+    object: snap_pack