diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index ab918490..00d0f001 100755 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -3,6 +3,7 @@ api/openapi.yaml build.sbt docs/Address.md docs/AddressDeletion.md +docs/AddressDomestic.md docs/AddressDomesticExpanded.md docs/AddressEditable.md docs/AddressList.md @@ -20,6 +21,11 @@ docs/BillingGroupList.md docs/BillingGroupsApi.md docs/BulkError.md docs/BulkErrorProperties.md +docs/Campaign.md +docs/CampaignUpdatable.md +docs/CampaignWritable.md +docs/CampaignsApi.md +docs/CampaignsList.md docs/Card.md docs/CardDeletion.md docs/CardEditable.md @@ -35,8 +41,11 @@ docs/CheckDeletion.md docs/CheckEditable.md docs/CheckList.md docs/ChecksApi.md +docs/CmpScheduleType.md +docs/CmpUseType.md docs/CountryExtended.md docs/CountryExtendedExpanded.md +docs/DefaultApi.md docs/DeliverabilityAnalysis.md docs/DpvFootnote.md docs/EngineHtml.md @@ -70,6 +79,7 @@ docs/MailType.md docs/MultipleComponents.md docs/MultipleComponentsIntl.md docs/MultipleComponentsList.md +docs/PlaceholderModel.md docs/Postcard.md docs/PostcardDeletion.md docs/PostcardEditable.md @@ -149,9 +159,11 @@ src/main/java/com/lob/api/auth/HttpBearerAuth.java src/main/java/com/lob/api/client/AddressesApi.java src/main/java/com/lob/api/client/BankAccountsApi.java src/main/java/com/lob/api/client/BillingGroupsApi.java +src/main/java/com/lob/api/client/CampaignsApi.java src/main/java/com/lob/api/client/CardOrdersApi.java src/main/java/com/lob/api/client/CardsApi.java src/main/java/com/lob/api/client/ChecksApi.java +src/main/java/com/lob/api/client/DefaultApi.java src/main/java/com/lob/api/client/IntlAutocompletionsApi.java src/main/java/com/lob/api/client/IntlVerificationsApi.java src/main/java/com/lob/api/client/LettersApi.java @@ -165,6 +177,7 @@ src/main/java/com/lob/api/client/UsVerificationsApi.java src/main/java/com/lob/api/client/ZipLookupsApi.java src/main/java/com/lob/model/Address.java src/main/java/com/lob/model/AddressDeletion.java +src/main/java/com/lob/model/AddressDomestic.java src/main/java/com/lob/model/AddressDomesticExpanded.java src/main/java/com/lob/model/AddressEditable.java src/main/java/com/lob/model/AddressList.java @@ -179,6 +192,10 @@ src/main/java/com/lob/model/BillingGroupEditable.java src/main/java/com/lob/model/BillingGroupList.java src/main/java/com/lob/model/BulkError.java src/main/java/com/lob/model/BulkErrorProperties.java +src/main/java/com/lob/model/Campaign.java +src/main/java/com/lob/model/CampaignUpdatable.java +src/main/java/com/lob/model/CampaignWritable.java +src/main/java/com/lob/model/CampaignsList.java src/main/java/com/lob/model/Card.java src/main/java/com/lob/model/CardDeletion.java src/main/java/com/lob/model/CardEditable.java @@ -191,6 +208,8 @@ src/main/java/com/lob/model/Check.java src/main/java/com/lob/model/CheckDeletion.java src/main/java/com/lob/model/CheckEditable.java src/main/java/com/lob/model/CheckList.java +src/main/java/com/lob/model/CmpScheduleType.java +src/main/java/com/lob/model/CmpUseType.java src/main/java/com/lob/model/CountryExtended.java src/main/java/com/lob/model/CountryExtendedExpanded.java src/main/java/com/lob/model/DeliverabilityAnalysis.java @@ -223,6 +242,7 @@ src/main/java/com/lob/model/MailType.java src/main/java/com/lob/model/MultipleComponents.java src/main/java/com/lob/model/MultipleComponentsIntl.java src/main/java/com/lob/model/MultipleComponentsList.java +src/main/java/com/lob/model/PlaceholderModel.java src/main/java/com/lob/model/Postcard.java src/main/java/com/lob/model/PostcardDeletion.java src/main/java/com/lob/model/PostcardEditable.java diff --git a/CODE_SNIPPETS.md b/CODE_SNIPPETS.md index 44ab5595..899876ef 100755 --- a/CODE_SNIPPETS.md +++ b/CODE_SNIPPETS.md @@ -843,7 +843,7 @@ curl https://api.lob.com/v1/templates/tmpl_c94e83ca2cd5121 \ ``` ```java - TemplatesApi apiInstance = new TemplatesApi(config); + TemplatesApi apiInstance = new TemplatesApi(config); TemplateUpdate update = new TemplateUpdate(); update.setDescription("update template"); @@ -969,7 +969,19 @@ curl https://api.lob.com/v1/intl_autocompletions \ ``` ```java -This feature is not currently supported by this library. +IntlAutocompletionsWritable intlAutocompletionsWritable = new IntlAutocompletionsWritable(); +intlAutocompletionsWritable.setAddressPrefix("340 Wat"); +intlAutocompletionsWritable.setCity("Summerside"); +intlAutocompletionsWritable.setState("Prince Edward Island"); +intlAutocompletionsWritable.setZipCode("C1N 1C4"); +intlAutocompletionsWritable.setCountry(CountryExtended.CA); +IntlAutocompletionsApi apiInstance = new IntlAutocompletionsApi(config); + +try { + apiInstance.autocomplete(intlAutocompletionsWritable, null); +} catch (ApiException e) { + e.printStackTrace(); +} ``` ## ZipLookups Api diff --git a/api/openapi.yaml b/api/openapi.yaml index 602fad78..4f99b8f4 100755 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -27,6 +27,9 @@ tags: be attached to certain consumption-based usages of Letters, Checks, Postcards and Self-Mailers to customize your bill. name: Billing Groups +- description: The campaigns endpoint allows you to create and view campaigns that + can be used to send multiple letters or postcards. + name: Campaigns - description: The card orders endpoint allows you to easily create card orders for existing cards. name: Card Orders @@ -121,12 +124,16 @@ paths: required: false schema: additionalProperties: + format: date-time type: string description: 'Filter by ISO-8601 date or datetime, e.g. `{ gt: ''2012-01-01'', lt: ''2012-01-31T12:34:56Z'' }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject - description: Filter by metadata key-value pair`. explode: true in: query @@ -135,6 +142,9 @@ paths: schema: $ref: '#/components/schemas/metadata_model' style: form + x-template-config: + base-type: + dotnet: deepObject responses: "200": content: @@ -416,12 +426,16 @@ paths: required: false schema: additionalProperties: + format: date-time type: string description: 'Filter by ISO-8601 date or datetime, e.g. `{ gt: ''2012-01-01'', lt: ''2012-01-31T12:34:56Z'' }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject - description: Filter by metadata key-value pair`. explode: true in: query @@ -430,6 +444,9 @@ paths: schema: $ref: '#/components/schemas/metadata_model' style: form + x-template-config: + base-type: + dotnet: deepObject responses: "200": content: @@ -625,12 +642,16 @@ paths: required: false schema: additionalProperties: + format: date-time type: string description: 'Filter by ISO-8601 date or datetime, e.g. `{ gt: ''2012-01-01'', lt: ''2012-01-31T12:34:56Z'' }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject - description: Filter by date modified. explode: true in: query @@ -644,6 +665,9 @@ paths: and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject - $ref: '#/components/parameters/sort_by_5' description: | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. @@ -665,6 +689,12 @@ paths: type: string type: object style: form + x-template-config: + base-type: + dotnet: deepObject + additional-properties: + dotnet: + toJson: true responses: "200": content: @@ -821,6 +851,293 @@ paths: - Intl Verifications x-contentType: application/json x-accepts: application/json + /campaigns: + get: + description: Returns a list of your campaigns. The campaigns are returned sorted + by creation date, with the most recently created campaigns appearing first. + operationId: campaigns_list + parameters: + - description: How many results to return. + explode: true + in: query + name: limit + required: false + schema: + default: 10 + maximum: 100 + minimum: 1 + type: integer + style: form + - description: | + Request that the response include the total count by specifying `include[]=total_count`. + explode: true + in: query + name: include + required: false + schema: + $ref: '#/components/schemas/include_model' + style: form + - description: | + 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. + explode: true + in: query + name: before + required: false + schema: + $ref: '#/components/schemas/before' + style: form + - description: | + 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. + explode: true + in: query + name: after + required: false + schema: + $ref: '#/components/schemas/after' + style: form + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/campaigns_list' + description: A dictionary with a data property that contains an array of + up to `limit` campaigns. Each entry in the array is a separate letter. + The previous and next page of campaigns can be retrieved by calling the + endpoint contained in the `previous_url` and `next_url` fields in the + API response respectively. If no more campaigns are available beyond the + current set of returned results, the `next_url` field will be empty. + summary: list + tags: + - Campaigns + x-codeSamples: + - lang: Shell + source: | + curl https://api.lob.com/v1/campaigns \ + -u : + label: CURL + x-accepts: application/json + post: + description: Creates a new campaign with the provided properties. See how to + launch your first campaign [here](https://help.lob.com/best-practices/launching-your-first-campaign). + operationId: campaign_create + parameters: + - description: | + * `native` - Translate response to the native language of the country in the request + * `match` - match the response to the language in the request + + Default response is in English. + explode: false + in: header + name: x-lang-output + required: false + schema: + enum: + - native + - match + type: string + style: simple + requestBody: + content: + application/json: + example: + name: My Demo Campaign + description: My Campaign's description + schedule_type: immediate + schema: + $ref: '#/components/schemas/campaign_writable' + application/x-www-form-urlencoded: + encoding: + example-prop: + explode: true + style: deepObject + example: + name: My Demo Campaign + description: My Campaign's description + schedule_type: immediate + schema: + $ref: '#/components/schemas/campaign_writable' + multipart/form-data: + example: + name: My Demo Campaign + description: My Campaign's description + schedule_type: immediate + schema: + $ref: '#/components/schemas/campaign_writable' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/campaign' + description: Campaign created successfully + default: + content: + application/json: + schema: + $ref: '#/components/schemas/lob_error' + description: Lob uses RESTful HTTP response codes to indicate success or + failure of an API request. + summary: create + tags: + - Campaigns + x-codeSamples: + - lang: Shell + source: | + curl https://api.lob.com/v1/campaigns \ + -u : \ + -d "name=My First Campaign" \ + -d "schedule_type=immediate" + label: CURL + x-contentType: application/json + x-accepts: application/json + /campaigns/{cmp_id}: + delete: + description: Delete an existing campaign. You need only supply the unique identifier + that was returned upon campaign creation. Deleting a campaign also deletes + any associated mail pieces that have been created but not sent. A campaign's + `send_date` matches its associated mail pieces' `send_date`s. + operationId: campaign_delete + parameters: + - description: id of the campaign + explode: false + in: path + name: cmp_id + required: true + schema: + $ref: '#/components/schemas/cmp_id' + style: simple + responses: + "200": + content: + application/json: + example: + id: cmp_e05ee61ff80764b + deleted: true + schema: + description: Lob uses RESTful HTTP response codes to indicate success + or failure of an API request. In general, 2xx indicates success, + 4xx indicate an input error, and 5xx indicates an error on Lob's + end. + properties: + id: + $ref: '#/components/schemas/cmp_id' + deleted: + description: True if the resource has been successfully deleted. + type: boolean + description: Deleted the campaign. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/lob_error' + description: Lob uses RESTful HTTP response codes to indicate success or + failure of an API request. + summary: delete + tags: + - Campaigns + x-codeSamples: + - lang: Shell + source: | + curl -X DELETE https://api.lob.com/v1/campaigns/cmp_e05ee61ff80764b \ + -u : + label: CURL + x-accepts: application/json + get: + description: Retrieves the details of an existing campaign. You need only supply + the unique campaign identifier that was returned upon campaign creation. + operationId: campaign_retrieve + parameters: + - description: id of the campaign + explode: false + in: path + name: cmp_id + required: true + schema: + $ref: '#/components/schemas/cmp_id' + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/campaign' + description: Returns a campaign object + default: + content: + application/json: + schema: + $ref: '#/components/schemas/lob_error' + description: Lob uses RESTful HTTP response codes to indicate success or + failure of an API request. + summary: get + tags: + - Campaigns + x-codeSamples: + - lang: Shell + source: | + curl https://api.lob.com/v1/campaigns/cmp_e05ee61ff80764b \ + -u : + label: CURL + x-accepts: application/json + patch: + description: Update the details of an existing campaign. You need only supply + the unique identifier that was returned upon campaign creation. + operationId: campaign_update + parameters: + - description: id of the campaign + explode: false + in: path + name: cmp_id + required: true + schema: + $ref: '#/components/schemas/cmp_id' + style: simple + requestBody: + content: + application/json: + example: + description: Test campaign + schema: + $ref: '#/components/schemas/campaign_updatable' + application/x-www-form-urlencoded: + example: + description: Test campaign + schema: + $ref: '#/components/schemas/campaign_updatable' + multipart/form-data: + example: + description: Test campaign + schema: + $ref: '#/components/schemas/campaign_updatable' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/campaign' + description: Returns a campaign object + default: + content: + application/json: + schema: + $ref: '#/components/schemas/lob_error' + description: Lob uses RESTful HTTP response codes to indicate success or + failure of an API request. + summary: update + tags: + - Campaigns + x-codeSamples: + - lang: Shell + source: | + curl -X PATCH https://api.lob.com/v1/campaigns/cmp_e05ee61ff80764b \ + -u : \ + -d "description=Awesome campaign" + label: CURL + x-contentType: application/json + x-accepts: application/json /cards: get: description: Returns a list of your cards. The cards are returned sorted by @@ -877,6 +1194,12 @@ paths: type: string type: object style: form + x-template-config: + base-type: + dotnet: deepObject + additional-properties: + dotnet: + toJson: true responses: "200": content: @@ -1250,12 +1573,16 @@ paths: required: false schema: additionalProperties: + format: date-time type: string description: 'Filter by ISO-8601 date or datetime, e.g. `{ gt: ''2012-01-01'', lt: ''2012-01-31T12:34:56Z'' }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject - description: Filter by metadata key-value pair`. explode: true in: query @@ -1264,6 +1591,9 @@ paths: schema: $ref: '#/components/schemas/metadata_model' style: form + x-template-config: + base-type: + dotnet: deepObject - description: | * `true` - only return orders (past or future) where `send_date` is greater than `date_created` @@ -1288,6 +1618,9 @@ paths: and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject - description: | A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. explode: true @@ -1318,6 +1651,12 @@ paths: type: string type: object style: form + x-template-config: + base-type: + dotnet: deepObject + additional-properties: + dotnet: + toJson: true responses: "200": content: @@ -1641,12 +1980,16 @@ paths: required: false schema: additionalProperties: + format: date-time type: string description: 'Filter by ISO-8601 date or datetime, e.g. `{ gt: ''2012-01-01'', lt: ''2012-01-31T12:34:56Z'' }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject - description: Filter by metadata key-value pair`. explode: true in: query @@ -1655,6 +1998,9 @@ paths: schema: $ref: '#/components/schemas/metadata_model' style: form + x-template-config: + base-type: + dotnet: deepObject - description: Set to `true` to return only color letters. Set to `false` to return only black & white letters. explode: true @@ -1688,6 +2034,9 @@ paths: and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject - description: | A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. explode: true @@ -1718,6 +2067,12 @@ paths: type: string type: object style: form + x-template-config: + base-type: + dotnet: deepObject + additional-properties: + dotnet: + toJson: true responses: "200": content: @@ -1925,12 +2280,16 @@ paths: required: false schema: additionalProperties: + format: date-time type: string description: 'Filter by ISO-8601 date or datetime, e.g. `{ gt: ''2012-01-01'', lt: ''2012-01-31T12:34:56Z'' }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject - description: Filter by metadata key-value pair`. explode: true in: query @@ -1939,6 +2298,9 @@ paths: schema: $ref: '#/components/schemas/metadata_model' style: form + x-template-config: + base-type: + dotnet: deepObject - description: Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. explode: true @@ -1950,6 +2312,11 @@ paths: $ref: '#/components/schemas/postcard_size' type: array style: form + x-template-config: + base-type: + dotnet: multi + size: true + list_of: PostcardSize - description: | * `true` - only return orders (past or future) where `send_date` is greater than `date_created` @@ -1974,6 +2341,9 @@ paths: and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject - description: | A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. explode: true @@ -2004,6 +2374,12 @@ paths: type: string type: object style: form + x-template-config: + base-type: + dotnet: deepObject + additional-properties: + dotnet: + toJson: true responses: "200": content: @@ -2204,12 +2580,16 @@ paths: required: false schema: additionalProperties: + format: date-time type: string description: 'Filter by ISO-8601 date or datetime, e.g. `{ gt: ''2012-01-01'', lt: ''2012-01-31T12:34:56Z'' }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject - description: Filter by metadata key-value pair`. explode: true in: query @@ -2218,6 +2598,9 @@ paths: schema: $ref: '#/components/schemas/metadata_model' style: form + x-template-config: + base-type: + dotnet: deepObject - description: The self mailer sizes to be returned. explode: true in: query @@ -2228,6 +2611,11 @@ paths: $ref: '#/components/schemas/self_mailer_size' type: array style: form + x-template-config: + base-type: + dotnet: multi + size: true + list_of: SelfMailerSize - description: | * `true` - only return orders (past or future) where `send_date` is greater than `date_created` @@ -2252,6 +2640,9 @@ paths: and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject - description: | A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. explode: true @@ -2282,6 +2673,12 @@ paths: type: string type: object style: form + x-template-config: + base-type: + dotnet: deepObject + additional-properties: + dotnet: + toJson: true responses: "200": content: @@ -2559,12 +2956,16 @@ paths: required: false schema: additionalProperties: + format: date-time type: string description: 'Filter by ISO-8601 date or datetime, e.g. `{ gt: ''2012-01-01'', lt: ''2012-01-31T12:34:56Z'' }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject responses: "200": content: @@ -2803,12 +3204,16 @@ paths: required: false schema: additionalProperties: + format: date-time type: string description: 'Filter by ISO-8601 date or datetime, e.g. `{ gt: ''2012-01-01'', lt: ''2012-01-31T12:34:56Z'' }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject - description: Filter by metadata key-value pair`. explode: true in: query @@ -2817,6 +3222,9 @@ paths: schema: $ref: '#/components/schemas/metadata_model' style: form + x-template-config: + base-type: + dotnet: deepObject responses: "200": content: @@ -3085,6 +3493,19 @@ paths: - Zip Lookups x-contentType: application/json x-accepts: application/json + /shared_dont_call: + get: + description: Don't call this. It's so that the right models can be generated. + operationId: placeholder + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/placeholder_model' + description: Uncallable, used for generating missing models + summary: placeholder_no_call + x-accepts: application/json components: headers: ratelimit-limit: @@ -3157,12 +3578,16 @@ components: required: false schema: additionalProperties: + format: date-time type: string description: 'Filter by ISO-8601 date or datetime, e.g. `{ gt: ''2012-01-01'', lt: ''2012-01-31T12:34:56Z'' }` where `gt` is >, `lt` is <, `gte` is ≥, and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject metadata: description: Filter by metadata key-value pair`. explode: true @@ -3172,6 +3597,9 @@ components: schema: $ref: '#/components/schemas/metadata_model' style: form + x-template-config: + base-type: + dotnet: deepObject offset: description: An integer that designates the offset at which to begin returning results. Defaults to 0. @@ -3197,6 +3625,9 @@ components: and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject sort_by: $ref: '#/components/parameters/sort_by_5' description: | @@ -3219,6 +3650,28 @@ components: type: string type: object style: form + x-template-config: + base-type: + dotnet: deepObject + additional-properties: + dotnet: + toJson: true + lang_spec: + description: | + * `native` - Translate response to the native language of the country in the request + * `match` - match the response to the language in the request + + Default response is in English. + explode: false + in: header + name: x-lang-output + required: false + schema: + enum: + - native + - match + type: string + style: simple scheduled: description: | * `true` - only return orders (past or future) where `send_date` is @@ -3245,6 +3698,9 @@ components: and `lte` is ≤.' type: object style: form + x-template-config: + base-type: + dotnet: deepObject mail_type: description: | A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. @@ -3266,22 +3722,6 @@ components: maxLength: 256 type: string style: simple - lang_spec: - description: | - * `native` - Translate response to the native language of the country in the request - * `match` - match the response to the language in the request - - Default response is in English. - explode: false - in: header - name: x-lang-output - required: false - schema: - enum: - - native - - match - type: string - style: simple responses: error_response: content: @@ -3387,6 +3827,34 @@ components: $ref: '#/components/headers/ratelimit-remaining' ratelimit-reset: $ref: '#/components/headers/ratelimit-reset' + all_campaigns: + content: + application/json: + schema: + $ref: '#/components/schemas/campaigns_list' + description: A dictionary with a data property that contains an array of up + to `limit` campaigns. Each entry in the array is a separate letter. The previous + and next page of campaigns can be retrieved by calling the endpoint contained + in the `previous_url` and `next_url` fields in the API response respectively. + If no more campaigns are available beyond the current set of returned results, + the `next_url` field will be empty. + campaign_deleted: + content: + application/json: + example: + id: cmp_e05ee61ff80764b + deleted: true + schema: + description: Lob uses RESTful HTTP response codes to indicate success + or failure of an API request. In general, 2xx indicates success, 4xx + indicate an input error, and 5xx indicates an error on Lob's end. + properties: + id: + $ref: '#/components/schemas/cmp_id' + deleted: + description: True if the resource has been successfully deleted. + type: boolean + description: Deleted the campaign. card_deleted: content: application/json: @@ -5409,6 +5877,7 @@ components: - highway_contract - po_box - general_delivery + - "" type: string latitude: description: | @@ -5963,7 +6432,7 @@ components: - addresses type: object x-code-snippet: - intlVerifications: true + intlVerification: true bulkVerify: true addresses: address: @@ -5976,9 +6445,9 @@ components: - key: city val: London pascal_key: City - - key: zip_code + - key: postal_code val: EC3N 4DR - pascal_key: ZipCode + pascal_key: PostalCode - key: country val: GB pascal_key: Country @@ -5994,11 +6463,11 @@ components: - key: state val: Prince Edward Island pascal_key: State - - key: zip_code + - key: postal_code val: C1N 1C4 - pascal_key: ZipCode + pascal_key: PostalCode - key: country - val: GB + val: CA pascal_key: Country intl_ver_id: description: Unique identifier prefixed with `intl_ver_`. @@ -6189,23 +6658,368 @@ components: - addresses - errors type: object - card_id: - description: Unique identifier prefixed with `card_`. - pattern: ^card_[a-zA-Z0-9]+$ + cmp_schedule_type: + description: How the campaign should be scheduled. Only value available today + is `immediate`. + enum: + - immediate type: string - signed_link: - description: A [signed link](#section/Asset-URLs) served over HTTPS. The link - returned will expire in 30 days to prevent mis-sharing. Each time a GET request - is initiated, a new signed URL will be generated. - pattern: ^https://(lob-assets|lob-assets-staging)\.com/(letters|postcards|bank-accounts|checks|self-mailers|cards)/[a-z]{3,4}_[a-z0-9]{15,16}(\.pdf|_thumb_[a-z]+_[0-9]+\.png)\?(version=[a-z0-9-]*&)?expires=[0-9]{10}&signature=[a-zA-Z0-9-_]+$ + cmp_use_type: + description: The usage type of this campaign. Can be one of `marketing` or `operational`. + enum: + - marketing + - operational + - null + nullable: true type: string - thumbnail: + cmp_id: + description: Unique identifier prefixed with `cmp_`. + pattern: ^cmp_[a-zA-Z0-9]+$ + title: Campaign id + type: string + campaign: example: - small: small - large: large - medium: medium - properties: - small: + metadata: + key: metadata + date_created: 2000-01-23T04:56:07.000+00:00 + creatives: "" + description: description + target_delivery_date: 2000-01-23T04:56:07.000+00:00 + billing_group_id: billing_group_id + account_id: account_id + deleted: true + date_modified: 2000-01-23T04:56:07.000+00:00 + send_date: 2000-01-23T04:56:07.000+00:00 + is_draft: true + auto_cancel_if_ncoa: true + name: name + cancel_window_campaign_minutes: 0 + id: id + object: campaign + properties: + billing_group_id: + description: Unique identifier prefixed with `bg_`. + nullable: true + pattern: ^bg_[a-zA-Z0-9]+$ + type: string + name: + description: Name of the campaign. + type: string + description: + description: | + An internal description that identifies this resource. Must be no longer than 255 characters. + maxLength: 255 + nullable: true + type: string + schedule_type: + $ref: '#/components/schemas/cmp_schedule_type' + target_delivery_date: + description: If `schedule_type` is `target_delivery_date`, provide a targeted + delivery date for mail pieces in this campaign. + format: date-time + nullable: true + type: string + send_date: + description: If `schedule_type` is `scheduled_send_date`, provide a date + to send this campaign. + format: date-time + nullable: true + type: string + cancel_window_campaign_minutes: + description: A window, in minutes, within which the campaign can be canceled. + nullable: true + type: integer + metadata: + additionalProperties: + type: string + description: 'Use metadata to store custom information for tagging and labeling + back to your internal systems. Must be an object with up to 20 key-value + pairs. Keys must be at most 40 characters and values must be at most 500 + characters. Neither can contain the characters `"` and `\`. i.e. ''{"customer_id" + : "NEWYORK2015"}'' Nested objects are not supported. See [Metadata](#section/Metadata) + for more information.' + maxLength: 500 + pattern: '[^"\\]{0,500}' + type: object + x-template-config: + isComplexObject: true + base-type: + java: HashMap + use_type: + $ref: '#/components/schemas/cmp_use_type' + auto_cancel_if_ncoa: + description: Whether or not a mail piece should be automatically canceled + and not sent if the address is updated via NCOA. + type: boolean + id: + description: Unique identifier prefixed with `cmp_`. + pattern: ^cmp_[a-zA-Z0-9]+$ + title: Campaign id + type: string + account_id: + description: Account ID that this campaign is associated with. + type: string + is_draft: + default: true + description: Whether or not the campaign is still a draft. + type: boolean + creatives: + description: An array of creatives that have been associated with this campaign. + type: array + date_created: + description: A timestamp in ISO 8601 format of the date the resource was + created. + format: date-time + type: string + date_modified: + description: A timestamp in ISO 8601 format of the date the resource was + last modified. + format: date-time + type: string + deleted: + description: Only returned if the resource has been successfully deleted. + type: boolean + object: + default: campaign + description: Value is resource type. + enum: + - campaign + type: string + required: + - auto_cancel_if_ncoa + - creatives + - date_created + - date_modified + - id + - is_draft + - name + - object + - schedule_type + type: object + campaigns_list: + example: + data: + - metadata: + key: metadata + date_created: 2000-01-23T04:56:07.000+00:00 + creatives: "" + description: description + target_delivery_date: 2000-01-23T04:56:07.000+00:00 + billing_group_id: billing_group_id + account_id: account_id + deleted: true + date_modified: 2000-01-23T04:56:07.000+00:00 + send_date: 2000-01-23T04:56:07.000+00:00 + is_draft: true + auto_cancel_if_ncoa: true + name: name + cancel_window_campaign_minutes: 0 + id: id + object: campaign + - metadata: + key: metadata + date_created: 2000-01-23T04:56:07.000+00:00 + creatives: "" + description: description + target_delivery_date: 2000-01-23T04:56:07.000+00:00 + billing_group_id: billing_group_id + account_id: account_id + deleted: true + date_modified: 2000-01-23T04:56:07.000+00:00 + send_date: 2000-01-23T04:56:07.000+00:00 + is_draft: true + auto_cancel_if_ncoa: true + name: name + cancel_window_campaign_minutes: 0 + id: id + object: campaign + total_count: 1 + next_url: next_url + count: 6 + previous_url: previous_url + object: object + properties: + data: + description: list of campaigns + items: + $ref: '#/components/schemas/campaign' + type: array + x-template-config: + isComplexObject: true + base-type: + java: ArrayList + python: Campaign[] + object: + description: Value is type of resource. + type: string + next_url: + description: url of next page of items in list. + nullable: true + type: string + x-pagination-next: true + previous_url: + description: url of previous page of items in list. + nullable: true + type: string + x-pagination-previous: true + count: + description: number of resources in a set + type: integer + total_count: + description: indicates the total number of records. Provided when the request + specifies an "include" query parameter + type: integer + type: object + x-code-snippet: + campaigns: true + list: true + object_type: Campaign + curl_form: campaigns + plural_response_var: campaigns + javaSupported: true + typescriptSupported: true + plural_object_type: Campaigns + args: + - arg: 2 + notNull: true + param: limit + - arg: "null" + param: before + - arg: "null" + param: after + - arg: "null" + param: include + last: true + campaign_writable: + properties: + billing_group_id: + description: Unique identifier prefixed with `bg_`. + nullable: true + pattern: ^bg_[a-zA-Z0-9]+$ + type: string + name: + description: Name of the campaign. + type: string + description: + description: | + An internal description that identifies this resource. Must be no longer than 255 characters. + maxLength: 255 + nullable: true + type: string + schedule_type: + $ref: '#/components/schemas/cmp_schedule_type' + target_delivery_date: + description: If `schedule_type` is `target_delivery_date`, provide a targeted + delivery date for mail pieces in this campaign. + format: date-time + nullable: true + type: string + send_date: + description: If `schedule_type` is `scheduled_send_date`, provide a date + to send this campaign. + format: date-time + nullable: true + type: string + cancel_window_campaign_minutes: + description: A window, in minutes, within which the campaign can be canceled. + nullable: true + type: integer + metadata: + additionalProperties: + type: string + description: 'Use metadata to store custom information for tagging and labeling + back to your internal systems. Must be an object with up to 20 key-value + pairs. Keys must be at most 40 characters and values must be at most 500 + characters. Neither can contain the characters `"` and `\`. i.e. ''{"customer_id" + : "NEWYORK2015"}'' Nested objects are not supported. See [Metadata](#section/Metadata) + for more information.' + maxLength: 500 + pattern: '[^"\\]{0,500}' + type: object + x-template-config: + isComplexObject: true + base-type: + java: HashMap + use_type: + $ref: '#/components/schemas/cmp_use_type' + auto_cancel_if_ncoa: + description: Whether or not a mail piece should be automatically canceled + and not sent if the address is updated via NCOA. + type: boolean + required: + - name + - schedule_type + type: object + campaign_updatable: + properties: + name: + title: Name + type: string + description: + description: | + An internal description that identifies this resource. Must be no longer than 255 characters. + maxLength: 255 + nullable: true + type: string + schedule_type: + $ref: '#/components/schemas/cmp_schedule_type' + target_delivery_date: + description: If `schedule_type` is `target_delivery_date`, provide a targeted + delivery date for mail pieces in this campaign. + format: date-time + type: string + send_date: + description: If `schedule_type` is `scheduled_send_date`, provide a date + to send this campaign. + format: date-time + type: string + cancel_window_campaign_minutes: + description: A window, in minutes, within which the campaign can be canceled. + type: integer + metadata: + additionalProperties: + type: string + description: 'Use metadata to store custom information for tagging and labeling + back to your internal systems. Must be an object with up to 20 key-value + pairs. Keys must be at most 40 characters and values must be at most 500 + characters. Neither can contain the characters `"` and `\`. i.e. ''{"customer_id" + : "NEWYORK2015"}'' Nested objects are not supported. See [Metadata](#section/Metadata) + for more information.' + maxLength: 500 + pattern: '[^"\\]{0,500}' + type: object + x-template-config: + isComplexObject: true + base-type: + java: HashMap + is_draft: + default: true + description: Whether or not the campaign is still a draft. + type: boolean + use_type: + $ref: '#/components/schemas/cmp_use_type' + auto_cancel_if_ncoa: + description: Whether or not a mail piece should be automatically canceled + and not sent if the address is updated via NCOA. + type: boolean + type: object + card_id: + description: Unique identifier prefixed with `card_`. + pattern: ^card_[a-zA-Z0-9]+$ + type: string + signed_link: + description: A [signed link](#section/Asset-URLs) served over HTTPS. The link + returned will expire in 30 days to prevent mis-sharing. Each time a GET request + is initiated, a new signed URL will be generated. + pattern: ^https://(lob-assets|lob-assets-staging)\.com/(letters|postcards|bank-accounts|checks|self-mailers|cards)/[a-z]{3,4}_[a-z0-9]{15,16}(\.pdf|_thumb_[a-z]+_[0-9]+\.png)\?(version=[a-z0-9-]*&)?expires=[0-9]{10}&signature=[a-zA-Z0-9-_]+$ + type: string + thumbnail: + example: + small: small + large: large + medium: medium + properties: + small: description: A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. @@ -6272,7 +7086,8 @@ components: description: True if the cards should be auto-reordered. type: boolean reorder_quantity: - description: The number of cards to be reordered. + description: The number of cards to be reordered. Only present when auto_reorder + is True. nullable: true type: integer raw_url: @@ -6360,18 +7175,13 @@ components: required: - auto_reorder - available_quantity - - back_original_url + - card_orders - date_created - date_modified - - front_original_url - id - object - - orientation - pending_quantity - - raw_url - - reorder_quantity - - status - - threshold_amount + - size - thumbnails - url type: object @@ -6790,6 +7600,7 @@ components: type: object x-template-config: structured-incompatible: true + null: true location: description: | The zip code in which the scan event occurred. Null for `Mailed` events. @@ -7467,10 +8278,10 @@ components: default: true isRef: true - base-type2: - java: AddressEditable - python: AddressEditable - typescript: Models.AddressEditable - python_path: lob_python.model.address_editable + java: AddressDomestic + python: AddressDomestic + typescript: Models.AddressDomestic + python_path: lob_python.model.address_domestic hasPath: true to: description: Must either be an address ID or an inline object with correct @@ -7501,6 +8312,7 @@ components: logo: description: Accepts a remote URL or local file upload to an image to print (in grayscale) in the upper-left corner of your check. + type: string check_bottom: description: |- The artwork to use on the bottom of the check page. @@ -7699,15 +8511,22 @@ components: intlAutocompletion: true address: - key: address_prefix + pascal_case_key: AddressPrefix val: 340 Wat - key: city + pascal_case_key: City val: Summerside - key: state + pascal_case_key: State val: Prince Edward Island - key: zip_code + pascal_case_key: ZipCode val: C1N 1C4 - key: country + pascal_case_key: Country val: CA + java_val: CountryExtended.CA + javaNonString: true intl_auto_id: description: Unique identifier prefixed with `intl_auto_`. pattern: ^intl_auto_[a-zA-Z0-9]+$ @@ -7722,6 +8541,7 @@ components: intl_suggestions: example: primary_number_range: primary_number_range + country: AD primary_line: primary_line city: city state: state @@ -7755,7 +8575,228 @@ components: The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. type: string country: - $ref: '#/components/schemas/country_extended' + description: Must be a 2 letter country short-name code (ISO 3166). + enum: + - AD + - AE + - AF + - AG + - AI + - AL + - AN + - AO + - AQ + - AR + - AT + - AU + - AW + - AZ + - BA + - BB + - BD + - BE + - BF + - BG + - BH + - BI + - BJ + - BM + - BN + - BO + - BQ + - BR + - BS + - BT + - BW + - BY + - BZ + - CA + - CD + - CG + - CH + - CI + - CK + - CL + - CM + - CN + - CO + - CR + - CS + - CU + - CV + - CW + - CY + - CZ + - DE + - DJ + - DK + - DM + - DO + - DZ + - EC + - EE + - EG + - EH + - ER + - ES + - ET + - FI + - FJ + - FK + - FO + - FR + - GA + - GB + - GD + - GE + - GH + - GI + - GL + - GM + - GN + - GQ + - GR + - GS + - GT + - GW + - GY + - HK + - HN + - HR + - HT + - HU + - ID + - IE + - IL + - IN + - IO + - IQ + - IR + - IS + - IT + - JM + - JO + - JP + - KE + - KG + - KH + - KI + - KM + - KN + - KP + - KR + - KW + - KY + - KZ + - LA + - LB + - LC + - LI + - LK + - LR + - LS + - LT + - LU + - LV + - LY + - MA + - MC + - MD + - ME + - MG + - MK + - ML + - MM + - MN + - MO + - MR + - MS + - MT + - MU + - MV + - MW + - MX + - MY + - MZ + - NA + - NE + - NF + - NG + - NI + - NL + - "NO" + - NP + - NR + - NU + - NZ + - OM + - PA + - PE + - PG + - PH + - PK + - PL + - PN + - PT + - PY + - QA + - RO + - RS + - RU + - RW + - SA + - SB + - SC + - SD + - SE + - SG + - SH + - SI + - SK + - SL + - SM + - SN + - SO + - SR + - SS + - ST + - SV + - SX + - SY + - SZ + - TC + - TD + - TG + - TH + - TJ + - TK + - TL + - TM + - TN + - TO + - TR + - TT + - TV + - TW + - TZ + - UA + - UG + - US + - UY + - UZ + - VA + - VC + - VE + - VG + - VN + - VU + - WS + - YE + - ZA + - ZM + - ZW + nullable: true + type: string zip_code: description: A 5-digit zip code. Left empty if a test key is used. type: string @@ -7777,30 +8818,35 @@ components: example: suggestions: - primary_number_range: primary_number_range + country: AD primary_line: primary_line city: city state: state zip_code: zip_code object: intl_autocompletion - primary_number_range: primary_number_range + country: AD primary_line: primary_line city: city state: state zip_code: zip_code object: intl_autocompletion - primary_number_range: primary_number_range + country: AD primary_line: primary_line city: city state: state zip_code: zip_code object: intl_autocompletion - primary_number_range: primary_number_range + country: AD primary_line: primary_line city: city state: state zip_code: zip_code object: intl_autocompletion - primary_number_range: primary_number_range + country: AD primary_line: primary_line city: city state: state @@ -7877,6 +8923,9 @@ components: - key: postal_code val: C1N 1C4 pascal_key: PostalCode + - key: country + val: CA + pascal_key: Country intl_verification: example: last_line: last_line @@ -8022,25 +9071,6 @@ components: python: AddressEditable python_path: lob_python.model.address_editable hasPath: true - return_envelope: - example: - alias: alias - id: id - url: url - object: object - properties: - id: - description: The unique ID of the Return Envelope - type: string - alias: - description: A quick reference name for the Return Envelope - type: string - url: - description: The url of the return envelope - type: string - object: - type: string - type: object letter: example: metadata: @@ -8049,11 +9079,7 @@ components: expected_delivery_date: 2000-01-23 description: description extra_service: extra_service - return_envelope: - alias: alias - id: id - url: url - object: object + return_envelope: "" perforated_page: 0 send_date: 2000-01-23T04:56:07.000+00:00 tracking_events: [] @@ -8298,7 +9324,23 @@ components: - bottom_first_page type: string return_envelope: - $ref: '#/components/schemas/return_envelope' + x-template-config: + isOneOf: true + type-composite: + - base-type1: + java: Boolean + typescript: boolean + python: bool + hasPath: false + default: true + - base-type2: + java: ReturnEnvelope + typescript: Models.ReturnEnvelope + python: ReturnEnvelope + hasPath: true + python_path: lob_python.model.return_envelope + isRef: true + default: false perforated_page: description: Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must @@ -8315,6 +9357,7 @@ components: - from - id - object + - return_envelope - to type: object x-code-snippet: @@ -8368,11 +9411,7 @@ components: expected_delivery_date: 2000-01-23 description: description extra_service: extra_service - return_envelope: - alias: alias - id: id - url: url - object: object + return_envelope: "" perforated_page: 0 send_date: 2000-01-23T04:56:07.000+00:00 tracking_events: [] @@ -8444,11 +9483,7 @@ components: expected_delivery_date: 2000-01-23 description: description extra_service: extra_service - return_envelope: - alias: alias - id: id - url: url - object: object + return_envelope: "" perforated_page: 0 send_date: 2000-01-23T04:56:07.000+00:00 tracking_events: [] @@ -9829,9 +10864,9 @@ components: time: 2000-01-23T04:56:07.000+00:00 type: certified object: tracking_event - from: from + from: "" id: id - to: to + to: "" object: self_mailer properties: id: @@ -9839,9 +10874,8 @@ components: pattern: ^sfm_[a-zA-Z0-9]+$ type: string to: - description: Must either be an address ID or an inline object with correct - address parameters. - type: string + allOf: + - $ref: '#/components/schemas/address' x-template-config: isOneOf: true type-composite: @@ -9852,15 +10886,14 @@ components: default: true isRef: true - base-type2: - java: AddressEditable - python: AddressEditable - typescript: Models.AddressEditable - python_path: lob_python.model.address_editable + java: Address + python: Address + typescript: Models.Address + python_path: lob_python.model.address hasPath: true from: - description: Must either be an address ID or an inline object with correct - address parameters. - type: string + allOf: + - $ref: '#/components/schemas/address_domestic_expanded' x-template-config: isOneOf: true type-composite: @@ -9871,9 +10904,9 @@ components: default: true isRef: true - base-type2: - java: AddressEditable - python: AddressEditable - typescript: Models.AddressEditable + java: Address + python: Address + typescript: Models.Address hasPath: false size: $ref: '#/components/schemas/self_mailer_size' @@ -9981,7 +11014,9 @@ components: pattern: ^https://(lob-assets|lob-assets-staging)\.com/(letters|postcards|bank-accounts|checks|self-mailers|cards)/[a-z]{3,4}_[a-z0-9]{15,16}(\.pdf|_thumb_[a-z]+_[0-9]+\.png)\?(version=[a-z0-9-]*&)?expires=[0-9]{10}&signature=[a-zA-Z0-9-_]+$ type: string required: + - carrier - id + - to - url type: object x-code-snippet: @@ -10065,9 +11100,9 @@ components: time: 2000-01-23T04:56:07.000+00:00 type: certified object: tracking_event - from: from + from: "" id: id - to: to + to: "" object: self_mailer - merge_variables: '{}' metadata: @@ -10106,9 +11141,9 @@ components: time: 2000-01-23T04:56:07.000+00:00 type: certified object: tracking_event - from: from + from: "" id: id - to: to + to: "" object: self_mailer total_count: 6 next_url: next_url @@ -11557,6 +12592,142 @@ components: - object - zip_code_type type: object + return_envelope: + example: + alias: alias + id: id + url: url + object: object + properties: + id: + description: The unique ID of the Return Envelope + type: string + alias: + description: A quick reference name for the Return Envelope + type: string + url: + description: The url of the return envelope + type: string + object: + type: string + type: object + address_domestic: + example: + metadata: + key: metadata + address_line2: address_line2 + address_line1: address_line1 + phone: phone + address_country: address_country + address_state: address_state + name: name + description: description + company: company + address_zip: address_zip + email: email + address_city: address_city + properties: + address_line1: + description: The building number, street name, street suffix, and any street + directionals. For US addresses, the max length is 64 characters. + maxLength: 200 + type: string + address_line2: + description: The suite or apartment number of the recipient address, if + applicable. For US addresses, the max length is 64 characters. + maxLength: 200 + nullable: true + type: string + address_city: + maxLength: 200 + nullable: true + type: string + address_state: + maxLength: 200 + nullable: true + type: string + address_zip: + description: Optional postal code. For US addresses, must be either 5 or + 9 digits. + maxLength: 40 + nullable: true + type: string + description: + description: | + An internal description that identifies this resource. Must be no longer than 255 characters. + maxLength: 255 + nullable: true + type: string + name: + description: | + Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address. + maxLength: 40 + nullable: true + type: string + company: + description: Either `name` or `company` is required, you may also add both. + maxLength: 40 + nullable: true + type: string + phone: + description: Must be no longer than 40 characters. + maxLength: 40 + nullable: true + type: string + email: + description: Must be no longer than 100 characters. + maxLength: 100 + nullable: true + type: string + address_country: + description: The country associated with this address. + nullable: true + pattern: US + type: string + metadata: + additionalProperties: + type: string + description: 'Use metadata to store custom information for tagging and labeling + back to your internal systems. Must be an object with up to 20 key-value + pairs. Keys must be at most 40 characters and values must be at most 500 + characters. Neither can contain the characters `"` and `\`. i.e. ''{"customer_id" + : "NEWYORK2015"}'' Nested objects are not supported. See [Metadata](#section/Metadata) + for more information.' + maxLength: 500 + pattern: '[^"\\]{0,500}' + type: object + x-template-config: + isComplexObject: true + base-type: + java: HashMap + type: object + placeholder_model: + example: + address_domestic: + metadata: + key: metadata + address_line2: address_line2 + address_line1: address_line1 + phone: phone + address_country: address_country + address_state: address_state + name: name + description: description + company: company + address_zip: address_zip + email: email + address_city: address_city + return_envelope: + alias: alias + id: id + url: url + object: object + properties: + return_envelope: + $ref: '#/components/schemas/return_envelope' + address_domestic: + $ref: '#/components/schemas/address_domestic' + type: object event_type: properties: id: diff --git a/docs/AddressesApi.md b/docs/AddressesApi.md index a2bd74b5..bd46ab68 100755 --- a/docs/AddressesApi.md +++ b/docs/AddressesApi.md @@ -243,7 +243,7 @@ public class Example { String before = "before_example"; // String | 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. String after = "after_example"; // String | 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. List include = Arrays.asList(); // List | Request that the response include the total count by specifying `include[]=total_count`. - Map dateCreated = new HashMap(); // Map | Filter by date created. + Map dateCreated = new HashMap(); // Map | Filter by date created. Map metadata = new HashMap(); // Map | Filter by metadata key-value pair`. try { AddressList result = apiInstance.list(limit, before, after, include, dateCreated, metadata); @@ -266,7 +266,7 @@ Name | Type | Description | Notes **before** | **String**| 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. | [optional] **after** | **String**| 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. | [optional] **include** | [**List<String>**](String.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] - **dateCreated** | [**Map<String, String>**](String.md)| Filter by date created. | [optional] + **dateCreated** | [**Map<String, OffsetDateTime>**](OffsetDateTime.md)| Filter by date created. | [optional] **metadata** | [**Map<String, String>**](String.md)| Filter by metadata key-value pair`. | [optional] ### Return type diff --git a/docs/BankAccountsApi.md b/docs/BankAccountsApi.md index 16da31b5..58c33f87 100755 --- a/docs/BankAccountsApi.md +++ b/docs/BankAccountsApi.md @@ -313,7 +313,7 @@ public class Example { String before = "before_example"; // String | 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. String after = "after_example"; // String | 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. List include = Arrays.asList(); // List | Request that the response include the total count by specifying `include[]=total_count`. - Map dateCreated = new HashMap(); // Map | Filter by date created. + Map dateCreated = new HashMap(); // Map | Filter by date created. Map metadata = new HashMap(); // Map | Filter by metadata key-value pair`. try { BankAccountList result = apiInstance.list(limit, before, after, include, dateCreated, metadata); @@ -336,7 +336,7 @@ Name | Type | Description | Notes **before** | **String**| 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. | [optional] **after** | **String**| 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. | [optional] **include** | [**List<String>**](String.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] - **dateCreated** | [**Map<String, String>**](String.md)| Filter by date created. | [optional] + **dateCreated** | [**Map<String, OffsetDateTime>**](OffsetDateTime.md)| Filter by date created. | [optional] **metadata** | [**Map<String, String>**](String.md)| Filter by metadata key-value pair`. | [optional] ### Return type diff --git a/docs/BillingGroupsApi.md b/docs/BillingGroupsApi.md index aea24cb1..b0726dbc 100755 --- a/docs/BillingGroupsApi.md +++ b/docs/BillingGroupsApi.md @@ -244,7 +244,7 @@ public class Example { Integer limit = 10; // Integer | How many results to return. Integer offset = 0; // Integer | An integer that designates the offset at which to begin returning results. Defaults to 0. List include = Arrays.asList(); // List | Request that the response include the total count by specifying `include[]=total_count`. - Map dateCreated = new HashMap(); // Map | Filter by date created. + Map dateCreated = new HashMap(); // Map | Filter by date created. Map dateModified = new HashMap(); // Map | Filter by date modified. SortBy5 sortBy = new HashMap(); // SortBy5 | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. try { @@ -267,7 +267,7 @@ Name | Type | Description | Notes **limit** | **Integer**| How many results to return. | [optional] [default to 10] **offset** | **Integer**| An integer that designates the offset at which to begin returning results. Defaults to 0. | [optional] [default to 0] **include** | [**List<String>**](String.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] - **dateCreated** | [**Map<String, String>**](String.md)| Filter by date created. | [optional] + **dateCreated** | [**Map<String, OffsetDateTime>**](OffsetDateTime.md)| Filter by date created. | [optional] **dateModified** | [**Map<String, String>**](String.md)| Filter by date modified. | [optional] **sortBy** | [**SortBy5**](.md)| Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. | [optional] diff --git a/docs/Campaign.md b/docs/Campaign.md new file mode 100644 index 00000000..d4414d5b --- /dev/null +++ b/docs/Campaign.md @@ -0,0 +1,38 @@ + + +# Campaign + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**billingGroupId** | **String** | Unique identifier prefixed with `bg_`. | [optional] +**name** | **String** | Name of the campaign. | +**description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**scheduleType** | **CmpScheduleType** | | +**targetDeliveryDate** | **OffsetDateTime** | If `schedule_type` is `target_delivery_date`, provide a targeted delivery date for mail pieces in this campaign. | [optional] +**sendDate** | **OffsetDateTime** | If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign. | [optional] +**cancelWindowCampaignMinutes** | **Integer** | A window, in minutes, within which the campaign can be canceled. | [optional] +**metadata** | **Map<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**useType** | **CmpUseType** | | [optional] +**autoCancelIfNcoa** | **Boolean** | Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA. | +**id** | **String** | Unique identifier prefixed with `cmp_`. | +**accountId** | **String** | Account ID that this campaign is associated with. | [optional] +**isDraft** | **Boolean** | Whether or not the campaign is still a draft. | +**creatives** | **List** | An array of creatives that have been associated with this campaign. | +**dateCreated** | **OffsetDateTime** | A timestamp in ISO 8601 format of the date the resource was created. | +**dateModified** | **OffsetDateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | +**deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] +**_object** | [**ObjectEnum**](#ObjectEnum) | Value is resource type. | + + + +## Enum: ObjectEnum + +Name | Value +---- | ----- +CAMPAIGN | "campaign" + + + diff --git a/docs/CampaignUpdatable.md b/docs/CampaignUpdatable.md new file mode 100644 index 00000000..57f5b511 --- /dev/null +++ b/docs/CampaignUpdatable.md @@ -0,0 +1,22 @@ + + +# CampaignUpdatable + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | | [optional] +**description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**scheduleType** | **CmpScheduleType** | | [optional] +**targetDeliveryDate** | **OffsetDateTime** | If `schedule_type` is `target_delivery_date`, provide a targeted delivery date for mail pieces in this campaign. | [optional] +**sendDate** | **OffsetDateTime** | If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign. | [optional] +**cancelWindowCampaignMinutes** | **Integer** | A window, in minutes, within which the campaign can be canceled. | [optional] +**metadata** | **Map<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**isDraft** | **Boolean** | Whether or not the campaign is still a draft. | [optional] +**useType** | **CmpUseType** | | [optional] +**autoCancelIfNcoa** | **Boolean** | Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA. | [optional] + + + diff --git a/docs/CampaignWritable.md b/docs/CampaignWritable.md new file mode 100644 index 00000000..e32402bf --- /dev/null +++ b/docs/CampaignWritable.md @@ -0,0 +1,22 @@ + + +# CampaignWritable + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**billingGroupId** | **String** | Unique identifier prefixed with `bg_`. | [optional] +**name** | **String** | Name of the campaign. | +**description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**scheduleType** | **CmpScheduleType** | | +**targetDeliveryDate** | **OffsetDateTime** | If `schedule_type` is `target_delivery_date`, provide a targeted delivery date for mail pieces in this campaign. | [optional] +**sendDate** | **OffsetDateTime** | If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign. | [optional] +**cancelWindowCampaignMinutes** | **Integer** | A window, in minutes, within which the campaign can be canceled. | [optional] +**metadata** | **Map<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**useType** | **CmpUseType** | | [optional] +**autoCancelIfNcoa** | **Boolean** | Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA. | [optional] + + + diff --git a/docs/CampaignsApi.md b/docs/CampaignsApi.md new file mode 100644 index 00000000..6a49ff3f --- /dev/null +++ b/docs/CampaignsApi.md @@ -0,0 +1,357 @@ +# CampaignsApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create**](CampaignsApi.md#create) | **POST** /campaigns | create +[**delete**](CampaignsApi.md#delete) | **DELETE** /campaigns/{cmp_id} | delete +[**get**](CampaignsApi.md#get) | **GET** /campaigns/{cmp_id} | get +[**update**](CampaignsApi.md#update) | **PATCH** /campaigns/{cmp_id} | update +[**list**](CampaignsApi.md#list) | **GET** /campaigns | list + + + +# **create** +> Campaign create(campaignWritable, xLangOutput) + +create + +Creates a new campaign with the provided properties. See how to launch your first campaign [here](https://help.lob.com/best-practices/launching-your-first-campaign). + +### Example +```java +// Import classes: +import com.lob.api.ApiClient; +import com.lob.api.ApiException; +import com.lob.api.Configuration; +import com.lob.api.auth.*; +import com.lob.api.models.*; +import com.lob.api.client.CampaignsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.lob.com/v1"); + + // Configure HTTP basic authorization: basicAuth + HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); + basicAuth.setUsername("LOB_API_KEY"); + + CampaignsApi apiInstance = new CampaignsApi(defaultClient); + CampaignWritable campaignWritable = new CampaignWritable(); // CampaignWritable | + String xLangOutput = "native"; // String | * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. + try { + Campaign result = apiInstance.create(campaignWritable, xLangOutput); + } catch (ApiException e) { + System.err.println("Exception when calling CampaignsApi#create"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **campaignWritable** | [**CampaignWritable**](CampaignWritable.md)| | + **xLangOutput** | **String**| * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. | [optional] [enum: native, match] + +### Return type + +[**Campaign**](Campaign.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Campaign created successfully | - | +**0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + + +# **delete** +> Object delete(cmpId) + +delete + +Delete an existing campaign. You need only supply the unique identifier that was returned upon campaign creation. Deleting a campaign also deletes any associated mail pieces that have been created but not sent. A campaign's `send_date` matches its associated mail pieces' `send_date`s. + +### Example +```java +// Import classes: +import com.lob.api.ApiClient; +import com.lob.api.ApiException; +import com.lob.api.Configuration; +import com.lob.api.auth.*; +import com.lob.api.models.*; +import com.lob.api.client.CampaignsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.lob.com/v1"); + + // Configure HTTP basic authorization: basicAuth + HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); + basicAuth.setUsername("LOB_API_KEY"); + + CampaignsApi apiInstance = new CampaignsApi(defaultClient); + String cmpId = "cmpId_example"; // String | id of the campaign + try { + Object result = apiInstance.delete(cmpId); + } catch (ApiException e) { + System.err.println("Exception when calling CampaignsApi#delete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cmpId** | **String**| id of the campaign | + +### Return type + +**Object** + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Deleted the campaign. | - | +**0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + + +# **get** +> Campaign get(cmpId) + +get + +Retrieves the details of an existing campaign. You need only supply the unique campaign identifier that was returned upon campaign creation. + +### Example +```java +// Import classes: +import com.lob.api.ApiClient; +import com.lob.api.ApiException; +import com.lob.api.Configuration; +import com.lob.api.auth.*; +import com.lob.api.models.*; +import com.lob.api.client.CampaignsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.lob.com/v1"); + + // Configure HTTP basic authorization: basicAuth + HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); + basicAuth.setUsername("LOB_API_KEY"); + + CampaignsApi apiInstance = new CampaignsApi(defaultClient); + String cmpId = "cmpId_example"; // String | id of the campaign + try { + Campaign result = apiInstance.get(cmpId); + } catch (ApiException e) { + System.err.println("Exception when calling CampaignsApi#get"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cmpId** | **String**| id of the campaign | + +### Return type + +[**Campaign**](Campaign.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Returns a campaign object | - | +**0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + + +# **update** +> Campaign update(cmpId, campaignUpdatable) + +update + +Update the details of an existing campaign. You need only supply the unique identifier that was returned upon campaign creation. + +### Example +```java +// Import classes: +import com.lob.api.ApiClient; +import com.lob.api.ApiException; +import com.lob.api.Configuration; +import com.lob.api.auth.*; +import com.lob.api.models.*; +import com.lob.api.client.CampaignsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.lob.com/v1"); + + // Configure HTTP basic authorization: basicAuth + HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); + basicAuth.setUsername("LOB_API_KEY"); + + CampaignsApi apiInstance = new CampaignsApi(defaultClient); + String cmpId = "cmpId_example"; // String | id of the campaign + CampaignUpdatable campaignUpdatable = new CampaignUpdatable(); // CampaignUpdatable | + try { + Campaign result = apiInstance.update(cmpId, campaignUpdatable); + } catch (ApiException e) { + System.err.println("Exception when calling CampaignsApi#update"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cmpId** | **String**| id of the campaign | + **campaignUpdatable** | [**CampaignUpdatable**](CampaignUpdatable.md)| | + +### Return type + +[**Campaign**](Campaign.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Returns a campaign object | - | +**0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + + +# **list** +> CampaignsList list(limit, include, before, after) + +list + +Returns a list of your campaigns. The campaigns are returned sorted by creation date, with the most recently created campaigns appearing first. + +### Example +```java +// Import classes: +import com.lob.api.ApiClient; +import com.lob.api.ApiException; +import com.lob.api.Configuration; +import com.lob.api.auth.*; +import com.lob.api.models.*; +import com.lob.api.client.CampaignsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.lob.com/v1"); + + // Configure HTTP basic authorization: basicAuth + HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); + basicAuth.setUsername("LOB_API_KEY"); + + CampaignsApi apiInstance = new CampaignsApi(defaultClient); + Integer limit = 10; // Integer | How many results to return. + List include = Arrays.asList(); // List | Request that the response include the total count by specifying `include[]=total_count`. + String before = "before_example"; // String | 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. + String after = "after_example"; // String | 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. + try { + CampaignsList result = apiInstance.list(limit, include, before, after); + } catch (ApiException e) { + System.err.println("Exception when calling CampaignsApi#list"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **Integer**| How many results to return. | [optional] [default to 10] + **include** | [**List<String>**](String.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] + **before** | **String**| 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. | [optional] + **after** | **String**| 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. | [optional] + +### Return type + +[**CampaignsList**](CampaignsList.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A dictionary with a data property that contains an array of up to `limit` campaigns. Each entry in the array is a separate letter. The previous and next page of campaigns can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively. If no more campaigns are available beyond the current set of returned results, the `next_url` field will be empty. | - | + diff --git a/docs/CampaignsList.md b/docs/CampaignsList.md new file mode 100644 index 00000000..8137c570 --- /dev/null +++ b/docs/CampaignsList.md @@ -0,0 +1,18 @@ + + +# CampaignsList + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**List<Campaign>**](Campaign.md) | list of campaigns | [optional] +**_object** | **String** | Value is type of resource. | [optional] +**nextUrl** | **String** | url of next page of items in list. | [optional] +**previousUrl** | **String** | url of previous page of items in list. | [optional] +**count** | **Integer** | number of resources in a set | [optional] +**totalCount** | **Integer** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] + + + diff --git a/docs/Card.md b/docs/Card.md index e53b1634..9c700bc6 100755 --- a/docs/Card.md +++ b/docs/Card.md @@ -10,22 +10,22 @@ Name | Type | Description | Notes **id** | **String** | Unique identifier prefixed with `card_`. | **url** | **URI** | The signed link for the card. | **autoReorder** | **Boolean** | True if the cards should be auto-reordered. | -**reorderQuantity** | **Integer** | The number of cards to be reordered. | -**rawUrl** | **URI** | The raw URL of the card. | -**frontOriginalUrl** | **URI** | The original URL of the front template. | -**backOriginalUrl** | **URI** | The original URL of the back template. | +**reorderQuantity** | **Integer** | The number of cards to be reordered. Only present when auto_reorder is True. | [optional] +**rawUrl** | **URI** | The raw URL of the card. | [optional] +**frontOriginalUrl** | **URI** | The original URL of the front template. | [optional] +**backOriginalUrl** | **URI** | The original URL of the back template. | [optional] **thumbnails** | [**List<Thumbnail>**](Thumbnail.md) | | **availableQuantity** | **Integer** | The available quantity of cards. | **pendingQuantity** | **Integer** | The pending quantity of cards. | -**status** | [**StatusEnum**](#StatusEnum) | | -**orientation** | [**OrientationEnum**](#OrientationEnum) | The orientation of the card. | -**thresholdAmount** | **Integer** | The threshold amount of the card | +**status** | [**StatusEnum**](#StatusEnum) | | [optional] +**orientation** | [**OrientationEnum**](#OrientationEnum) | The orientation of the card. | [optional] +**thresholdAmount** | **Integer** | The threshold amount of the card | [optional] **dateCreated** | **OffsetDateTime** | A timestamp in ISO 8601 format of the date the resource was created. | **dateModified** | **OffsetDateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] **_object** | [**ObjectEnum**](#ObjectEnum) | object | **description** | **String** | Description of the card. | [optional] -**size** | [**SizeEnum**](#SizeEnum) | The size of the card | [optional] +**size** | [**SizeEnum**](#SizeEnum) | The size of the card | diff --git a/docs/CheckEditable.md b/docs/CheckEditable.md index a0e5bbac..32d4ead5 100755 --- a/docs/CheckEditable.md +++ b/docs/CheckEditable.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **to** | **String** | Must either be an address ID or an inline object with correct address parameters. | **bankAccount** | **String** | | **amount** | **Float** | The payment amount to be sent in US dollars. | -**logo** | **Object** | Accepts a remote URL or local file upload to an image to print (in grayscale) in the upper-left corner of your check. | [optional] +**logo** | **String** | Accepts a remote URL or local file upload to an image to print (in grayscale) in the upper-left corner of your check. | [optional] **checkBottom** | **String** | The artwork to use on the bottom of the check page. 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 and trimmed to fit on a 8.5\"x11\" page. - The check bottom will always be printed in black & white. - Must conform to [this template](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/check_bottom_template.pdf). Need more help? Consult our [HTML examples](#section/HTML-Examples). | [optional] **attachment** | **String** | A document to include with the check. | [optional] **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] diff --git a/docs/ChecksApi.md b/docs/ChecksApi.md index b9d28b59..7559227c 100755 --- a/docs/ChecksApi.md +++ b/docs/ChecksApi.md @@ -245,7 +245,7 @@ public class Example { String before = "before_example"; // String | 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. String after = "after_example"; // String | 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. List include = Arrays.asList(); // List | Request that the response include the total count by specifying `include[]=total_count`. - Map dateCreated = new HashMap(); // Map | Filter by date created. + Map dateCreated = new HashMap(); // Map | Filter by date created. Map metadata = new HashMap(); // Map | Filter by metadata key-value pair`. Boolean scheduled = true; // Boolean | * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` Map sendDate = new HashMap(); // Map | Filter by date sent. @@ -272,7 +272,7 @@ Name | Type | Description | Notes **before** | **String**| 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. | [optional] **after** | **String**| 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. | [optional] **include** | [**List<String>**](String.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] - **dateCreated** | [**Map<String, String>**](String.md)| Filter by date created. | [optional] + **dateCreated** | [**Map<String, OffsetDateTime>**](OffsetDateTime.md)| Filter by date created. | [optional] **metadata** | [**Map<String, String>**](String.md)| Filter by metadata key-value pair`. | [optional] **scheduled** | **Boolean**| * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` | [optional] **sendDate** | [**Map<String, String>**](String.md)| Filter by date sent. | [optional] diff --git a/docs/CmpScheduleType.md b/docs/CmpScheduleType.md new file mode 100644 index 00000000..bfa51122 --- /dev/null +++ b/docs/CmpScheduleType.md @@ -0,0 +1,11 @@ + + +# CmpScheduleType + +## Enum + + +* `IMMEDIATE` (value: `"immediate"`) + + + diff --git a/docs/CmpUseType.md b/docs/CmpUseType.md new file mode 100644 index 00000000..e11607aa --- /dev/null +++ b/docs/CmpUseType.md @@ -0,0 +1,15 @@ + + +# CmpUseType + +## Enum + + +* `MARKETING` (value: `"marketing"`) + +* `OPERATIONAL` (value: `"operational"`) + +* `NULL` (value: `"null"`) + + + diff --git a/docs/DefaultApi.md b/docs/DefaultApi.md new file mode 100644 index 00000000..ebc3814f --- /dev/null +++ b/docs/DefaultApi.md @@ -0,0 +1,71 @@ +# DefaultApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**placeholder_no_call**](DefaultApi.md#placeholder_no_call) | **GET** /shared_dont_call | placeholder_no_call + + + +# **placeholder_no_call** +> PlaceholderModel placeholder_no_call() + +placeholder_no_call + +Don't call this. It's so that the right models can be generated. + +### Example +```java +// Import classes: +import com.lob.api.ApiClient; +import com.lob.api.ApiException; +import com.lob.api.Configuration; +import com.lob.api.auth.*; +import com.lob.api.models.*; +import com.lob.api.client.DefaultApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.lob.com/v1"); + + // Configure HTTP basic authorization: basicAuth + HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); + basicAuth.setUsername("LOB_API_KEY"); + + DefaultApi apiInstance = new DefaultApi(defaultClient); + try { + PlaceholderModel result = apiInstance.placeholder_no_call(); + } catch (ApiException e) { + System.err.println("Exception when calling DefaultApi#placeholder_no_call"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**PlaceholderModel**](PlaceholderModel.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Uncallable, used for generating missing models | - | + diff --git a/docs/IntlSuggestions.md b/docs/IntlSuggestions.md index 50903405..b296e11d 100755 --- a/docs/IntlSuggestions.md +++ b/docs/IntlSuggestions.md @@ -11,12 +11,237 @@ Name | Type | Description | Notes **primaryLine** | **String** | The primary delivery line (usually the street address) of the address. Combination of the following applicable `components` (primary number & secondary information may be missing or inaccurate): * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` | **city** | **String** | | **state** | **String** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. | -**country** | **CountryExtended** | | +**country** | [**CountryEnum**](#CountryEnum) | Must be a 2 letter country short-name code (ISO 3166). | **zipCode** | **String** | A 5-digit zip code. Left empty if a test key is used. | **_object** | [**ObjectEnum**](#ObjectEnum) | Value is resource type. | [optional] +## Enum: CountryEnum + +Name | Value +---- | ----- +AD | "AD" +AE | "AE" +AF | "AF" +AG | "AG" +AI | "AI" +AL | "AL" +AN | "AN" +AO | "AO" +AQ | "AQ" +AR | "AR" +AT | "AT" +AU | "AU" +AW | "AW" +AZ | "AZ" +BA | "BA" +BB | "BB" +BD | "BD" +BE | "BE" +BF | "BF" +BG | "BG" +BH | "BH" +BI | "BI" +BJ | "BJ" +BM | "BM" +BN | "BN" +BO | "BO" +BQ | "BQ" +BR | "BR" +BS | "BS" +BT | "BT" +BW | "BW" +BY | "BY" +BZ | "BZ" +CA | "CA" +CD | "CD" +CG | "CG" +CH | "CH" +CI | "CI" +CK | "CK" +CL | "CL" +CM | "CM" +CN | "CN" +CO | "CO" +CR | "CR" +CS | "CS" +CU | "CU" +CV | "CV" +CW | "CW" +CY | "CY" +CZ | "CZ" +DE | "DE" +DJ | "DJ" +DK | "DK" +DM | "DM" +DO | "DO" +DZ | "DZ" +EC | "EC" +EE | "EE" +EG | "EG" +EH | "EH" +ER | "ER" +ES | "ES" +ET | "ET" +FI | "FI" +FJ | "FJ" +FK | "FK" +FO | "FO" +FR | "FR" +GA | "GA" +GB | "GB" +GD | "GD" +GE | "GE" +GH | "GH" +GI | "GI" +GL | "GL" +GM | "GM" +GN | "GN" +GQ | "GQ" +GR | "GR" +GS | "GS" +GT | "GT" +GW | "GW" +GY | "GY" +HK | "HK" +HN | "HN" +HR | "HR" +HT | "HT" +HU | "HU" +ID | "ID" +IE | "IE" +IL | "IL" +IN | "IN" +IO | "IO" +IQ | "IQ" +IR | "IR" +IS | "IS" +IT | "IT" +JM | "JM" +JO | "JO" +JP | "JP" +KE | "KE" +KG | "KG" +KH | "KH" +KI | "KI" +KM | "KM" +KN | "KN" +KP | "KP" +KR | "KR" +KW | "KW" +KY | "KY" +KZ | "KZ" +LA | "LA" +LB | "LB" +LC | "LC" +LI | "LI" +LK | "LK" +LR | "LR" +LS | "LS" +LT | "LT" +LU | "LU" +LV | "LV" +LY | "LY" +MA | "MA" +MC | "MC" +MD | "MD" +ME | "ME" +MG | "MG" +MK | "MK" +ML | "ML" +MM | "MM" +MN | "MN" +MO | "MO" +MR | "MR" +MS | "MS" +MT | "MT" +MU | "MU" +MV | "MV" +MW | "MW" +MX | "MX" +MY | "MY" +MZ | "MZ" +NA | "NA" +NE | "NE" +NF | "NF" +NG | "NG" +NI | "NI" +NL | "NL" +NO | "NO" +NP | "NP" +NR | "NR" +NU | "NU" +NZ | "NZ" +OM | "OM" +PA | "PA" +PE | "PE" +PG | "PG" +PH | "PH" +PK | "PK" +PL | "PL" +PN | "PN" +PT | "PT" +PY | "PY" +QA | "QA" +RO | "RO" +RS | "RS" +RU | "RU" +RW | "RW" +SA | "SA" +SB | "SB" +SC | "SC" +SD | "SD" +SE | "SE" +SG | "SG" +SH | "SH" +SI | "SI" +SK | "SK" +SL | "SL" +SM | "SM" +SN | "SN" +SO | "SO" +SR | "SR" +SS | "SS" +ST | "ST" +SV | "SV" +SX | "SX" +SY | "SY" +SZ | "SZ" +TC | "TC" +TD | "TD" +TG | "TG" +TH | "TH" +TJ | "TJ" +TK | "TK" +TL | "TL" +TM | "TM" +TN | "TN" +TO | "TO" +TR | "TR" +TT | "TT" +TV | "TV" +TW | "TW" +TZ | "TZ" +UA | "UA" +UG | "UG" +US | "US" +UY | "UY" +UZ | "UZ" +VA | "VA" +VC | "VC" +VE | "VE" +VG | "VG" +VN | "VN" +VU | "VU" +WS | "WS" +YE | "YE" +ZA | "ZA" +ZM | "ZM" +ZW | "ZW" + + + ## Enum: ObjectEnum Name | Value diff --git a/docs/Letter.md b/docs/Letter.md index 2085c4e0..0fbe53de 100755 --- a/docs/Letter.md +++ b/docs/Letter.md @@ -31,7 +31,7 @@ Name | Type | Description | Notes **color** | **Boolean** | 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. | [optional] **doubleSided** | **Boolean** | Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. | [optional] **addressPlacement** | [**AddressPlacementEnum**](#AddressPlacementEnum) | Specifies the location of the address information that will show through the double-window envelope. To see how this will impact your letter design, view our letter template. * `top_first_page` - (default) print address information at the top of your provided first page * `insert_blank_page` - insert a blank address page at the beginning of your file (you will be charged for the extra page) * `bottom_first_page_center` - **(deprecation planned within a few months)** print address information at the bottom center of your provided first page * `bottom_first_page` - print address information at the bottom of your provided first page | [optional] -**returnEnvelope** | [**ReturnEnvelope**](ReturnEnvelope.md) | | [optional] +**returnEnvelope** | **Object** | | **perforatedPage** | **Integer** | Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf). | [optional] **customEnvelope** | [**LetterCustomEnvelope**](LetterCustomEnvelope.md) | | [optional] diff --git a/docs/LettersApi.md b/docs/LettersApi.md index c5c45519..63f4184f 100755 --- a/docs/LettersApi.md +++ b/docs/LettersApi.md @@ -245,7 +245,7 @@ public class Example { String before = "before_example"; // String | 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. String after = "after_example"; // String | 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. List include = Arrays.asList(); // List | Request that the response include the total count by specifying `include[]=total_count`. - Map dateCreated = new HashMap(); // Map | Filter by date created. + Map dateCreated = new HashMap(); // Map | Filter by date created. Map metadata = new HashMap(); // Map | Filter by metadata key-value pair`. Boolean color = true; // Boolean | Set to `true` to return only color letters. Set to `false` to return only black & white letters. Boolean scheduled = true; // Boolean | * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` @@ -273,7 +273,7 @@ Name | Type | Description | Notes **before** | **String**| 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. | [optional] **after** | **String**| 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. | [optional] **include** | [**List<String>**](String.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] - **dateCreated** | [**Map<String, String>**](String.md)| Filter by date created. | [optional] + **dateCreated** | [**Map<String, OffsetDateTime>**](OffsetDateTime.md)| Filter by date created. | [optional] **metadata** | [**Map<String, String>**](String.md)| Filter by metadata key-value pair`. | [optional] **color** | **Boolean**| Set to `true` to return only color letters. Set to `false` to return only black & white letters. | [optional] **scheduled** | **Boolean**| * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` | [optional] diff --git a/docs/PlaceholderModel.md b/docs/PlaceholderModel.md new file mode 100644 index 00000000..e21aecf1 --- /dev/null +++ b/docs/PlaceholderModel.md @@ -0,0 +1,14 @@ + + +# PlaceholderModel + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**returnEnvelope** | [**ReturnEnvelope**](ReturnEnvelope.md) | | [optional] +**addressDomestic** | [**AddressDomestic**](AddressDomestic.md) | | [optional] + + + diff --git a/docs/PostcardsApi.md b/docs/PostcardsApi.md index 804d0ec8..99aee2e8 100755 --- a/docs/PostcardsApi.md +++ b/docs/PostcardsApi.md @@ -245,7 +245,7 @@ public class Example { String before = "before_example"; // String | 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. String after = "after_example"; // String | 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. List include = Arrays.asList(); // List | Request that the response include the total count by specifying `include[]=total_count`. - Map dateCreated = new HashMap(); // Map | Filter by date created. + Map dateCreated = new HashMap(); // Map | Filter by date created. Map metadata = new HashMap(); // Map | Filter by metadata key-value pair`. List size = Arrays.asList(4x6); // List | Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. Boolean scheduled = true; // Boolean | * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` @@ -273,7 +273,7 @@ Name | Type | Description | Notes **before** | **String**| 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. | [optional] **after** | **String**| 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. | [optional] **include** | [**List<String>**](String.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] - **dateCreated** | [**Map<String, String>**](String.md)| Filter by date created. | [optional] + **dateCreated** | [**Map<String, OffsetDateTime>**](OffsetDateTime.md)| Filter by date created. | [optional] **metadata** | [**Map<String, String>**](String.md)| Filter by metadata key-value pair`. | [optional] **size** | [**List<PostcardSize>**](PostcardSize.md)| Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. | [optional] **scheduled** | **Boolean**| * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` | [optional] diff --git a/docs/SelfMailer.md b/docs/SelfMailer.md index ca2eb334..4d9ed4fe 100755 --- a/docs/SelfMailer.md +++ b/docs/SelfMailer.md @@ -8,8 +8,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | Unique identifier prefixed with `sfm_`. | -**to** | **String** | Must either be an address ID or an inline object with correct address parameters. | [optional] -**from** | **String** | Must either be an address ID or an inline object with correct address parameters. | [optional] +**to** | [**Address**](Address.md) | | +**from** | [**AddressDomesticExpanded**](AddressDomesticExpanded.md) | | [optional] **size** | **SelfMailerSize** | | [optional] **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] **metadata** | **Map<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] diff --git a/docs/SelfMailersApi.md b/docs/SelfMailersApi.md index f7de29be..4a1613d0 100755 --- a/docs/SelfMailersApi.md +++ b/docs/SelfMailersApi.md @@ -245,7 +245,7 @@ public class Example { String before = "before_example"; // String | 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. String after = "after_example"; // String | 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. List include = Arrays.asList(); // List | Request that the response include the total count by specifying `include[]=total_count`. - Map dateCreated = new HashMap(); // Map | Filter by date created. + Map dateCreated = new HashMap(); // Map | Filter by date created. Map metadata = new HashMap(); // Map | Filter by metadata key-value pair`. List size = Arrays.asList(6x18_bifold); // List | The self mailer sizes to be returned. Boolean scheduled = true; // Boolean | * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` @@ -273,7 +273,7 @@ Name | Type | Description | Notes **before** | **String**| 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. | [optional] **after** | **String**| 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. | [optional] **include** | [**List<String>**](String.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] - **dateCreated** | [**Map<String, String>**](String.md)| Filter by date created. | [optional] + **dateCreated** | [**Map<String, OffsetDateTime>**](OffsetDateTime.md)| Filter by date created. | [optional] **metadata** | [**Map<String, String>**](String.md)| Filter by metadata key-value pair`. | [optional] **size** | [**List<SelfMailerSize>**](SelfMailerSize.md)| The self mailer sizes to be returned. | [optional] **scheduled** | **Boolean**| * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` | [optional] diff --git a/docs/TemplateVersionsApi.md b/docs/TemplateVersionsApi.md index 566da87a..edecc7b9 100755 --- a/docs/TemplateVersionsApi.md +++ b/docs/TemplateVersionsApi.md @@ -322,7 +322,7 @@ public class Example { String before = "before_example"; // String | 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. String after = "after_example"; // String | 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. List include = Arrays.asList(); // List | Request that the response include the total count by specifying `include[]=total_count`. - Map dateCreated = new HashMap(); // Map | Filter by date created. + Map dateCreated = new HashMap(); // Map | Filter by date created. try { TemplateVersionList result = apiInstance.list(tmplId, limit, before, after, include, dateCreated); } catch (ApiException e) { @@ -345,7 +345,7 @@ Name | Type | Description | Notes **before** | **String**| 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. | [optional] **after** | **String**| 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. | [optional] **include** | [**List<String>**](String.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] - **dateCreated** | [**Map<String, String>**](String.md)| Filter by date created. | [optional] + **dateCreated** | [**Map<String, OffsetDateTime>**](OffsetDateTime.md)| Filter by date created. | [optional] ### Return type diff --git a/docs/TemplatesApi.md b/docs/TemplatesApi.md index 8a767d90..40d14002 100755 --- a/docs/TemplatesApi.md +++ b/docs/TemplatesApi.md @@ -313,7 +313,7 @@ public class Example { String before = "before_example"; // String | 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. String after = "after_example"; // String | 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. List include = Arrays.asList(); // List | Request that the response include the total count by specifying `include[]=total_count`. - Map dateCreated = new HashMap(); // Map | Filter by date created. + Map dateCreated = new HashMap(); // Map | Filter by date created. Map metadata = new HashMap(); // Map | Filter by metadata key-value pair`. try { TemplateList result = apiInstance.list(limit, before, after, include, dateCreated, metadata); @@ -336,7 +336,7 @@ Name | Type | Description | Notes **before** | **String**| 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. | [optional] **after** | **String**| 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. | [optional] **include** | [**List<String>**](String.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] - **dateCreated** | [**Map<String, String>**](String.md)| Filter by date created. | [optional] + **dateCreated** | [**Map<String, OffsetDateTime>**](OffsetDateTime.md)| Filter by date created. | [optional] **metadata** | [**Map<String, String>**](String.md)| Filter by metadata key-value pair`. | [optional] ### Return type diff --git a/docs/UsComponents.md b/docs/UsComponents.md index b4f5335e..231dff5d 100755 --- a/docs/UsComponents.md +++ b/docs/UsComponents.md @@ -102,6 +102,7 @@ RURAL_ROUTE | "rural_route" HIGHWAY_CONTRACT | "highway_contract" PO_BOX | "po_box" GENERAL_DELIVERY | "general_delivery" +EMPTY | "" diff --git a/src/main/java/com/lob/api/client/ChecksApi.java b/src/main/java/com/lob/api/client/ChecksApi.java index e39c75bf..a72043fa 100644 --- a/src/main/java/com/lob/api/client/ChecksApi.java +++ b/src/main/java/com/lob/api/client/ChecksApi.java @@ -450,7 +450,7 @@ public okhttp3.Call getAsync(String chkId, final ApiCallback _callback) t * @param metadata Filter by metadata key-value pair`. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -552,7 +552,7 @@ private okhttp3.Call listValidateBeforeCall(Integer limit, String before, String * @param metadata Filter by metadata key-value pair`. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @return CheckList * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -583,7 +583,7 @@ public CheckList list(Integer limit, String before, String after, List i * @param metadata Filter by metadata key-value pair`. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @return ApiResponse<CheckList> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -615,7 +615,7 @@ public ApiResponse listWithHttpInfo(Integer limit, String before, Str * @param metadata Filter by metadata key-value pair`. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call diff --git a/src/main/java/com/lob/api/client/LettersApi.java b/src/main/java/com/lob/api/client/LettersApi.java index 39f4c050..575a2032 100644 --- a/src/main/java/com/lob/api/client/LettersApi.java +++ b/src/main/java/com/lob/api/client/LettersApi.java @@ -451,7 +451,7 @@ public okhttp3.Call getAsync(String ltrId, final ApiCallback _callback) * @param color Set to `true` to return only color letters. Set to `false` to return only black & white letters. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -558,7 +558,7 @@ private okhttp3.Call listValidateBeforeCall(Integer limit, String before, String * @param color Set to `true` to return only color letters. Set to `false` to return only black & white letters. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @return LetterList * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -590,7 +590,7 @@ public LetterList list(Integer limit, String before, String after, List * @param color Set to `true` to return only color letters. Set to `false` to return only black & white letters. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @return ApiResponse<LetterList> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -623,7 +623,7 @@ public ApiResponse listWithHttpInfo(Integer limit, String before, St * @param color Set to `true` to return only color letters. Set to `false` to return only black & white letters. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call diff --git a/src/main/java/com/lob/api/client/PostcardsApi.java b/src/main/java/com/lob/api/client/PostcardsApi.java index cff792aa..33ffd2de 100644 --- a/src/main/java/com/lob/api/client/PostcardsApi.java +++ b/src/main/java/com/lob/api/client/PostcardsApi.java @@ -452,7 +452,7 @@ public okhttp3.Call getAsync(String pscId, final ApiCallback _callback * @param size Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -559,7 +559,7 @@ private okhttp3.Call listValidateBeforeCall(Integer limit, String before, String * @param size Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @return PostcardList * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -591,7 +591,7 @@ public PostcardList list(Integer limit, String before, String after, List listWithHttpInfo(Integer limit, String before, * @param size Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call diff --git a/src/main/java/com/lob/api/client/SelfMailersApi.java b/src/main/java/com/lob/api/client/SelfMailersApi.java index 719bcada..307355a3 100644 --- a/src/main/java/com/lob/api/client/SelfMailersApi.java +++ b/src/main/java/com/lob/api/client/SelfMailersApi.java @@ -452,7 +452,7 @@ public okhttp3.Call getAsync(String sfmId, final ApiCallback _callba * @param size The self mailer sizes to be returned. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -559,7 +559,7 @@ private okhttp3.Call listValidateBeforeCall(Integer limit, String before, String * @param size The self mailer sizes to be returned. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @return SelfMailerList * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -591,7 +591,7 @@ public SelfMailerList list(Integer limit, String before, String after, List listWithHttpInfo(Integer limit, String before * @param size The self mailer sizes to be returned. (optional) * @param scheduled * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) * @param sendDate Filter by date sent. (optional) - * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + * @param mailType A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional, default to usps_first_class) * @param sortBy Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call