lob 5.1.2 → 6.0.2

data/lib/openapi_client/api/postcards_api.rb

@@ -0,0 +1,340 @@
+=begin
+#Lob
+
+#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? 
+
+The version of the OpenAPI document: 1.3.0
+Contact: lob-openapi@lob.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.1
+
+=end
+
+require 'cgi'
+
+module Lob
+  class PostcardsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # create
+    # Creates a new postcard given information
+    # @param postcard_editable [PostcardEditable] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). 
+    # @return [Postcard]
+    def create(postcard_editable, opts = {})
+      data, _status_code, _headers = postcard_create_with_http_info(postcard_editable, opts)
+      data
+    end
+
+    # create
+    # Creates a new postcard given information
+    # @param postcard_editable [PostcardEditable] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). 
+    # @return [Array<(Postcard, Integer, Hash)>] Postcard data, response status code and response headers
+    def postcard_create_with_http_info(postcard_editable, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostcardsApi.postcard_create ...'
+      end
+      # verify the required parameter 'postcard_editable' is set
+      if @api_client.config.client_side_validation && postcard_editable.nil?
+        fail ArgumentError, "Missing the required parameter 'postcard_editable' when calling PostcardsApi.postcard_create"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 256
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling PostcardsApi.postcard_create, the character length must be smaller than or equal to 256.'
+      end
+
+      # resource path
+      local_var_path = '/postcards'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(postcard_editable)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Postcard'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"PostcardsApi.postcard_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PostcardsApi#postcard_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # cancel
+    # Completely removes a postcard from production. This can only be done if the postcard has a `send_date` and the `send_date` has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access.
+    # @param psc_id [String] id of the postcard
+    # @param [Hash] opts the optional parameters
+    # @return [PostcardDeletion]
+    def cancel(psc_id, opts = {})
+      data, _status_code, _headers = postcard_delete_with_http_info(psc_id, opts)
+      data
+    end
+
+    # cancel
+    # Completely removes a postcard from production. This can only be done if the postcard has a &#x60;send_date&#x60; and the &#x60;send_date&#x60; has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print &amp; Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access.
+    # @param psc_id [String] id of the postcard
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PostcardDeletion, Integer, Hash)>] PostcardDeletion data, response status code and response headers
+    def postcard_delete_with_http_info(psc_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostcardsApi.postcard_delete ...'
+      end
+      # verify the required parameter 'psc_id' is set
+      if @api_client.config.client_side_validation && psc_id.nil?
+        fail ArgumentError, "Missing the required parameter 'psc_id' when calling PostcardsApi.postcard_delete"
+      end
+      pattern = Regexp.new(/^psc_[a-zA-Z0-9]+$/)
+      if @api_client.config.client_side_validation && psc_id !~ pattern
+        fail ArgumentError, "invalid value for 'psc_id' when calling PostcardsApi.postcard_delete, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/postcards/{psc_id}'.sub('{' + 'psc_id' + '}', CGI.escape(psc_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PostcardDeletion'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"PostcardsApi.postcard_delete",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PostcardsApi#postcard_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # get
+    # Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation.
+    # @param psc_id [String] id of the postcard
+    # @param [Hash] opts the optional parameters
+    # @return [Postcard]
+    def get(psc_id, opts = {})
+      data, _status_code, _headers = postcard_retrieve_with_http_info(psc_id, opts)
+      data
+    end
+
+    # get
+    # Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation.
+    # @param psc_id [String] id of the postcard
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Postcard, Integer, Hash)>] Postcard data, response status code and response headers
+    def postcard_retrieve_with_http_info(psc_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostcardsApi.postcard_retrieve ...'
+      end
+      # verify the required parameter 'psc_id' is set
+      if @api_client.config.client_side_validation && psc_id.nil?
+        fail ArgumentError, "Missing the required parameter 'psc_id' when calling PostcardsApi.postcard_retrieve"
+      end
+      pattern = Regexp.new(/^psc_[a-zA-Z0-9]+$/)
+      if @api_client.config.client_side_validation && psc_id !~ pattern
+        fail ArgumentError, "invalid value for 'psc_id' when calling PostcardsApi.postcard_retrieve, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/postcards/{psc_id}'.sub('{' + 'psc_id' + '}', CGI.escape(psc_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Postcard'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"PostcardsApi.postcard_retrieve",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PostcardsApi#postcard_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # list
+    # Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit How many results to return. (default to 10)
+    # @option opts [String] :before A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response. 
+    # @option opts [String] :after A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response. 
+    # @option opts [Array<String>] :include Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;. 
+    # @option opts [Hash<String, Time>] :date_created Filter by date created.
+    # @option opts [Hash<String, String>] :metadata Filter by metadata key-value pair&#x60;.
+    # @option opts [Array<PostcardSize>] :size Specifies the size of the postcard. Only &#x60;4x6&#x60; postcards can be sent to international destinations.
+    # @option opts [Boolean] :scheduled * &#x60;true&#x60; - only return orders (past or future) where &#x60;send_date&#x60; is greater than &#x60;date_created&#x60; * &#x60;false&#x60; - only return orders where &#x60;send_date&#x60; is equal to &#x60;date_created&#x60; 
+    # @option opts [Hash<String, String>] :send_date Filter by date sent.
+    # @option opts [MailType] :mail_type A string designating the mail postage type: * &#x60;usps_first_class&#x60; - (default) * &#x60;usps_standard&#x60; - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. &#x60;usps_standard&#x60; cannot be used with &#x60;4x6&#x60; postcards or for any postcards sent outside of the United States.  (default to 'usps_first_class')
+    # @option opts [SortBy3] :sort_by Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both. 
+    # @return [PostcardList]
+    def list(opts = {})
+      data, _status_code, _headers = postcards_list_with_http_info(opts)
+      data
+    end
+
+    # list
+    # Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit How many results to return. (default to 10)
+    # @option opts [String] :before A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response. 
+    # @option opts [String] :after A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response. 
+    # @option opts [Array<String>] :include Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;. 
+    # @option opts [Hash<String, Time>] :date_created Filter by date created.
+    # @option opts [Hash<String, String>] :metadata Filter by metadata key-value pair&#x60;.
+    # @option opts [Array<PostcardSize>] :size Specifies the size of the postcard. Only &#x60;4x6&#x60; postcards can be sent to international destinations.
+    # @option opts [Boolean] :scheduled * &#x60;true&#x60; - only return orders (past or future) where &#x60;send_date&#x60; is greater than &#x60;date_created&#x60; * &#x60;false&#x60; - only return orders where &#x60;send_date&#x60; is equal to &#x60;date_created&#x60; 
+    # @option opts [Hash<String, String>] :send_date Filter by date sent.
+    # @option opts [MailType] :mail_type A string designating the mail postage type: * &#x60;usps_first_class&#x60; - (default) * &#x60;usps_standard&#x60; - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. &#x60;usps_standard&#x60; cannot be used with &#x60;4x6&#x60; postcards or for any postcards sent outside of the United States.  (default to 'usps_first_class')
+    # @option opts [SortBy3] :sort_by Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both. 
+    # @return [Array<(PostcardList, Integer, Hash)>] PostcardList data, response status code and response headers
+    def postcards_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PostcardsApi.postcards_list ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PostcardsApi.postcards_list, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PostcardsApi.postcards_list, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'metadata'].nil? && opts[:'metadata'].to_s.length > 500
+        fail ArgumentError, 'invalid value for "opts[:"metadata"]" when calling PostcardsApi.postcards_list, the character length must be smaller than or equal to 500.'
+      end
+
+      pattern = Regexp.new(/[^"\\]{0,500}/)
+      if @api_client.config.client_side_validation && !opts[:'metadata'].nil? && opts[:'metadata'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"metadata\"]' when calling PostcardsApi.postcards_list, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/postcards'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
+      query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+      query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if !opts[:'include'].nil?
+      query_params[:'date_created'] = opts[:'date_created'] if !opts[:'date_created'].nil?
+      query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?
+      query_params[:'size'] = @api_client.build_collection_param(opts[:'size'], :multi) if !opts[:'size'].nil?
+      query_params[:'scheduled'] = opts[:'scheduled'] if !opts[:'scheduled'].nil?
+      query_params[:'send_date'] = opts[:'send_date'] if !opts[:'send_date'].nil?
+      query_params[:'mail_type'] = opts[:'mail_type'] if !opts[:'mail_type'].nil?
+      query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PostcardList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"PostcardsApi.postcards_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PostcardsApi#postcards_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/openapi_client/api/reverse_geocode_lookups_api.rb

@@ -0,0 +1,101 @@
+=begin
+#Lob
+
+#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? 
+
+The version of the OpenAPI document: 1.3.0
+Contact: lob-openapi@lob.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.1
+
+=end
+
+require 'cgi'
+
+module Lob
+  class ReverseGeocodeLookupsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # lookup
+    # Reverse geocode a valid US location with a live API key.
+    # @param location [Location] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :size Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations. (default to 5)
+    # @return [ReverseGeocode]
+    def lookup(location, opts = {})
+      data, _status_code, _headers = reverse_geocode_lookup_with_http_info(location, opts)
+      data
+    end
+
+    # lookup
+    # Reverse geocode a valid US location with a live API key.
+    # @param location [Location] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :size Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations. (default to 5)
+    # @return [Array<(ReverseGeocode, Integer, Hash)>] ReverseGeocode data, response status code and response headers
+    def reverse_geocode_lookup_with_http_info(location, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ReverseGeocodeLookupsApi.reverse_geocode_lookup ...'
+      end
+      # verify the required parameter 'location' is set
+      if @api_client.config.client_side_validation && location.nil?
+        fail ArgumentError, "Missing the required parameter 'location' when calling ReverseGeocodeLookupsApi.reverse_geocode_lookup"
+      end
+      if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 50
+        fail ArgumentError, 'invalid value for "opts[:"size"]" when calling ReverseGeocodeLookupsApi.reverse_geocode_lookup, must be smaller than or equal to 50.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"size"]" when calling ReverseGeocodeLookupsApi.reverse_geocode_lookup, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/us_reverse_geocode_lookups'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(location)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ReverseGeocode'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"ReverseGeocodeLookupsApi.reverse_geocode_lookup",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ReverseGeocodeLookupsApi#reverse_geocode_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end